diff --git a/nsx/nsx/.buildinfo b/nsx/nsx/.buildinfo new file mode 100644 index 00000000..18c78b0c --- /dev/null +++ b/nsx/nsx/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: 51e299b6c19d6938390524b8d123f626 +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/nsx/nsx/.doctrees/com.doctree b/nsx/nsx/.doctrees/com.doctree new file mode 100644 index 00000000..11d7137c Binary files /dev/null and b/nsx/nsx/.doctrees/com.doctree differ diff --git a/nsx/nsx/.doctrees/com.vmware.doctree b/nsx/nsx/.doctrees/com.vmware.doctree new file mode 100644 index 00000000..48c64289 Binary files /dev/null and b/nsx/nsx/.doctrees/com.vmware.doctree differ diff --git a/nsx/nsx/.doctrees/com.vmware.nsx.aaa.doctree b/nsx/nsx/.doctrees/com.vmware.nsx.aaa.doctree new file mode 100644 index 00000000..c26e238c Binary files /dev/null and b/nsx/nsx/.doctrees/com.vmware.nsx.aaa.doctree differ diff --git a/nsx/nsx/.doctrees/com.vmware.nsx.app_discovery.doctree b/nsx/nsx/.doctrees/com.vmware.nsx.app_discovery.doctree new file mode 100644 index 00000000..f0eeb6e5 Binary files /dev/null and b/nsx/nsx/.doctrees/com.vmware.nsx.app_discovery.doctree differ diff --git a/nsx/nsx/.doctrees/com.vmware.nsx.app_discovery.sessions.doctree b/nsx/nsx/.doctrees/com.vmware.nsx.app_discovery.sessions.doctree new file mode 100644 index 00000000..7cdd2e3b Binary files /dev/null and b/nsx/nsx/.doctrees/com.vmware.nsx.app_discovery.sessions.doctree differ diff --git a/nsx/nsx/.doctrees/com.vmware.nsx.cluster.doctree b/nsx/nsx/.doctrees/com.vmware.nsx.cluster.doctree new file mode 100644 index 00000000..2b3ef13d Binary files /dev/null and b/nsx/nsx/.doctrees/com.vmware.nsx.cluster.doctree differ diff --git a/nsx/nsx/.doctrees/com.vmware.nsx.cluster.nodes.doctree b/nsx/nsx/.doctrees/com.vmware.nsx.cluster.nodes.doctree new file mode 100644 index 00000000..2b2d7365 Binary files /dev/null and b/nsx/nsx/.doctrees/com.vmware.nsx.cluster.nodes.doctree differ diff --git a/nsx/nsx/.doctrees/com.vmware.nsx.cluster.nodes.network.doctree b/nsx/nsx/.doctrees/com.vmware.nsx.cluster.nodes.network.doctree new file mode 100644 index 00000000..ca32f169 Binary files /dev/null and b/nsx/nsx/.doctrees/com.vmware.nsx.cluster.nodes.network.doctree differ diff --git a/nsx/nsx/.doctrees/com.vmware.nsx.dhcp.doctree b/nsx/nsx/.doctrees/com.vmware.nsx.dhcp.doctree new file mode 100644 index 00000000..8a63050e Binary files /dev/null and b/nsx/nsx/.doctrees/com.vmware.nsx.dhcp.doctree differ diff --git a/nsx/nsx/.doctrees/com.vmware.nsx.dns.doctree b/nsx/nsx/.doctrees/com.vmware.nsx.dns.doctree new file mode 100644 index 00000000..2dbafe11 Binary files /dev/null and b/nsx/nsx/.doctrees/com.vmware.nsx.dns.doctree differ diff --git a/nsx/nsx/.doctrees/com.vmware.nsx.doctree b/nsx/nsx/.doctrees/com.vmware.nsx.doctree new file mode 100644 index 00000000..0d739a88 Binary files /dev/null and b/nsx/nsx/.doctrees/com.vmware.nsx.doctree differ diff --git a/nsx/nsx/.doctrees/com.vmware.nsx.fabric.compute_collections.doctree b/nsx/nsx/.doctrees/com.vmware.nsx.fabric.compute_collections.doctree new file mode 100644 index 00000000..cda49497 Binary files /dev/null and b/nsx/nsx/.doctrees/com.vmware.nsx.fabric.compute_collections.doctree differ diff --git a/nsx/nsx/.doctrees/com.vmware.nsx.fabric.doctree b/nsx/nsx/.doctrees/com.vmware.nsx.fabric.doctree new file mode 100644 index 00000000..d515d7f0 Binary files /dev/null and b/nsx/nsx/.doctrees/com.vmware.nsx.fabric.doctree differ diff --git a/nsx/nsx/.doctrees/com.vmware.nsx.fabric.nodes.doctree b/nsx/nsx/.doctrees/com.vmware.nsx.fabric.nodes.doctree new file mode 100644 index 00000000..9b315b00 Binary files /dev/null and b/nsx/nsx/.doctrees/com.vmware.nsx.fabric.nodes.doctree differ diff --git a/nsx/nsx/.doctrees/com.vmware.nsx.fabric.nodes.network.doctree b/nsx/nsx/.doctrees/com.vmware.nsx.fabric.nodes.network.doctree new file mode 100644 index 00000000..d3d6b1d5 Binary files /dev/null and b/nsx/nsx/.doctrees/com.vmware.nsx.fabric.nodes.network.doctree differ diff --git a/nsx/nsx/.doctrees/com.vmware.nsx.firewall.doctree b/nsx/nsx/.doctrees/com.vmware.nsx.firewall.doctree new file mode 100644 index 00000000..c7531522 Binary files /dev/null and b/nsx/nsx/.doctrees/com.vmware.nsx.firewall.doctree differ diff --git a/nsx/nsx/.doctrees/com.vmware.nsx.firewall.sections.doctree b/nsx/nsx/.doctrees/com.vmware.nsx.firewall.sections.doctree new file mode 100644 index 00000000..c57ac91c Binary files /dev/null and b/nsx/nsx/.doctrees/com.vmware.nsx.firewall.sections.doctree differ diff --git a/nsx/nsx/.doctrees/com.vmware.nsx.lldp.doctree b/nsx/nsx/.doctrees/com.vmware.nsx.lldp.doctree new file mode 100644 index 00000000..78ff03fe Binary files /dev/null and b/nsx/nsx/.doctrees/com.vmware.nsx.lldp.doctree differ diff --git a/nsx/nsx/.doctrees/com.vmware.nsx.loadbalancer.doctree b/nsx/nsx/.doctrees/com.vmware.nsx.loadbalancer.doctree new file mode 100644 index 00000000..c11f3daf Binary files /dev/null and b/nsx/nsx/.doctrees/com.vmware.nsx.loadbalancer.doctree differ diff --git a/nsx/nsx/.doctrees/com.vmware.nsx.loadbalancer.services.doctree b/nsx/nsx/.doctrees/com.vmware.nsx.loadbalancer.services.doctree new file mode 100644 index 00000000..59733df7 Binary files /dev/null and b/nsx/nsx/.doctrees/com.vmware.nsx.loadbalancer.services.doctree differ diff --git a/nsx/nsx/.doctrees/com.vmware.nsx.logical_router_ports.doctree b/nsx/nsx/.doctrees/com.vmware.nsx.logical_router_ports.doctree new file mode 100644 index 00000000..db4003c8 Binary files /dev/null and b/nsx/nsx/.doctrees/com.vmware.nsx.logical_router_ports.doctree differ diff --git a/nsx/nsx/.doctrees/com.vmware.nsx.logical_routers.doctree b/nsx/nsx/.doctrees/com.vmware.nsx.logical_routers.doctree new file mode 100644 index 00000000..26318744 Binary files /dev/null and b/nsx/nsx/.doctrees/com.vmware.nsx.logical_routers.doctree differ diff --git a/nsx/nsx/.doctrees/com.vmware.nsx.logical_routers.nat.doctree b/nsx/nsx/.doctrees/com.vmware.nsx.logical_routers.nat.doctree new file mode 100644 index 00000000..bc008254 Binary files /dev/null and b/nsx/nsx/.doctrees/com.vmware.nsx.logical_routers.nat.doctree differ diff --git a/nsx/nsx/.doctrees/com.vmware.nsx.logical_routers.routing.bgp.doctree b/nsx/nsx/.doctrees/com.vmware.nsx.logical_routers.routing.bgp.doctree new file mode 100644 index 00000000..3eeeb6c5 Binary files /dev/null and b/nsx/nsx/.doctrees/com.vmware.nsx.logical_routers.routing.bgp.doctree differ diff --git a/nsx/nsx/.doctrees/com.vmware.nsx.logical_routers.routing.doctree b/nsx/nsx/.doctrees/com.vmware.nsx.logical_routers.routing.doctree new file mode 100644 index 00000000..2d60bbf4 Binary files /dev/null and b/nsx/nsx/.doctrees/com.vmware.nsx.logical_routers.routing.doctree differ diff --git a/nsx/nsx/.doctrees/com.vmware.nsx.migration.doctree b/nsx/nsx/.doctrees/com.vmware.nsx.migration.doctree new file mode 100644 index 00000000..d4742edc Binary files /dev/null and b/nsx/nsx/.doctrees/com.vmware.nsx.migration.doctree differ diff --git a/nsx/nsx/.doctrees/com.vmware.nsx.node.aaa.doctree b/nsx/nsx/.doctrees/com.vmware.nsx.node.aaa.doctree new file mode 100644 index 00000000..9d18335b Binary files /dev/null and b/nsx/nsx/.doctrees/com.vmware.nsx.node.aaa.doctree differ diff --git a/nsx/nsx/.doctrees/com.vmware.nsx.node.aaa.providers.doctree b/nsx/nsx/.doctrees/com.vmware.nsx.node.aaa.providers.doctree new file mode 100644 index 00000000..94e5c5a8 Binary files /dev/null and b/nsx/nsx/.doctrees/com.vmware.nsx.node.aaa.providers.doctree differ diff --git a/nsx/nsx/.doctrees/com.vmware.nsx.node.doctree b/nsx/nsx/.doctrees/com.vmware.nsx.node.doctree new file mode 100644 index 00000000..e12a461a Binary files /dev/null and b/nsx/nsx/.doctrees/com.vmware.nsx.node.doctree differ diff --git a/nsx/nsx/.doctrees/com.vmware.nsx.node.network.doctree b/nsx/nsx/.doctrees/com.vmware.nsx.node.network.doctree new file mode 100644 index 00000000..12f1e77f Binary files /dev/null and b/nsx/nsx/.doctrees/com.vmware.nsx.node.network.doctree differ diff --git a/nsx/nsx/.doctrees/com.vmware.nsx.node.services.doctree b/nsx/nsx/.doctrees/com.vmware.nsx.node.services.doctree new file mode 100644 index 00000000..25cb9afd Binary files /dev/null and b/nsx/nsx/.doctrees/com.vmware.nsx.node.services.doctree differ diff --git a/nsx/nsx/.doctrees/com.vmware.nsx.pools.doctree b/nsx/nsx/.doctrees/com.vmware.nsx.pools.doctree new file mode 100644 index 00000000..ccc2df4f Binary files /dev/null and b/nsx/nsx/.doctrees/com.vmware.nsx.pools.doctree differ diff --git a/nsx/nsx/.doctrees/com.vmware.nsx.serviceinsertion.doctree b/nsx/nsx/.doctrees/com.vmware.nsx.serviceinsertion.doctree new file mode 100644 index 00000000..fa9f94b0 Binary files /dev/null and b/nsx/nsx/.doctrees/com.vmware.nsx.serviceinsertion.doctree differ diff --git a/nsx/nsx/.doctrees/com.vmware.nsx.serviceinsertion.services.doctree b/nsx/nsx/.doctrees/com.vmware.nsx.serviceinsertion.services.doctree new file mode 100644 index 00000000..27dbc073 Binary files /dev/null and b/nsx/nsx/.doctrees/com.vmware.nsx.serviceinsertion.services.doctree differ diff --git a/nsx/nsx/.doctrees/com.vmware.nsx.serviceinsertion.services.service_instances.doctree b/nsx/nsx/.doctrees/com.vmware.nsx.serviceinsertion.services.service_instances.doctree new file mode 100644 index 00000000..a6f9c867 Binary files /dev/null and b/nsx/nsx/.doctrees/com.vmware.nsx.serviceinsertion.services.service_instances.doctree differ diff --git a/nsx/nsx/.doctrees/com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.doctree b/nsx/nsx/.doctrees/com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.doctree new file mode 100644 index 00000000..a0ecad18 Binary files /dev/null and b/nsx/nsx/.doctrees/com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.doctree differ diff --git a/nsx/nsx/.doctrees/com.vmware.nsx.transport_nodes.doctree b/nsx/nsx/.doctrees/com.vmware.nsx.transport_nodes.doctree new file mode 100644 index 00000000..07cb82ee Binary files /dev/null and b/nsx/nsx/.doctrees/com.vmware.nsx.transport_nodes.doctree differ diff --git a/nsx/nsx/.doctrees/com.vmware.nsx.upgrade.doctree b/nsx/nsx/.doctrees/com.vmware.nsx.upgrade.doctree new file mode 100644 index 00000000..bf451b88 Binary files /dev/null and b/nsx/nsx/.doctrees/com.vmware.nsx.upgrade.doctree differ diff --git a/nsx/nsx/.doctrees/com.vmware.nsx.vpn.doctree b/nsx/nsx/.doctrees/com.vmware.nsx.vpn.doctree new file mode 100644 index 00000000..d88fa700 Binary files /dev/null and b/nsx/nsx/.doctrees/com.vmware.nsx.vpn.doctree differ diff --git a/nsx/nsx/.doctrees/com.vmware.nsx.vpn.ipsec.doctree b/nsx/nsx/.doctrees/com.vmware.nsx.vpn.ipsec.doctree new file mode 100644 index 00000000..4caa8a40 Binary files /dev/null and b/nsx/nsx/.doctrees/com.vmware.nsx.vpn.ipsec.doctree differ diff --git a/nsx/nsx/.doctrees/com.vmware.nsx.vpn.l2vpn.doctree b/nsx/nsx/.doctrees/com.vmware.nsx.vpn.l2vpn.doctree new file mode 100644 index 00000000..bb19ab6e Binary files /dev/null and b/nsx/nsx/.doctrees/com.vmware.nsx.vpn.l2vpn.doctree differ diff --git a/nsx/nsx/.doctrees/enumeration.doctree b/nsx/nsx/.doctrees/enumeration.doctree new file mode 100644 index 00000000..7086901a Binary files /dev/null and b/nsx/nsx/.doctrees/enumeration.doctree differ diff --git a/nsx/nsx/.doctrees/environment.pickle b/nsx/nsx/.doctrees/environment.pickle new file mode 100644 index 00000000..228fab06 Binary files /dev/null and b/nsx/nsx/.doctrees/environment.pickle differ diff --git a/nsx/nsx/.doctrees/index.doctree b/nsx/nsx/.doctrees/index.doctree new file mode 100644 index 00000000..bbb75adc Binary files /dev/null and b/nsx/nsx/.doctrees/index.doctree differ diff --git a/nsx/nsx/_sources/com.rst.txt b/nsx/nsx/_sources/com.rst.txt new file mode 100644 index 00000000..257ee95b --- /dev/null +++ b/nsx/nsx/_sources/com.rst.txt @@ -0,0 +1,15 @@ +com package +=========== + +.. automodule:: com + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + com.vmware + diff --git a/nsx/nsx/_sources/com.vmware.nsx.aaa.rst.txt b/nsx/nsx/_sources/com.vmware.nsx.aaa.rst.txt new file mode 100644 index 00000000..072b2465 --- /dev/null +++ b/nsx/nsx/_sources/com.vmware.nsx.aaa.rst.txt @@ -0,0 +1,20 @@ +com.vmware.nsx.aaa package +========================== + +.. automodule:: com.vmware.nsx.aaa + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.nsx.aaa.vidm\_client module +-------------------------------------- + +.. automodule:: com.vmware.nsx.aaa.vidm_client + :members: + :undoc-members: + :show-inheritance: + + diff --git a/nsx/nsx/_sources/com.vmware.nsx.app_discovery.rst.txt b/nsx/nsx/_sources/com.vmware.nsx.app_discovery.rst.txt new file mode 100644 index 00000000..a7d2c101 --- /dev/null +++ b/nsx/nsx/_sources/com.vmware.nsx.app_discovery.rst.txt @@ -0,0 +1,27 @@ +com.vmware.nsx.app\_discovery package +===================================== + +.. automodule:: com.vmware.nsx.app_discovery + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + com.vmware.nsx.app_discovery.sessions + +Submodules +---------- + +com.vmware.nsx.app\_discovery.sessions\_client module +----------------------------------------------------- + +.. automodule:: com.vmware.nsx.app_discovery.sessions_client + :members: + :undoc-members: + :show-inheritance: + + diff --git a/nsx/nsx/_sources/com.vmware.nsx.app_discovery.sessions.rst.txt b/nsx/nsx/_sources/com.vmware.nsx.app_discovery.sessions.rst.txt new file mode 100644 index 00000000..f6915a71 --- /dev/null +++ b/nsx/nsx/_sources/com.vmware.nsx.app_discovery.sessions.rst.txt @@ -0,0 +1,20 @@ +com.vmware.nsx.app\_discovery.sessions package +============================================== + +.. automodule:: com.vmware.nsx.app_discovery.sessions + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.nsx.app\_discovery.sessions.ns\_groups\_client module +---------------------------------------------------------------- + +.. automodule:: com.vmware.nsx.app_discovery.sessions.ns_groups_client + :members: + :undoc-members: + :show-inheritance: + + diff --git a/nsx/nsx/_sources/com.vmware.nsx.cluster.nodes.network.rst.txt b/nsx/nsx/_sources/com.vmware.nsx.cluster.nodes.network.rst.txt new file mode 100644 index 00000000..bdcfb8ba --- /dev/null +++ b/nsx/nsx/_sources/com.vmware.nsx.cluster.nodes.network.rst.txt @@ -0,0 +1,20 @@ +com.vmware.nsx.cluster.nodes.network package +============================================ + +.. automodule:: com.vmware.nsx.cluster.nodes.network + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.nsx.cluster.nodes.network.interfaces\_client module +-------------------------------------------------------------- + +.. automodule:: com.vmware.nsx.cluster.nodes.network.interfaces_client + :members: + :undoc-members: + :show-inheritance: + + diff --git a/nsx/nsx/_sources/com.vmware.nsx.cluster.nodes.rst.txt b/nsx/nsx/_sources/com.vmware.nsx.cluster.nodes.rst.txt new file mode 100644 index 00000000..f0fdfb4a --- /dev/null +++ b/nsx/nsx/_sources/com.vmware.nsx.cluster.nodes.rst.txt @@ -0,0 +1,43 @@ +com.vmware.nsx.cluster.nodes package +==================================== + +.. automodule:: com.vmware.nsx.cluster.nodes + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + com.vmware.nsx.cluster.nodes.network + +Submodules +---------- + +com.vmware.nsx.cluster.nodes.deployments\_client module +------------------------------------------------------- + +.. automodule:: com.vmware.nsx.cluster.nodes.deployments_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.cluster.nodes.network\_client module +--------------------------------------------------- + +.. automodule:: com.vmware.nsx.cluster.nodes.network_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.cluster.nodes.repo\_sync\_client module +------------------------------------------------------ + +.. automodule:: com.vmware.nsx.cluster.nodes.repo_sync_client + :members: + :undoc-members: + :show-inheritance: + + diff --git a/nsx/nsx/_sources/com.vmware.nsx.cluster.rst.txt b/nsx/nsx/_sources/com.vmware.nsx.cluster.rst.txt new file mode 100644 index 00000000..590c0ed1 --- /dev/null +++ b/nsx/nsx/_sources/com.vmware.nsx.cluster.rst.txt @@ -0,0 +1,43 @@ +com.vmware.nsx.cluster package +============================== + +.. automodule:: com.vmware.nsx.cluster + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + com.vmware.nsx.cluster.nodes + +Submodules +---------- + +com.vmware.nsx.cluster.backups\_client module +--------------------------------------------- + +.. automodule:: com.vmware.nsx.cluster.backups_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.cluster.nodes\_client module +------------------------------------------- + +.. automodule:: com.vmware.nsx.cluster.nodes_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.cluster.restore\_client module +--------------------------------------------- + +.. automodule:: com.vmware.nsx.cluster.restore_client + :members: + :undoc-members: + :show-inheritance: + + diff --git a/nsx/nsx/_sources/com.vmware.nsx.dhcp.rst.txt b/nsx/nsx/_sources/com.vmware.nsx.dhcp.rst.txt new file mode 100644 index 00000000..1d839a4f --- /dev/null +++ b/nsx/nsx/_sources/com.vmware.nsx.dhcp.rst.txt @@ -0,0 +1,20 @@ +com.vmware.nsx.dhcp package +=========================== + +.. automodule:: com.vmware.nsx.dhcp + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.nsx.dhcp.servers\_client module +------------------------------------------ + +.. automodule:: com.vmware.nsx.dhcp.servers_client + :members: + :undoc-members: + :show-inheritance: + + diff --git a/nsx/nsx/_sources/com.vmware.nsx.dns.rst.txt b/nsx/nsx/_sources/com.vmware.nsx.dns.rst.txt new file mode 100644 index 00000000..b22c23ff --- /dev/null +++ b/nsx/nsx/_sources/com.vmware.nsx.dns.rst.txt @@ -0,0 +1,20 @@ +com.vmware.nsx.dns package +========================== + +.. automodule:: com.vmware.nsx.dns + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.nsx.dns.forwarders\_client module +-------------------------------------------- + +.. automodule:: com.vmware.nsx.dns.forwarders_client + :members: + :undoc-members: + :show-inheritance: + + diff --git a/nsx/nsx/_sources/com.vmware.nsx.fabric.compute_collections.rst.txt b/nsx/nsx/_sources/com.vmware.nsx.fabric.compute_collections.rst.txt new file mode 100644 index 00000000..250cf232 --- /dev/null +++ b/nsx/nsx/_sources/com.vmware.nsx.fabric.compute_collections.rst.txt @@ -0,0 +1,20 @@ +com.vmware.nsx.fabric.compute\_collections package +================================================== + +.. automodule:: com.vmware.nsx.fabric.compute_collections + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.nsx.fabric.compute\_collections.network\_client module +----------------------------------------------------------------- + +.. automodule:: com.vmware.nsx.fabric.compute_collections.network_client + :members: + :undoc-members: + :show-inheritance: + + diff --git a/nsx/nsx/_sources/com.vmware.nsx.fabric.nodes.network.rst.txt b/nsx/nsx/_sources/com.vmware.nsx.fabric.nodes.network.rst.txt new file mode 100644 index 00000000..2655e9a0 --- /dev/null +++ b/nsx/nsx/_sources/com.vmware.nsx.fabric.nodes.network.rst.txt @@ -0,0 +1,20 @@ +com.vmware.nsx.fabric.nodes.network package +=========================================== + +.. automodule:: com.vmware.nsx.fabric.nodes.network + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.nsx.fabric.nodes.network.interfaces\_client module +------------------------------------------------------------- + +.. automodule:: com.vmware.nsx.fabric.nodes.network.interfaces_client + :members: + :undoc-members: + :show-inheritance: + + diff --git a/nsx/nsx/_sources/com.vmware.nsx.fabric.nodes.rst.txt b/nsx/nsx/_sources/com.vmware.nsx.fabric.nodes.rst.txt new file mode 100644 index 00000000..e7a01383 --- /dev/null +++ b/nsx/nsx/_sources/com.vmware.nsx.fabric.nodes.rst.txt @@ -0,0 +1,27 @@ +com.vmware.nsx.fabric.nodes package +=================================== + +.. automodule:: com.vmware.nsx.fabric.nodes + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + com.vmware.nsx.fabric.nodes.network + +Submodules +---------- + +com.vmware.nsx.fabric.nodes.network\_client module +-------------------------------------------------- + +.. automodule:: com.vmware.nsx.fabric.nodes.network_client + :members: + :undoc-members: + :show-inheritance: + + diff --git a/nsx/nsx/_sources/com.vmware.nsx.fabric.rst.txt b/nsx/nsx/_sources/com.vmware.nsx.fabric.rst.txt new file mode 100644 index 00000000..c6cde086 --- /dev/null +++ b/nsx/nsx/_sources/com.vmware.nsx.fabric.rst.txt @@ -0,0 +1,36 @@ +com.vmware.nsx.fabric package +============================= + +.. automodule:: com.vmware.nsx.fabric + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + com.vmware.nsx.fabric.compute_collections + com.vmware.nsx.fabric.nodes + +Submodules +---------- + +com.vmware.nsx.fabric.compute\_managers\_client module +------------------------------------------------------ + +.. automodule:: com.vmware.nsx.fabric.compute_managers_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.fabric.nodes\_client module +------------------------------------------ + +.. automodule:: com.vmware.nsx.fabric.nodes_client + :members: + :undoc-members: + :show-inheritance: + + diff --git a/nsx/nsx/_sources/com.vmware.nsx.firewall.rst.txt b/nsx/nsx/_sources/com.vmware.nsx.firewall.rst.txt new file mode 100644 index 00000000..9e91b6dd --- /dev/null +++ b/nsx/nsx/_sources/com.vmware.nsx.firewall.rst.txt @@ -0,0 +1,35 @@ +com.vmware.nsx.firewall package +=============================== + +.. automodule:: com.vmware.nsx.firewall + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + com.vmware.nsx.firewall.sections + +Submodules +---------- + +com.vmware.nsx.firewall.rules\_client module +-------------------------------------------- + +.. automodule:: com.vmware.nsx.firewall.rules_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.firewall.sections\_client module +----------------------------------------------- + +.. automodule:: com.vmware.nsx.firewall.sections_client + :members: + :undoc-members: + :show-inheritance: + + diff --git a/nsx/nsx/_sources/com.vmware.nsx.firewall.sections.rst.txt b/nsx/nsx/_sources/com.vmware.nsx.firewall.sections.rst.txt new file mode 100644 index 00000000..9527119b --- /dev/null +++ b/nsx/nsx/_sources/com.vmware.nsx.firewall.sections.rst.txt @@ -0,0 +1,20 @@ +com.vmware.nsx.firewall.sections package +======================================== + +.. automodule:: com.vmware.nsx.firewall.sections + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.nsx.firewall.sections.rules\_client module +----------------------------------------------------- + +.. automodule:: com.vmware.nsx.firewall.sections.rules_client + :members: + :undoc-members: + :show-inheritance: + + diff --git a/nsx/nsx/_sources/com.vmware.nsx.lldp.rst.txt b/nsx/nsx/_sources/com.vmware.nsx.lldp.rst.txt new file mode 100644 index 00000000..a83c46af --- /dev/null +++ b/nsx/nsx/_sources/com.vmware.nsx.lldp.rst.txt @@ -0,0 +1,20 @@ +com.vmware.nsx.lldp package +=========================== + +.. automodule:: com.vmware.nsx.lldp + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.nsx.lldp.transport\_nodes\_client module +--------------------------------------------------- + +.. automodule:: com.vmware.nsx.lldp.transport_nodes_client + :members: + :undoc-members: + :show-inheritance: + + diff --git a/nsx/nsx/_sources/com.vmware.nsx.loadbalancer.rst.txt b/nsx/nsx/_sources/com.vmware.nsx.loadbalancer.rst.txt new file mode 100644 index 00000000..36ab3cf4 --- /dev/null +++ b/nsx/nsx/_sources/com.vmware.nsx.loadbalancer.rst.txt @@ -0,0 +1,35 @@ +com.vmware.nsx.loadbalancer package +=================================== + +.. automodule:: com.vmware.nsx.loadbalancer + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + com.vmware.nsx.loadbalancer.services + +Submodules +---------- + +com.vmware.nsx.loadbalancer.services\_client module +--------------------------------------------------- + +.. automodule:: com.vmware.nsx.loadbalancer.services_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.loadbalancer.ssl\_client module +---------------------------------------------- + +.. automodule:: com.vmware.nsx.loadbalancer.ssl_client + :members: + :undoc-members: + :show-inheritance: + + diff --git a/nsx/nsx/_sources/com.vmware.nsx.loadbalancer.services.rst.txt b/nsx/nsx/_sources/com.vmware.nsx.loadbalancer.services.rst.txt new file mode 100644 index 00000000..3af524c2 --- /dev/null +++ b/nsx/nsx/_sources/com.vmware.nsx.loadbalancer.services.rst.txt @@ -0,0 +1,28 @@ +com.vmware.nsx.loadbalancer.services package +============================================ + +.. automodule:: com.vmware.nsx.loadbalancer.services + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.nsx.loadbalancer.services.pools\_client module +--------------------------------------------------------- + +.. automodule:: com.vmware.nsx.loadbalancer.services.pools_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.loadbalancer.services.virtual\_servers\_client module +-------------------------------------------------------------------- + +.. automodule:: com.vmware.nsx.loadbalancer.services.virtual_servers_client + :members: + :undoc-members: + :show-inheritance: + + diff --git a/nsx/nsx/_sources/com.vmware.nsx.logical_router_ports.rst.txt b/nsx/nsx/_sources/com.vmware.nsx.logical_router_ports.rst.txt new file mode 100644 index 00000000..75926ef4 --- /dev/null +++ b/nsx/nsx/_sources/com.vmware.nsx.logical_router_ports.rst.txt @@ -0,0 +1,20 @@ +com.vmware.nsx.logical\_router\_ports package +============================================= + +.. automodule:: com.vmware.nsx.logical_router_ports + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.nsx.logical\_router\_ports.statistics\_client module +--------------------------------------------------------------- + +.. automodule:: com.vmware.nsx.logical_router_ports.statistics_client + :members: + :undoc-members: + :show-inheritance: + + diff --git a/nsx/nsx/_sources/com.vmware.nsx.logical_routers.nat.rst.txt b/nsx/nsx/_sources/com.vmware.nsx.logical_routers.nat.rst.txt new file mode 100644 index 00000000..0616adbe --- /dev/null +++ b/nsx/nsx/_sources/com.vmware.nsx.logical_routers.nat.rst.txt @@ -0,0 +1,20 @@ +com.vmware.nsx.logical\_routers.nat package +=========================================== + +.. automodule:: com.vmware.nsx.logical_routers.nat + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.nsx.logical\_routers.nat.rules\_client module +-------------------------------------------------------- + +.. automodule:: com.vmware.nsx.logical_routers.nat.rules_client + :members: + :undoc-members: + :show-inheritance: + + diff --git a/nsx/nsx/_sources/com.vmware.nsx.logical_routers.routing.bgp.rst.txt b/nsx/nsx/_sources/com.vmware.nsx.logical_routers.routing.bgp.rst.txt new file mode 100644 index 00000000..ce750da2 --- /dev/null +++ b/nsx/nsx/_sources/com.vmware.nsx.logical_routers.routing.bgp.rst.txt @@ -0,0 +1,20 @@ +com.vmware.nsx.logical\_routers.routing.bgp package +=================================================== + +.. automodule:: com.vmware.nsx.logical_routers.routing.bgp + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.nsx.logical\_routers.routing.bgp.neighbors\_client module +-------------------------------------------------------------------- + +.. automodule:: com.vmware.nsx.logical_routers.routing.bgp.neighbors_client + :members: + :undoc-members: + :show-inheritance: + + diff --git a/nsx/nsx/_sources/com.vmware.nsx.logical_routers.routing.rst.txt b/nsx/nsx/_sources/com.vmware.nsx.logical_routers.routing.rst.txt new file mode 100644 index 00000000..07be7cef --- /dev/null +++ b/nsx/nsx/_sources/com.vmware.nsx.logical_routers.routing.rst.txt @@ -0,0 +1,51 @@ +com.vmware.nsx.logical\_routers.routing package +=============================================== + +.. automodule:: com.vmware.nsx.logical_routers.routing + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + com.vmware.nsx.logical_routers.routing.bgp + +Submodules +---------- + +com.vmware.nsx.logical\_routers.routing.advertisement\_client module +-------------------------------------------------------------------- + +.. automodule:: com.vmware.nsx.logical_routers.routing.advertisement_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.logical\_routers.routing.bgp\_client module +---------------------------------------------------------- + +.. automodule:: com.vmware.nsx.logical_routers.routing.bgp_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.logical\_routers.routing.redistribution\_client module +--------------------------------------------------------------------- + +.. automodule:: com.vmware.nsx.logical_routers.routing.redistribution_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.logical\_routers.routing.static\_routes\_client module +--------------------------------------------------------------------- + +.. automodule:: com.vmware.nsx.logical_routers.routing.static_routes_client + :members: + :undoc-members: + :show-inheritance: + + diff --git a/nsx/nsx/_sources/com.vmware.nsx.logical_routers.rst.txt b/nsx/nsx/_sources/com.vmware.nsx.logical_routers.rst.txt new file mode 100644 index 00000000..7742c862 --- /dev/null +++ b/nsx/nsx/_sources/com.vmware.nsx.logical_routers.rst.txt @@ -0,0 +1,36 @@ +com.vmware.nsx.logical\_routers package +======================================= + +.. automodule:: com.vmware.nsx.logical_routers + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + com.vmware.nsx.logical_routers.nat + com.vmware.nsx.logical_routers.routing + +Submodules +---------- + +com.vmware.nsx.logical\_routers.nat\_client module +-------------------------------------------------- + +.. automodule:: com.vmware.nsx.logical_routers.nat_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.logical\_routers.routing\_client module +------------------------------------------------------ + +.. automodule:: com.vmware.nsx.logical_routers.routing_client + :members: + :undoc-members: + :show-inheritance: + + diff --git a/nsx/nsx/_sources/com.vmware.nsx.migration.rst.txt b/nsx/nsx/_sources/com.vmware.nsx.migration.rst.txt new file mode 100644 index 00000000..681f06ae --- /dev/null +++ b/nsx/nsx/_sources/com.vmware.nsx.migration.rst.txt @@ -0,0 +1,44 @@ +com.vmware.nsx.migration package +================================ + +.. automodule:: com.vmware.nsx.migration + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.nsx.migration.bundles\_client module +----------------------------------------------- + +.. automodule:: com.vmware.nsx.migration.bundles_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.migration.migration\_unit\_groups\_client module +--------------------------------------------------------------- + +.. automodule:: com.vmware.nsx.migration.migration_unit_groups_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.migration.migration\_units\_client module +-------------------------------------------------------- + +.. automodule:: com.vmware.nsx.migration.migration_units_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.migration.plan\_client module +-------------------------------------------- + +.. automodule:: com.vmware.nsx.migration.plan_client + :members: + :undoc-members: + :show-inheritance: + + diff --git a/nsx/nsx/_sources/com.vmware.nsx.node.aaa.providers.rst.txt b/nsx/nsx/_sources/com.vmware.nsx.node.aaa.providers.rst.txt new file mode 100644 index 00000000..d751060f --- /dev/null +++ b/nsx/nsx/_sources/com.vmware.nsx.node.aaa.providers.rst.txt @@ -0,0 +1,20 @@ +com.vmware.nsx.node.aaa.providers package +========================================= + +.. automodule:: com.vmware.nsx.node.aaa.providers + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.nsx.node.aaa.providers.vidm\_client module +----------------------------------------------------- + +.. automodule:: com.vmware.nsx.node.aaa.providers.vidm_client + :members: + :undoc-members: + :show-inheritance: + + diff --git a/nsx/nsx/_sources/com.vmware.nsx.node.aaa.rst.txt b/nsx/nsx/_sources/com.vmware.nsx.node.aaa.rst.txt new file mode 100644 index 00000000..e62966be --- /dev/null +++ b/nsx/nsx/_sources/com.vmware.nsx.node.aaa.rst.txt @@ -0,0 +1,27 @@ +com.vmware.nsx.node.aaa package +=============================== + +.. automodule:: com.vmware.nsx.node.aaa + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + com.vmware.nsx.node.aaa.providers + +Submodules +---------- + +com.vmware.nsx.node.aaa.providers\_client module +------------------------------------------------ + +.. automodule:: com.vmware.nsx.node.aaa.providers_client + :members: + :undoc-members: + :show-inheritance: + + diff --git a/nsx/nsx/_sources/com.vmware.nsx.node.network.rst.txt b/nsx/nsx/_sources/com.vmware.nsx.node.network.rst.txt new file mode 100644 index 00000000..79db43cd --- /dev/null +++ b/nsx/nsx/_sources/com.vmware.nsx.node.network.rst.txt @@ -0,0 +1,20 @@ +com.vmware.nsx.node.network package +=================================== + +.. automodule:: com.vmware.nsx.node.network + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.nsx.node.network.interfaces\_client module +----------------------------------------------------- + +.. automodule:: com.vmware.nsx.node.network.interfaces_client + :members: + :undoc-members: + :show-inheritance: + + diff --git a/nsx/nsx/_sources/com.vmware.nsx.node.rst.txt b/nsx/nsx/_sources/com.vmware.nsx.node.rst.txt new file mode 100644 index 00000000..224a4a37 --- /dev/null +++ b/nsx/nsx/_sources/com.vmware.nsx.node.rst.txt @@ -0,0 +1,77 @@ +com.vmware.nsx.node package +=========================== + +.. automodule:: com.vmware.nsx.node + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + com.vmware.nsx.node.aaa + com.vmware.nsx.node.network + com.vmware.nsx.node.services + +Submodules +---------- + +com.vmware.nsx.node.aaa\_client module +-------------------------------------- + +.. automodule:: com.vmware.nsx.node.aaa_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.node.file\_store\_client module +---------------------------------------------- + +.. automodule:: com.vmware.nsx.node.file_store_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.node.hardening\_policy\_client module +---------------------------------------------------- + +.. automodule:: com.vmware.nsx.node.hardening_policy_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.node.network\_client module +------------------------------------------ + +.. automodule:: com.vmware.nsx.node.network_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.node.services\_client module +------------------------------------------- + +.. automodule:: com.vmware.nsx.node.services_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.node.tasks\_client module +---------------------------------------- + +.. automodule:: com.vmware.nsx.node.tasks_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.node.users\_client module +---------------------------------------- + +.. automodule:: com.vmware.nsx.node.users_client + :members: + :undoc-members: + :show-inheritance: + + diff --git a/nsx/nsx/_sources/com.vmware.nsx.node.services.rst.txt b/nsx/nsx/_sources/com.vmware.nsx.node.services.rst.txt new file mode 100644 index 00000000..d78d91a2 --- /dev/null +++ b/nsx/nsx/_sources/com.vmware.nsx.node.services.rst.txt @@ -0,0 +1,148 @@ +com.vmware.nsx.node.services package +==================================== + +.. automodule:: com.vmware.nsx.node.services + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.nsx.node.services.cluster\_manager\_client module +------------------------------------------------------------ + +.. automodule:: com.vmware.nsx.node.services.cluster_manager_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.node.services.cm\_inventory\_client module +--------------------------------------------------------- + +.. automodule:: com.vmware.nsx.node.services.cm_inventory_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.node.services.http\_client module +------------------------------------------------ + +.. automodule:: com.vmware.nsx.node.services.http_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.node.services.install\_upgrade\_client module +------------------------------------------------------------ + +.. automodule:: com.vmware.nsx.node.services.install_upgrade_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.node.services.liagent\_client module +--------------------------------------------------- + +.. automodule:: com.vmware.nsx.node.services.liagent_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.node.services.manager\_client module +--------------------------------------------------- + +.. automodule:: com.vmware.nsx.node.services.manager_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.node.services.mgmt\_plane\_bus\_client module +------------------------------------------------------------ + +.. automodule:: com.vmware.nsx.node.services.mgmt_plane_bus_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.node.services.node\_mgmt\_client module +------------------------------------------------------ + +.. automodule:: com.vmware.nsx.node.services.node_mgmt_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.node.services.nsx\_message\_bus\_client module +------------------------------------------------------------- + +.. automodule:: com.vmware.nsx.node.services.nsx_message_bus_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.node.services.nsx\_upgrade\_agent\_client module +--------------------------------------------------------------- + +.. automodule:: com.vmware.nsx.node.services.nsx_upgrade_agent_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.node.services.ntp\_client module +----------------------------------------------- + +.. automodule:: com.vmware.nsx.node.services.ntp_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.node.services.search\_client module +-------------------------------------------------- + +.. automodule:: com.vmware.nsx.node.services.search_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.node.services.snmp\_client module +------------------------------------------------ + +.. automodule:: com.vmware.nsx.node.services.snmp_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.node.services.ssh\_client module +----------------------------------------------- + +.. automodule:: com.vmware.nsx.node.services.ssh_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.node.services.syslog\_client module +-------------------------------------------------- + +.. automodule:: com.vmware.nsx.node.services.syslog_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.node.services.telemetry\_client module +----------------------------------------------------- + +.. automodule:: com.vmware.nsx.node.services.telemetry_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.node.services.ui\_service\_client module +------------------------------------------------------- + +.. automodule:: com.vmware.nsx.node.services.ui_service_client + :members: + :undoc-members: + :show-inheritance: + + diff --git a/nsx/nsx/_sources/com.vmware.nsx.pools.rst.txt b/nsx/nsx/_sources/com.vmware.nsx.pools.rst.txt new file mode 100644 index 00000000..77153fef --- /dev/null +++ b/nsx/nsx/_sources/com.vmware.nsx.pools.rst.txt @@ -0,0 +1,20 @@ +com.vmware.nsx.pools package +============================ + +.. automodule:: com.vmware.nsx.pools + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.nsx.pools.ip\_pools\_client module +--------------------------------------------- + +.. automodule:: com.vmware.nsx.pools.ip_pools_client + :members: + :undoc-members: + :show-inheritance: + + diff --git a/nsx/nsx/_sources/com.vmware.nsx.rst.txt b/nsx/nsx/_sources/com.vmware.nsx.rst.txt new file mode 100644 index 00000000..791898a2 --- /dev/null +++ b/nsx/nsx/_sources/com.vmware.nsx.rst.txt @@ -0,0 +1,364 @@ +com.vmware.nsx package +====================== + +.. automodule:: com.vmware.nsx + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + com.vmware.nsx.aaa + com.vmware.nsx.app_discovery + com.vmware.nsx.cluster + com.vmware.nsx.dhcp + com.vmware.nsx.dns + com.vmware.nsx.fabric + com.vmware.nsx.firewall + com.vmware.nsx.lldp + com.vmware.nsx.loadbalancer + com.vmware.nsx.logical_router_ports + com.vmware.nsx.logical_routers + com.vmware.nsx.migration + com.vmware.nsx.node + com.vmware.nsx.pools + com.vmware.nsx.serviceinsertion + com.vmware.nsx.transport_nodes + com.vmware.nsx.upgrade + com.vmware.nsx.vpn + +Submodules +---------- + +com.vmware.nsx.aaa\_client module +--------------------------------- + +.. automodule:: com.vmware.nsx.aaa_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.administration\_client module +-------------------------------------------- + +.. automodule:: com.vmware.nsx.administration_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.app\_discovery\_client module +-------------------------------------------- + +.. automodule:: com.vmware.nsx.app_discovery_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.bridge\_clusters\_client module +---------------------------------------------- + +.. automodule:: com.vmware.nsx.bridge_clusters_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.bridge\_endpoints\_client module +----------------------------------------------- + +.. automodule:: com.vmware.nsx.bridge_endpoints_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.cluster\_client module +------------------------------------- + +.. automodule:: com.vmware.nsx.cluster_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.compute\_collection\_transport\_node\_templates\_client module +----------------------------------------------------------------------------- + +.. automodule:: com.vmware.nsx.compute_collection_transport_node_templates_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.configs\_client module +------------------------------------- + +.. automodule:: com.vmware.nsx.configs_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.dhcp\_client module +---------------------------------- + +.. automodule:: com.vmware.nsx.dhcp_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.dns\_client module +--------------------------------- + +.. automodule:: com.vmware.nsx.dns_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.eula\_client module +---------------------------------- + +.. automodule:: com.vmware.nsx.eula_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.fabric\_client module +------------------------------------ + +.. automodule:: com.vmware.nsx.fabric_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.firewall\_client module +-------------------------------------- + +.. automodule:: com.vmware.nsx.firewall_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.hpm\_client module +--------------------------------- + +.. automodule:: com.vmware.nsx.hpm_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.ipfix\_client module +----------------------------------- + +.. automodule:: com.vmware.nsx.ipfix_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.ipfix\_obs\_points\_client module +------------------------------------------------ + +.. automodule:: com.vmware.nsx.ipfix_obs_points_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.licenses\_client module +-------------------------------------- + +.. automodule:: com.vmware.nsx.licenses_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.loadbalancer\_client module +------------------------------------------ + +.. automodule:: com.vmware.nsx.loadbalancer_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.logical\_ports\_client module +-------------------------------------------- + +.. automodule:: com.vmware.nsx.logical_ports_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.logical\_router\_ports\_client module +---------------------------------------------------- + +.. automodule:: com.vmware.nsx.logical_router_ports_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.logical\_routers\_client module +---------------------------------------------- + +.. automodule:: com.vmware.nsx.logical_routers_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.logical\_switches\_client module +----------------------------------------------- + +.. automodule:: com.vmware.nsx.logical_switches_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.mac\_sets\_client module +--------------------------------------- + +.. automodule:: com.vmware.nsx.mac_sets_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.md\_proxies\_client module +----------------------------------------- + +.. automodule:: com.vmware.nsx.md_proxies_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.migration\_client module +--------------------------------------- + +.. automodule:: com.vmware.nsx.migration_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.model\_client module +----------------------------------- + +.. automodule:: com.vmware.nsx.model_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.node\_client module +---------------------------------- + +.. automodule:: com.vmware.nsx.node_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.ns\_groups\_client module +---------------------------------------- + +.. automodule:: com.vmware.nsx.ns_groups_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.pktcap\_client module +------------------------------------ + +.. automodule:: com.vmware.nsx.pktcap_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.pools\_client module +----------------------------------- + +.. automodule:: com.vmware.nsx.pools_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.realization\_state\_barrier\_client module +--------------------------------------------------------- + +.. automodule:: com.vmware.nsx.realization_state_barrier_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.serviceinsertion\_client module +---------------------------------------------- + +.. automodule:: com.vmware.nsx.serviceinsertion_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.switching\_profiles\_client module +------------------------------------------------- + +.. automodule:: com.vmware.nsx.switching_profiles_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.tasks\_client module +----------------------------------- + +.. automodule:: com.vmware.nsx.tasks_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.telemetry\_client module +--------------------------------------- + +.. automodule:: com.vmware.nsx.telemetry_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.traceflows\_client module +---------------------------------------- + +.. automodule:: com.vmware.nsx.traceflows_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.transport\_nodes\_client module +---------------------------------------------- + +.. automodule:: com.vmware.nsx.transport_nodes_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.transport\_zones\_client module +---------------------------------------------- + +.. automodule:: com.vmware.nsx.transport_zones_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.trust\_management\_client module +----------------------------------------------- + +.. automodule:: com.vmware.nsx.trust_management_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.ui\_views\_client module +--------------------------------------- + +.. automodule:: com.vmware.nsx.ui_views_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.upgrade\_client module +------------------------------------- + +.. automodule:: com.vmware.nsx.upgrade_client + :members: + :undoc-members: + :show-inheritance: + + diff --git a/nsx/nsx/_sources/com.vmware.nsx.serviceinsertion.rst.txt b/nsx/nsx/_sources/com.vmware.nsx.serviceinsertion.rst.txt new file mode 100644 index 00000000..f649e75c --- /dev/null +++ b/nsx/nsx/_sources/com.vmware.nsx.serviceinsertion.rst.txt @@ -0,0 +1,35 @@ +com.vmware.nsx.serviceinsertion package +======================================= + +.. automodule:: com.vmware.nsx.serviceinsertion + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + com.vmware.nsx.serviceinsertion.services + +Submodules +---------- + +com.vmware.nsx.serviceinsertion.sections\_client module +------------------------------------------------------- + +.. automodule:: com.vmware.nsx.serviceinsertion.sections_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.serviceinsertion.services\_client module +------------------------------------------------------- + +.. automodule:: com.vmware.nsx.serviceinsertion.services_client + :members: + :undoc-members: + :show-inheritance: + + diff --git a/nsx/nsx/_sources/com.vmware.nsx.serviceinsertion.services.rst.txt b/nsx/nsx/_sources/com.vmware.nsx.serviceinsertion.services.rst.txt new file mode 100644 index 00000000..39c820a1 --- /dev/null +++ b/nsx/nsx/_sources/com.vmware.nsx.serviceinsertion.services.rst.txt @@ -0,0 +1,27 @@ +com.vmware.nsx.serviceinsertion.services package +================================================ + +.. automodule:: com.vmware.nsx.serviceinsertion.services + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + com.vmware.nsx.serviceinsertion.services.service_instances + +Submodules +---------- + +com.vmware.nsx.serviceinsertion.services.service\_instances\_client module +-------------------------------------------------------------------------- + +.. automodule:: com.vmware.nsx.serviceinsertion.services.service_instances_client + :members: + :undoc-members: + :show-inheritance: + + diff --git a/nsx/nsx/_sources/com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.rst.txt b/nsx/nsx/_sources/com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.rst.txt new file mode 100644 index 00000000..dcfb5832 --- /dev/null +++ b/nsx/nsx/_sources/com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.rst.txt @@ -0,0 +1,20 @@ +com.vmware.nsx.serviceinsertion.services.service\_instances.instance\_runtimes package +====================================================================================== + +.. automodule:: com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.nsx.serviceinsertion.services.service\_instances.instance\_runtimes.interfaces\_client module +-------------------------------------------------------------------------------------------------------- + +.. automodule:: com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.interfaces_client + :members: + :undoc-members: + :show-inheritance: + + diff --git a/nsx/nsx/_sources/com.vmware.nsx.serviceinsertion.services.service_instances.rst.txt b/nsx/nsx/_sources/com.vmware.nsx.serviceinsertion.services.service_instances.rst.txt new file mode 100644 index 00000000..691fbe7c --- /dev/null +++ b/nsx/nsx/_sources/com.vmware.nsx.serviceinsertion.services.service_instances.rst.txt @@ -0,0 +1,15 @@ +com.vmware.nsx.serviceinsertion.services.service\_instances package +=================================================================== + +.. automodule:: com.vmware.nsx.serviceinsertion.services.service_instances + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes + diff --git a/nsx/nsx/_sources/com.vmware.nsx.transport_nodes.rst.txt b/nsx/nsx/_sources/com.vmware.nsx.transport_nodes.rst.txt new file mode 100644 index 00000000..843fdac6 --- /dev/null +++ b/nsx/nsx/_sources/com.vmware.nsx.transport_nodes.rst.txt @@ -0,0 +1,20 @@ +com.vmware.nsx.transport\_nodes package +======================================= + +.. automodule:: com.vmware.nsx.transport_nodes + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.nsx.transport\_nodes.statistics\_client module +--------------------------------------------------------- + +.. automodule:: com.vmware.nsx.transport_nodes.statistics_client + :members: + :undoc-members: + :show-inheritance: + + diff --git a/nsx/nsx/_sources/com.vmware.nsx.upgrade.rst.txt b/nsx/nsx/_sources/com.vmware.nsx.upgrade.rst.txt new file mode 100644 index 00000000..3459d123 --- /dev/null +++ b/nsx/nsx/_sources/com.vmware.nsx.upgrade.rst.txt @@ -0,0 +1,52 @@ +com.vmware.nsx.upgrade package +============================== + +.. automodule:: com.vmware.nsx.upgrade + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.nsx.upgrade.bundles\_client module +--------------------------------------------- + +.. automodule:: com.vmware.nsx.upgrade.bundles_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.upgrade.eula\_client module +------------------------------------------ + +.. automodule:: com.vmware.nsx.upgrade.eula_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.upgrade.plan\_client module +------------------------------------------ + +.. automodule:: com.vmware.nsx.upgrade.plan_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.upgrade.upgrade\_unit\_groups\_client module +----------------------------------------------------------- + +.. automodule:: com.vmware.nsx.upgrade.upgrade_unit_groups_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.upgrade.upgrade\_units\_client module +---------------------------------------------------- + +.. automodule:: com.vmware.nsx.upgrade.upgrade_units_client + :members: + :undoc-members: + :show-inheritance: + + diff --git a/nsx/nsx/_sources/com.vmware.nsx.vpn.ipsec.rst.txt b/nsx/nsx/_sources/com.vmware.nsx.vpn.ipsec.rst.txt new file mode 100644 index 00000000..6f70be9a --- /dev/null +++ b/nsx/nsx/_sources/com.vmware.nsx.vpn.ipsec.rst.txt @@ -0,0 +1,20 @@ +com.vmware.nsx.vpn.ipsec package +================================ + +.. automodule:: com.vmware.nsx.vpn.ipsec + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.nsx.vpn.ipsec.sessions\_client module +------------------------------------------------ + +.. automodule:: com.vmware.nsx.vpn.ipsec.sessions_client + :members: + :undoc-members: + :show-inheritance: + + diff --git a/nsx/nsx/_sources/com.vmware.nsx.vpn.l2vpn.rst.txt b/nsx/nsx/_sources/com.vmware.nsx.vpn.l2vpn.rst.txt new file mode 100644 index 00000000..2ca6e7ff --- /dev/null +++ b/nsx/nsx/_sources/com.vmware.nsx.vpn.l2vpn.rst.txt @@ -0,0 +1,20 @@ +com.vmware.nsx.vpn.l2vpn package +================================ + +.. automodule:: com.vmware.nsx.vpn.l2vpn + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.nsx.vpn.l2vpn.sessions\_client module +------------------------------------------------ + +.. automodule:: com.vmware.nsx.vpn.l2vpn.sessions_client + :members: + :undoc-members: + :show-inheritance: + + diff --git a/nsx/nsx/_sources/com.vmware.nsx.vpn.rst.txt b/nsx/nsx/_sources/com.vmware.nsx.vpn.rst.txt new file mode 100644 index 00000000..a3677e86 --- /dev/null +++ b/nsx/nsx/_sources/com.vmware.nsx.vpn.rst.txt @@ -0,0 +1,44 @@ +com.vmware.nsx.vpn package +========================== + +.. automodule:: com.vmware.nsx.vpn + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + com.vmware.nsx.vpn.ipsec + com.vmware.nsx.vpn.l2vpn + +Submodules +---------- + +com.vmware.nsx.vpn.ipsec\_client module +--------------------------------------- + +.. automodule:: com.vmware.nsx.vpn.ipsec_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.vpn.l2vpn\_client module +--------------------------------------- + +.. automodule:: com.vmware.nsx.vpn.l2vpn_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx.vpn.services\_client module +------------------------------------------ + +.. automodule:: com.vmware.nsx.vpn.services_client + :members: + :undoc-members: + :show-inheritance: + + diff --git a/nsx/nsx/_sources/com.vmware.rst.txt b/nsx/nsx/_sources/com.vmware.rst.txt new file mode 100644 index 00000000..c1917810 --- /dev/null +++ b/nsx/nsx/_sources/com.vmware.rst.txt @@ -0,0 +1,35 @@ +com.vmware package +================== + +.. automodule:: com.vmware + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + com.vmware.nsx + +Submodules +---------- + +com.vmware.nsx\_client module +----------------------------- + +.. automodule:: com.vmware.nsx_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx\_client\_for\_vmc module +--------------------------------------- + +.. automodule:: com.vmware.nsx_client_for_vmc + :members: + :undoc-members: + :show-inheritance: + + diff --git a/nsx/nsx/_sources/enumeration.rst.txt b/nsx/nsx/_sources/enumeration.rst.txt new file mode 100644 index 00000000..afe09e47 --- /dev/null +++ b/nsx/nsx/_sources/enumeration.rst.txt @@ -0,0 +1,82 @@ +.. _enumeration_description: + +Interface definition language to python mapping for enumerated types +-------------------------------------------------------------------- + +The interface language definition type system includes enumerated types. Python +SDK supports both 2.x and 3.x versions of Python. Since Python 2.x does +not have first class support for enumerations, special classes are +generated to represent enumerated types from the interface definition +language. The special class contains class attributes which represent +the values of the enumerated type. + +This documentation explains the following: + +* How the class variables are defined in the module. This specifies the names that you can use in your program. +* How you instantiate a class to use it for communication with future versions of the service. + +Example of an enumerated type documentation +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +*class* com.vmware.vapi.metadata_client. **SourceType** (string) + Bases: vmware.vapi.bindings.enum.Enum + + Metadata source type + + .. note:: + This class represents an enumerated type in the interface language definition type system. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports a newer version of the API, you instantiate this class. See :ref:`enumerated type description page `. + + **Parameters** : **string** (``str``) – String value for the SourceType instance. + + **FILE** = *SourceType(string='FILE')* + If the source is backed by a file. + + **REMOTE** = *SourceType(string='REMOTE')* + If the source is backed by a remote service. + +Code Examples +^^^^^^^^^^^^^ + +The enumerated type classes are defined in python modules that your code +imports. You can use these in your code. + +1. If you want to pass an enumerated type value in a method to a server, specify the class variable of the enumerated type class. + +.. code-block:: python + + # SourceType is an enumerated type + from com.vmware.vapi.metadata_client import SourceType + + # SourceType has two class attrites, SourceType.FILE and SourceType.REMOTE + spec = Source.CreateSpec(type=SourceType.FILE, filepath='entity_metadata.json', description='Entity service') + source_svc.create(id='entity', spec=spec) + +2. When you receive an enumerated type value in the response from a server, allow for unknown enumerated type values. + +.. code-block:: python + + # SourceType is an enumerated type + from com.vmware.vapi.metadata_client import SourceType + + source_info = source_svc.get(id='entity') + if (source_info.type == SourceType.FILE) { + print 'Source is a file' + } else if (source_info.type == SourceType.REMOTE) { + print 'Source is a remote provider' + } else { + print 'Unknown source type: %s' % str(source_info.type) + } + +3. Sending a new enumerated type value to a server that has a newer version of the enumerated type. + +To use new values of the enumerated type in communication with a server that supports a newer version of the API, you instantiate the +enumerated type class. + +.. code-block:: python + + # If a newer version of SourceType has a new value FOLDER, FOLDER would be one + # of the class attributes for SourceType. In the older version, SourceType has + # only two class attributes, FILE and REMOTE + from com.vmware.vapi.metadata_client import SourceType + spec = Source.CreateSpec(type=SourceType('FOLDER'), filepath='entity_metadata', description='Entity service') + source_svc.create(id='entity', spec=spec) diff --git a/nsx/nsx/_sources/index.rst.txt b/nsx/nsx/_sources/index.rst.txt new file mode 100644 index 00000000..e4ff035e --- /dev/null +++ b/nsx/nsx/_sources/index.rst.txt @@ -0,0 +1,21 @@ +.. NSX-T SDK documentation master file, created by + sphinx-quickstart on Fri Oct 26 14:29:21 2018. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to NSX-T SDK's documentation! +===================================== + +.. toctree:: + :maxdepth: 10 + :caption: Contents: + + com + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/nsx/nsx/_static/ajax-loader.gif b/nsx/nsx/_static/ajax-loader.gif new file mode 100644 index 00000000..61faf8ca Binary files /dev/null and b/nsx/nsx/_static/ajax-loader.gif differ diff --git a/nsx/nsx/_static/basic.css b/nsx/nsx/_static/basic.css new file mode 100644 index 00000000..104f076a --- /dev/null +++ b/nsx/nsx/_static/basic.css @@ -0,0 +1,676 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li div.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 450px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px 7px 0 7px; + background-color: #ffe; + width: 40%; + float: right; +} + +p.sidebar-title { + font-weight: bold; +} + +/* -- topics ---------------------------------------------------------------- */ + +div.topic { + border: 1px solid #ccc; + padding: 7px 7px 0 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +div.admonition dl { + margin-bottom: 0; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +table.footnote td, table.footnote th { + border: 0 !important; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist td { + vertical-align: top; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +dl { + margin-bottom: 15px; +} + +dd p { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; +} + +td.linenos pre { + padding: 5px 0px; + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + margin-left: 0.5em; +} + +table.highlighttable td { + padding: 0 0.5em 0 0.5em; +} + +div.code-block-caption { + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +div.code-block-caption + div > div.highlight > pre { + margin-top: 0; +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + padding: 1em 1em 0; +} + +div.literal-block-wrapper div.highlight { + margin: 0; +} + +code.descname { + background-color: transparent; + font-weight: bold; + font-size: 1.2em; +} + +code.descclassname { + background-color: transparent; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: relative; + left: 0px; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/nsx/nsx/_static/comment-bright.png b/nsx/nsx/_static/comment-bright.png new file mode 100644 index 00000000..15e27edb Binary files /dev/null and b/nsx/nsx/_static/comment-bright.png differ diff --git a/nsx/nsx/_static/comment-close.png b/nsx/nsx/_static/comment-close.png new file mode 100644 index 00000000..4d91bcf5 Binary files /dev/null and b/nsx/nsx/_static/comment-close.png differ diff --git a/nsx/nsx/_static/comment.png b/nsx/nsx/_static/comment.png new file mode 100644 index 00000000..dfbc0cbd Binary files /dev/null and b/nsx/nsx/_static/comment.png differ diff --git a/nsx/nsx/_static/css/badge_only.css b/nsx/nsx/_static/css/badge_only.css new file mode 100644 index 00000000..323730ae --- /dev/null +++ b/nsx/nsx/_static/css/badge_only.css @@ -0,0 +1 @@ +.fa:before{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:before,.clearfix:after{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-weight:normal;font-style:normal;src:url("../fonts/fontawesome-webfont.eot");src:url("../fonts/fontawesome-webfont.eot?#iefix") format("embedded-opentype"),url("../fonts/fontawesome-webfont.woff") format("woff"),url("../fonts/fontawesome-webfont.ttf") format("truetype"),url("../fonts/fontawesome-webfont.svg#FontAwesome") format("svg")}.fa:before{display:inline-block;font-family:FontAwesome;font-style:normal;font-weight:normal;line-height:1;text-decoration:inherit}a .fa{display:inline-block;text-decoration:inherit}li .fa{display:inline-block}li .fa-large:before,li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-0.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before,ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before{content:""}.icon-book:before{content:""}.fa-caret-down:before{content:""}.icon-caret-down:before{content:""}.fa-caret-up:before{content:""}.icon-caret-up:before{content:""}.fa-caret-left:before{content:""}.icon-caret-left:before{content:""}.fa-caret-right:before{content:""}.icon-caret-right:before{content:""}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;z-index:400}.rst-versions a{color:#2980B9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27AE60;*zoom:1}.rst-versions .rst-current-version:before,.rst-versions .rst-current-version:after{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book{float:left}.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#E74C3C;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#F1C40F;color:#000}.rst-versions.shift-up{height:auto;max-height:100%}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:gray;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:solid 1px #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px}.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge .fa-book{float:none}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book{float:left}.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge .rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width: 768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} diff --git a/nsx/nsx/_static/css/theme.css b/nsx/nsx/_static/css/theme.css new file mode 100644 index 00000000..b19dbfe5 --- /dev/null +++ b/nsx/nsx/_static/css/theme.css @@ -0,0 +1,6 @@ +/* sphinx_rtd_theme version 0.4.2 | MIT license */ +/* Built 20181005 13:10 */ +*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}audio:not([controls]){display:none}[hidden]{display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:hover,a:active{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:bold}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;color:#000;text-decoration:none}mark{background:#ff0;color:#000;font-style:italic;font-weight:bold}pre,code,.rst-content tt,.rst-content code,kbd,samp{font-family:monospace,serif;_font-family:"courier new",monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:before,q:after{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-0.5em}sub{bottom:-0.25em}ul,ol,dl{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure{margin:0}form{margin:0}fieldset{border:0;margin:0;padding:0}label{cursor:pointer}legend{border:0;*margin-left:-7px;padding:0;white-space:normal}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type="button"],input[type="reset"],input[type="submit"]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0;*width:13px;*height:13px}input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}input[type="search"]::-webkit-search-decoration,input[type="search"]::-webkit-search-cancel-button{-webkit-appearance:none}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}textarea{overflow:auto;vertical-align:top;resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none !important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{html,body,section{background:none !important}*{box-shadow:none !important;text-shadow:none !important;filter:none !important;-ms-filter:none !important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:.5cm}p,h2,.rst-content .toctree-wrapper p.caption,h3{orphans:3;widows:3}h2,.rst-content .toctree-wrapper p.caption,h3{page-break-after:avoid}}.fa:before,.wy-menu-vertical li span.toctree-expand:before,.wy-menu-vertical li.on a span.toctree-expand:before,.wy-menu-vertical li.current>a span.toctree-expand:before,.rst-content .admonition-title:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content dl dt .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.rst-content code.download span:first-child:before,.icon:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-alert,.rst-content .note,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .warning,.rst-content .seealso,.rst-content .admonition-todo,.rst-content .admonition,.btn,input[type="text"],input[type="password"],input[type="email"],input[type="url"],input[type="date"],input[type="month"],input[type="time"],input[type="datetime"],input[type="datetime-local"],input[type="week"],input[type="number"],input[type="search"],input[type="tel"],input[type="color"],select,textarea,.wy-menu-vertical li.on a,.wy-menu-vertical li.current>a,.wy-side-nav-search>a,.wy-side-nav-search .wy-dropdown>a,.wy-nav-top a{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:before,.clearfix:after{display:table;content:""}.clearfix:after{clear:both}/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:'FontAwesome';src:url("../fonts/fontawesome-webfont.eot?v=4.7.0");src:url("../fonts/fontawesome-webfont.eot?#iefix&v=4.7.0") format("embedded-opentype"),url("../fonts/fontawesome-webfont.woff2?v=4.7.0") format("woff2"),url("../fonts/fontawesome-webfont.woff?v=4.7.0") format("woff"),url("../fonts/fontawesome-webfont.ttf?v=4.7.0") format("truetype"),url("../fonts/fontawesome-webfont.svg?v=4.7.0#fontawesomeregular") format("svg");font-weight:normal;font-style:normal}.fa,.wy-menu-vertical li span.toctree-expand,.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li.current>a span.toctree-expand,.rst-content .admonition-title,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content dl dt .headerlink,.rst-content p.caption .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.rst-content code.download span:first-child,.icon{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.3333333333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.2857142857em;text-align:center}.fa-ul{padding-left:0;margin-left:2.1428571429em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.1428571429em;width:2.1428571429em;top:.1428571429em;text-align:center}.fa-li.fa-lg{left:-1.8571428571em}.fa-border{padding:.2em .25em .15em;border:solid 0.08em #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa.fa-pull-left,.wy-menu-vertical li span.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a span.fa-pull-left.toctree-expand,.wy-menu-vertical li.current>a span.fa-pull-left.toctree-expand,.rst-content .fa-pull-left.admonition-title,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content dl dt .fa-pull-left.headerlink,.rst-content p.caption .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.rst-content code.download span.fa-pull-left:first-child,.fa-pull-left.icon{margin-right:.3em}.fa.fa-pull-right,.wy-menu-vertical li span.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a span.fa-pull-right.toctree-expand,.wy-menu-vertical li.current>a span.fa-pull-right.toctree-expand,.rst-content .fa-pull-right.admonition-title,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content dl dt .fa-pull-right.headerlink,.rst-content p.caption .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.rst-content code.download span.fa-pull-right:first-child,.fa-pull-right.icon{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.wy-menu-vertical li span.pull-left.toctree-expand,.wy-menu-vertical li.on a span.pull-left.toctree-expand,.wy-menu-vertical li.current>a span.pull-left.toctree-expand,.rst-content .pull-left.admonition-title,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content dl dt .pull-left.headerlink,.rst-content p.caption .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.rst-content code.download span.pull-left:first-child,.pull-left.icon{margin-right:.3em}.fa.pull-right,.wy-menu-vertical li span.pull-right.toctree-expand,.wy-menu-vertical li.on a span.pull-right.toctree-expand,.wy-menu-vertical li.current>a span.pull-right.toctree-expand,.rst-content .pull-right.admonition-title,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content dl dt .pull-right.headerlink,.rst-content p.caption .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.rst-content code.download span.pull-right:first-child,.pull-right.icon{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s infinite linear;animation:fa-spin 2s infinite linear}.fa-pulse{-webkit-animation:fa-spin 1s infinite steps(8);animation:fa-spin 1s infinite steps(8)}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scale(-1, 1);-ms-transform:scale(-1, 1);transform:scale(-1, 1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scale(1, -1);-ms-transform:scale(1, -1);transform:scale(1, -1)}:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270,:root .fa-flip-horizontal,:root .fa-flip-vertical{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-remove:before,.fa-close:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-gear:before,.fa-cog:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content tt.download span:first-child:before,.rst-content code.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-rotate-right:before,.fa-repeat:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-photo:before,.fa-image:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.rst-content .admonition-title:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-warning:before,.fa-exclamation-triangle:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-gears:before,.fa-cogs:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-save:before,.fa-floppy-o:before{content:""}.fa-square:before{content:""}.fa-navicon:before,.fa-reorder:before,.fa-bars:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.wy-dropdown .caret:before,.icon-caret-down:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-unsorted:before,.fa-sort:before{content:""}.fa-sort-down:before,.fa-sort-desc:before{content:""}.fa-sort-up:before,.fa-sort-asc:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-legal:before,.fa-gavel:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-flash:before,.fa-bolt:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-paste:before,.fa-clipboard:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-unlink:before,.fa-chain-broken:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.on a span.toctree-expand:before,.wy-menu-vertical li.current>a span.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-toggle-down:before,.fa-caret-square-o-down:before{content:""}.fa-toggle-up:before,.fa-caret-square-o-up:before{content:""}.fa-toggle-right:before,.fa-caret-square-o-right:before{content:""}.fa-euro:before,.fa-eur:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-rupee:before,.fa-inr:before{content:""}.fa-cny:before,.fa-rmb:before,.fa-yen:before,.fa-jpy:before{content:""}.fa-ruble:before,.fa-rouble:before,.fa-rub:before{content:""}.fa-won:before,.fa-krw:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-toggle-left:before,.fa-caret-square-o-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-turkish-lira:before,.fa-try:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li span.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-institution:before,.fa-bank:before,.fa-university:before{content:""}.fa-mortar-board:before,.fa-graduation-cap:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-photo-o:before,.fa-file-picture-o:before,.fa-file-image-o:before{content:""}.fa-file-zip-o:before,.fa-file-archive-o:before{content:""}.fa-file-sound-o:before,.fa-file-audio-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-saver:before,.fa-support:before,.fa-life-ring:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-resistance:before,.fa-rebel:before{content:""}.fa-ge:before,.fa-empire:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-y-combinator-square:before,.fa-yc-square:before,.fa-hacker-news:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-send:before,.fa-paper-plane:before{content:""}.fa-send-o:before,.fa-paper-plane-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-soccer-ball-o:before,.fa-futbol-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-shekel:before,.fa-sheqel:before,.fa-ils:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-hotel:before,.fa-bed:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-yc:before,.fa-y-combinator:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery:before,.fa-battery-full:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-stop-o:before,.fa-hand-paper-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-tv:before,.fa-television:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-asl-interpreting:before,.fa-american-sign-language-interpreting:before{content:""}.fa-deafness:before,.fa-hard-of-hearing:before,.fa-deaf:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-signing:before,.fa-sign-language:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-vcard:before,.fa-address-card:before{content:""}.fa-vcard-o:before,.fa-address-card-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer:before,.fa-thermometer-full:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bathtub:before,.fa-s15:before,.fa-bath:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0, 0, 0, 0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.wy-menu-vertical li span.toctree-expand,.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li.current>a span.toctree-expand,.rst-content .admonition-title,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content dl dt .headerlink,.rst-content p.caption .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.rst-content code.download span:first-child,.icon,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context{font-family:inherit}.fa:before,.wy-menu-vertical li span.toctree-expand:before,.wy-menu-vertical li.on a span.toctree-expand:before,.wy-menu-vertical li.current>a span.toctree-expand:before,.rst-content .admonition-title:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content dl dt .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.rst-content code.download span:first-child:before,.icon:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before{font-family:"FontAwesome";display:inline-block;font-style:normal;font-weight:normal;line-height:1;text-decoration:inherit}a .fa,a .wy-menu-vertical li span.toctree-expand,.wy-menu-vertical li a span.toctree-expand,.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li.current>a span.toctree-expand,a .rst-content .admonition-title,.rst-content a .admonition-title,a .rst-content h1 .headerlink,.rst-content h1 a .headerlink,a .rst-content h2 .headerlink,.rst-content h2 a .headerlink,a .rst-content h3 .headerlink,.rst-content h3 a .headerlink,a .rst-content h4 .headerlink,.rst-content h4 a .headerlink,a .rst-content h5 .headerlink,.rst-content h5 a .headerlink,a .rst-content h6 .headerlink,.rst-content h6 a .headerlink,a .rst-content dl dt .headerlink,.rst-content dl dt a .headerlink,a .rst-content p.caption .headerlink,.rst-content p.caption a .headerlink,a .rst-content table>caption .headerlink,.rst-content table>caption a .headerlink,a .rst-content tt.download span:first-child,.rst-content tt.download a span:first-child,a .rst-content code.download span:first-child,.rst-content code.download a span:first-child,a .icon{display:inline-block;text-decoration:inherit}.btn .fa,.btn .wy-menu-vertical li span.toctree-expand,.wy-menu-vertical li .btn span.toctree-expand,.btn .wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li.on a .btn span.toctree-expand,.btn .wy-menu-vertical li.current>a span.toctree-expand,.wy-menu-vertical li.current>a .btn span.toctree-expand,.btn .rst-content .admonition-title,.rst-content .btn .admonition-title,.btn .rst-content h1 .headerlink,.rst-content h1 .btn .headerlink,.btn .rst-content h2 .headerlink,.rst-content h2 .btn .headerlink,.btn .rst-content h3 .headerlink,.rst-content h3 .btn .headerlink,.btn .rst-content h4 .headerlink,.rst-content h4 .btn .headerlink,.btn .rst-content h5 .headerlink,.rst-content h5 .btn .headerlink,.btn .rst-content h6 .headerlink,.rst-content h6 .btn .headerlink,.btn .rst-content dl dt .headerlink,.rst-content dl dt .btn .headerlink,.btn .rst-content p.caption .headerlink,.rst-content p.caption .btn .headerlink,.btn .rst-content table>caption .headerlink,.rst-content table>caption .btn .headerlink,.btn .rst-content tt.download span:first-child,.rst-content tt.download .btn span:first-child,.btn .rst-content code.download span:first-child,.rst-content code.download .btn span:first-child,.btn .icon,.nav .fa,.nav .wy-menu-vertical li span.toctree-expand,.wy-menu-vertical li .nav span.toctree-expand,.nav .wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li.on a .nav span.toctree-expand,.nav .wy-menu-vertical li.current>a span.toctree-expand,.wy-menu-vertical li.current>a .nav span.toctree-expand,.nav .rst-content .admonition-title,.rst-content .nav .admonition-title,.nav .rst-content h1 .headerlink,.rst-content h1 .nav .headerlink,.nav .rst-content h2 .headerlink,.rst-content h2 .nav .headerlink,.nav .rst-content h3 .headerlink,.rst-content h3 .nav .headerlink,.nav .rst-content h4 .headerlink,.rst-content h4 .nav .headerlink,.nav .rst-content h5 .headerlink,.rst-content h5 .nav .headerlink,.nav .rst-content h6 .headerlink,.rst-content h6 .nav .headerlink,.nav .rst-content dl dt .headerlink,.rst-content dl dt .nav .headerlink,.nav .rst-content p.caption .headerlink,.rst-content p.caption .nav .headerlink,.nav .rst-content table>caption .headerlink,.rst-content table>caption .nav .headerlink,.nav .rst-content tt.download span:first-child,.rst-content tt.download .nav span:first-child,.nav .rst-content code.download span:first-child,.rst-content code.download .nav span:first-child,.nav .icon{display:inline}.btn .fa.fa-large,.btn .wy-menu-vertical li span.fa-large.toctree-expand,.wy-menu-vertical li .btn span.fa-large.toctree-expand,.btn .rst-content .fa-large.admonition-title,.rst-content .btn .fa-large.admonition-title,.btn .rst-content h1 .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.btn .rst-content dl dt .fa-large.headerlink,.rst-content dl dt .btn .fa-large.headerlink,.btn .rst-content p.caption .fa-large.headerlink,.rst-content p.caption .btn .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.rst-content tt.download .btn span.fa-large:first-child,.btn .rst-content code.download span.fa-large:first-child,.rst-content code.download .btn span.fa-large:first-child,.btn .fa-large.icon,.nav .fa.fa-large,.nav .wy-menu-vertical li span.fa-large.toctree-expand,.wy-menu-vertical li .nav span.fa-large.toctree-expand,.nav .rst-content .fa-large.admonition-title,.rst-content .nav .fa-large.admonition-title,.nav .rst-content h1 .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.nav .rst-content dl dt .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.nav .rst-content p.caption .fa-large.headerlink,.rst-content p.caption .nav .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.nav .rst-content code.download span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.nav .fa-large.icon{line-height:.9em}.btn .fa.fa-spin,.btn .wy-menu-vertical li span.fa-spin.toctree-expand,.wy-menu-vertical li .btn span.fa-spin.toctree-expand,.btn .rst-content .fa-spin.admonition-title,.rst-content .btn .fa-spin.admonition-title,.btn .rst-content h1 .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.btn .rst-content dl dt .fa-spin.headerlink,.rst-content dl dt .btn .fa-spin.headerlink,.btn .rst-content p.caption .fa-spin.headerlink,.rst-content p.caption .btn .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.rst-content tt.download .btn span.fa-spin:first-child,.btn .rst-content code.download span.fa-spin:first-child,.rst-content code.download .btn span.fa-spin:first-child,.btn .fa-spin.icon,.nav .fa.fa-spin,.nav .wy-menu-vertical li span.fa-spin.toctree-expand,.wy-menu-vertical li .nav span.fa-spin.toctree-expand,.nav .rst-content .fa-spin.admonition-title,.rst-content .nav .fa-spin.admonition-title,.nav .rst-content h1 .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.nav .rst-content dl dt .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.nav .rst-content p.caption .fa-spin.headerlink,.rst-content p.caption .nav .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.nav .rst-content code.download span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.nav .fa-spin.icon{display:inline-block}.btn.fa:before,.wy-menu-vertical li span.btn.toctree-expand:before,.rst-content .btn.admonition-title:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content dl dt .btn.headerlink:before,.rst-content p.caption .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.rst-content code.download span.btn:first-child:before,.btn.icon:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.wy-menu-vertical li span.btn.toctree-expand:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content p.caption .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.rst-content code.download span.btn:first-child:hover:before,.btn.icon:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .wy-menu-vertical li span.toctree-expand:before,.wy-menu-vertical li .btn-mini span.toctree-expand:before,.btn-mini .rst-content .admonition-title:before,.rst-content .btn-mini .admonition-title:before,.btn-mini .rst-content h1 .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.btn-mini .rst-content dl dt .headerlink:before,.rst-content dl dt .btn-mini .headerlink:before,.btn-mini .rst-content p.caption .headerlink:before,.rst-content p.caption .btn-mini .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.rst-content tt.download .btn-mini span:first-child:before,.btn-mini .rst-content code.download span:first-child:before,.rst-content code.download .btn-mini span:first-child:before,.btn-mini .icon:before{font-size:14px;vertical-align:-15%}.wy-alert,.rst-content .note,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .warning,.rst-content .seealso,.rst-content .admonition-todo,.rst-content .admonition{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.wy-alert-title,.rst-content .admonition-title{color:#fff;font-weight:bold;display:block;color:#fff;background:#6ab0de;margin:-12px;padding:6px 12px;margin-bottom:12px}.wy-alert.wy-alert-danger,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.admonition{background:#fdf3f2}.wy-alert.wy-alert-danger .wy-alert-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .danger .wy-alert-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .danger .admonition-title,.rst-content .error .admonition-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition .admonition-title{background:#f29f97}.wy-alert.wy-alert-warning,.rst-content .wy-alert-warning.note,.rst-content .attention,.rst-content .caution,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.tip,.rst-content .warning,.rst-content .wy-alert-warning.seealso,.rst-content .admonition-todo,.rst-content .wy-alert-warning.admonition{background:#ffedcc}.wy-alert.wy-alert-warning .wy-alert-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .attention .wy-alert-title,.rst-content .caution .wy-alert-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .attention .admonition-title,.rst-content .caution .admonition-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .warning .admonition-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .admonition-todo .admonition-title,.rst-content .wy-alert-warning.admonition .admonition-title{background:#f0b37e}.wy-alert.wy-alert-info,.rst-content .note,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.rst-content .seealso,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.admonition{background:#e7f2fa}.wy-alert.wy-alert-info .wy-alert-title,.rst-content .note .wy-alert-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.rst-content .note .admonition-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .seealso .admonition-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition .admonition-title{background:#6ab0de}.wy-alert.wy-alert-success,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.warning,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.admonition{background:#dbfaf4}.wy-alert.wy-alert-success .wy-alert-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .hint .wy-alert-title,.rst-content .important .wy-alert-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .hint .admonition-title,.rst-content .important .admonition-title,.rst-content .tip .admonition-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition .admonition-title{background:#1abc9c}.wy-alert.wy-alert-neutral,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.admonition{background:#f3f6f6}.wy-alert.wy-alert-neutral .wy-alert-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition .admonition-title{color:#404040;background:#e1e4e5}.wy-alert.wy-alert-neutral a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a{color:#2980B9}.wy-alert p:last-child,.rst-content .note p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.rst-content .seealso p:last-child,.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0px;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,0.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27AE60}.wy-tray-container li.wy-tray-item-info{background:#2980B9}.wy-tray-container li.wy-tray-item-warning{background:#E67E22}.wy-tray-container li.wy-tray-item-danger{background:#E74C3C}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width: 768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px 12px;color:#fff;border:1px solid rgba(0,0,0,0.1);background-color:#27AE60;text-decoration:none;font-weight:normal;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;box-shadow:0px 1px 2px -1px rgba(255,255,255,0.5) inset,0px -2px 0px 0px rgba(0,0,0,0.1) inset;outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:0px -1px 0px 0px rgba(0,0,0,0.05) inset,0px 2px 0px 0px rgba(0,0,0,0.1) inset;padding:8px 12px 6px 12px}.btn:visited{color:#fff}.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn-disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn-disabled:hover,.btn-disabled:focus,.btn-disabled:active{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980B9 !important}.btn-info:hover{background-color:#2e8ece !important}.btn-neutral{background-color:#f3f6f6 !important;color:#404040 !important}.btn-neutral:hover{background-color:#e5ebeb !important;color:#404040}.btn-neutral:visited{color:#404040 !important}.btn-success{background-color:#27AE60 !important}.btn-success:hover{background-color:#295 !important}.btn-danger{background-color:#E74C3C !important}.btn-danger:hover{background-color:#ea6153 !important}.btn-warning{background-color:#E67E22 !important}.btn-warning:hover{background-color:#e98b39 !important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f !important}.btn-link{background-color:transparent !important;color:#2980B9;box-shadow:none;border-color:transparent !important}.btn-link:hover{background-color:transparent !important;color:#409ad5 !important;box-shadow:none}.btn-link:active{background-color:transparent !important;color:#409ad5 !important;box-shadow:none}.btn-link:visited{color:#9B59B6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:before,.wy-btn-group:after{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:solid 1px #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,0.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980B9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:solid 1px #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type="search"]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980B9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned input,.wy-form-aligned textarea,.wy-form-aligned select,.wy-form-aligned .wy-help-inline,.wy-form-aligned label{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{border:0;margin:0;padding:0}legend{display:block;width:100%;border:0;padding:0;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label{display:block;margin:0 0 .3125em 0;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;*zoom:1;max-width:68em;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:before,.wy-control-group:after{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group:before,.wy-control-group:after{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#E74C3C}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full input[type="text"],.wy-control-group .wy-form-full input[type="password"],.wy-control-group .wy-form-full input[type="email"],.wy-control-group .wy-form-full input[type="url"],.wy-control-group .wy-form-full input[type="date"],.wy-control-group .wy-form-full input[type="month"],.wy-control-group .wy-form-full input[type="time"],.wy-control-group .wy-form-full input[type="datetime"],.wy-control-group .wy-form-full input[type="datetime-local"],.wy-control-group .wy-form-full input[type="week"],.wy-control-group .wy-form-full input[type="number"],.wy-control-group .wy-form-full input[type="search"],.wy-control-group .wy-form-full input[type="tel"],.wy-control-group .wy-form-full input[type="color"],.wy-control-group .wy-form-halves input[type="text"],.wy-control-group .wy-form-halves input[type="password"],.wy-control-group .wy-form-halves input[type="email"],.wy-control-group .wy-form-halves input[type="url"],.wy-control-group .wy-form-halves input[type="date"],.wy-control-group .wy-form-halves input[type="month"],.wy-control-group .wy-form-halves input[type="time"],.wy-control-group .wy-form-halves input[type="datetime"],.wy-control-group .wy-form-halves input[type="datetime-local"],.wy-control-group .wy-form-halves input[type="week"],.wy-control-group .wy-form-halves input[type="number"],.wy-control-group .wy-form-halves input[type="search"],.wy-control-group .wy-form-halves input[type="tel"],.wy-control-group .wy-form-halves input[type="color"],.wy-control-group .wy-form-thirds input[type="text"],.wy-control-group .wy-form-thirds input[type="password"],.wy-control-group .wy-form-thirds input[type="email"],.wy-control-group .wy-form-thirds input[type="url"],.wy-control-group .wy-form-thirds input[type="date"],.wy-control-group .wy-form-thirds input[type="month"],.wy-control-group .wy-form-thirds input[type="time"],.wy-control-group .wy-form-thirds input[type="datetime"],.wy-control-group .wy-form-thirds input[type="datetime-local"],.wy-control-group .wy-form-thirds input[type="week"],.wy-control-group .wy-form-thirds input[type="number"],.wy-control-group .wy-form-thirds input[type="search"],.wy-control-group .wy-form-thirds input[type="tel"],.wy-control-group .wy-form-thirds input[type="color"]{width:100%}.wy-control-group .wy-form-full{float:left;display:block;margin-right:2.3576515979%;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.3576515979%;width:48.821174201%}.wy-control-group .wy-form-halves:last-child{margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(2n+1){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.3576515979%;width:31.7615656014%}.wy-control-group .wy-form-thirds:last-child{margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control{margin:6px 0 0 0;font-size:90%}.wy-control-no-input{display:inline-block;margin:6px 0 0 0;font-size:90%}.wy-control-group.fluid-input input[type="text"],.wy-control-group.fluid-input input[type="password"],.wy-control-group.fluid-input input[type="email"],.wy-control-group.fluid-input input[type="url"],.wy-control-group.fluid-input input[type="date"],.wy-control-group.fluid-input input[type="month"],.wy-control-group.fluid-input input[type="time"],.wy-control-group.fluid-input input[type="datetime"],.wy-control-group.fluid-input input[type="datetime-local"],.wy-control-group.fluid-input input[type="week"],.wy-control-group.fluid-input input[type="number"],.wy-control-group.fluid-input input[type="search"],.wy-control-group.fluid-input input[type="tel"],.wy-control-group.fluid-input input[type="color"]{width:100%}.wy-form-message-inline{display:inline-block;padding-left:.3em;color:#666;vertical-align:middle;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;*overflow:visible}input[type="text"],input[type="password"],input[type="email"],input[type="url"],input[type="date"],input[type="month"],input[type="time"],input[type="datetime"],input[type="datetime-local"],input[type="week"],input[type="number"],input[type="search"],input[type="tel"],input[type="color"]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type="datetime-local"]{padding:.34375em .625em}input[disabled]{cursor:default}input[type="checkbox"],input[type="radio"]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box;padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type="search"]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none}input[type="text"]:focus,input[type="password"]:focus,input[type="email"]:focus,input[type="url"]:focus,input[type="date"]:focus,input[type="month"]:focus,input[type="time"]:focus,input[type="datetime"]:focus,input[type="datetime-local"]:focus,input[type="week"]:focus,input[type="number"]:focus,input[type="search"]:focus,input[type="tel"]:focus,input[type="color"]:focus{outline:0;outline:thin dotted \9;border-color:#333}input.no-focus:focus{border-color:#ccc !important}input[type="file"]:focus,input[type="radio"]:focus,input[type="checkbox"]:focus{outline:thin dotted #333;outline:1px auto #129FEA}input[type="text"][disabled],input[type="password"][disabled],input[type="email"][disabled],input[type="url"][disabled],input[type="date"][disabled],input[type="month"][disabled],input[type="time"][disabled],input[type="datetime"][disabled],input[type="datetime-local"][disabled],input[type="week"][disabled],input[type="number"][disabled],input[type="search"][disabled],input[type="tel"][disabled],input[type="color"][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,textarea:focus:invalid,select:focus:invalid{color:#E74C3C;border:1px solid #E74C3C}input:focus:invalid:focus,textarea:focus:invalid:focus,select:focus:invalid:focus{border-color:#E74C3C}input[type="file"]:focus:invalid:focus,input[type="radio"]:focus:invalid:focus,input[type="checkbox"]:focus:invalid:focus{outline-color:#E74C3C}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}select[disabled],textarea[disabled],input[readonly],select[readonly],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type="radio"][disabled],input[type="checkbox"][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:solid 1px #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{position:absolute;content:"";display:block;left:0;top:0;width:36px;height:12px;border-radius:4px;background:#ccc;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{position:absolute;content:"";display:block;width:18px;height:18px;border-radius:4px;background:#999;left:-3px;top:-3px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27AE60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#E74C3C}.wy-control-group.wy-control-group-error input[type="text"],.wy-control-group.wy-control-group-error input[type="password"],.wy-control-group.wy-control-group-error input[type="email"],.wy-control-group.wy-control-group-error input[type="url"],.wy-control-group.wy-control-group-error input[type="date"],.wy-control-group.wy-control-group-error input[type="month"],.wy-control-group.wy-control-group-error input[type="time"],.wy-control-group.wy-control-group-error input[type="datetime"],.wy-control-group.wy-control-group-error input[type="datetime-local"],.wy-control-group.wy-control-group-error input[type="week"],.wy-control-group.wy-control-group-error input[type="number"],.wy-control-group.wy-control-group-error input[type="search"],.wy-control-group.wy-control-group-error input[type="tel"],.wy-control-group.wy-control-group-error input[type="color"]{border:solid 1px #E74C3C}.wy-control-group.wy-control-group-error textarea{border:solid 1px #E74C3C}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27AE60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#E74C3C}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#E67E22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980B9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width: 480px){.wy-form button[type="submit"]{margin:.7em 0 0}.wy-form input[type="text"],.wy-form input[type="password"],.wy-form input[type="email"],.wy-form input[type="url"],.wy-form input[type="date"],.wy-form input[type="month"],.wy-form input[type="time"],.wy-form input[type="datetime"],.wy-form input[type="datetime-local"],.wy-form input[type="week"],.wy-form input[type="number"],.wy-form input[type="search"],.wy-form input[type="tel"],.wy-form input[type="color"]{margin-bottom:.3em;display:block}.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type="password"],.wy-form input[type="email"],.wy-form input[type="url"],.wy-form input[type="date"],.wy-form input[type="month"],.wy-form input[type="time"],.wy-form input[type="datetime"],.wy-form input[type="datetime-local"],.wy-form input[type="week"],.wy-form input[type="number"],.wy-form input[type="search"],.wy-form input[type="tel"],.wy-form input[type="color"]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0 0}.wy-form .wy-help-inline,.wy-form-message-inline,.wy-form-message{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width: 768px){.tablet-hide{display:none}}@media screen and (max-width: 480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.wy-table,.rst-content table.docutils,.rst-content table.field-list{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.wy-table caption,.rst-content table.docutils caption,.rst-content table.field-list caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.wy-table td,.rst-content table.docutils td,.rst-content table.field-list td,.wy-table th,.rst-content table.docutils th,.rst-content table.field-list th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.wy-table td:first-child,.rst-content table.docutils td:first-child,.rst-content table.field-list td:first-child,.wy-table th:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list th:first-child{border-left-width:0}.wy-table thead,.rst-content table.docutils thead,.rst-content table.field-list thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.wy-table thead th,.rst-content table.docutils thead th,.rst-content table.field-list thead th{font-weight:bold;border-bottom:solid 2px #e1e4e5}.wy-table td,.rst-content table.docutils td,.rst-content table.field-list td{background-color:transparent;vertical-align:middle}.wy-table td p,.rst-content table.docutils td p,.rst-content table.field-list td p{line-height:18px}.wy-table td p:last-child,.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child{margin-bottom:0}.wy-table .wy-table-cell-min,.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min{width:1%;padding-right:0}.wy-table .wy-table-cell-min input[type=checkbox],.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox],.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:gray;font-size:90%}.wy-table-tertiary{color:gray;font-size:80%}.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td,.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td{background-color:#f3f6f6}.wy-table-backed{background-color:#f3f6f6}.wy-table-bordered-all,.rst-content table.docutils{border:1px solid #e1e4e5}.wy-table-bordered-all td,.rst-content table.docutils td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.wy-table-bordered-all tbody>tr:last-child td,.rst-content table.docutils tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px 0;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0 !important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980B9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9B59B6}html{height:100%;overflow-x:hidden}body{font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;font-weight:normal;color:#404040;min-height:100%;overflow-x:hidden;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#E67E22 !important}a.wy-text-warning:hover{color:#eb9950 !important}.wy-text-info{color:#2980B9 !important}a.wy-text-info:hover{color:#409ad5 !important}.wy-text-success{color:#27AE60 !important}a.wy-text-success:hover{color:#36d278 !important}.wy-text-danger{color:#E74C3C !important}a.wy-text-danger:hover{color:#ed7669 !important}.wy-text-neutral{color:#404040 !important}a.wy-text-neutral:hover{color:#595959 !important}h1,h2,.rst-content .toctree-wrapper p.caption,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:"Roboto Slab","ff-tisa-web-pro","Georgia",Arial,sans-serif}p{line-height:24px;margin:0;font-size:16px;margin-bottom:24px}h1{font-size:175%}h2,.rst-content .toctree-wrapper p.caption{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}code,.rst-content tt,.rst-content code{white-space:nowrap;max-width:100%;background:#fff;border:solid 1px #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace;color:#E74C3C;overflow-x:auto}code.code-large,.rst-content tt.code-large{font-size:90%}.wy-plain-list-disc,.rst-content .section ul,.rst-content .toctree-wrapper ul,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.wy-plain-list-disc li,.rst-content .section ul li,.rst-content .toctree-wrapper ul li,article ul li{list-style:disc;margin-left:24px}.wy-plain-list-disc li p:last-child,.rst-content .section ul li p:last-child,.rst-content .toctree-wrapper ul li p:last-child,article ul li p:last-child{margin-bottom:0}.wy-plain-list-disc li ul,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li ul,article ul li ul{margin-bottom:0}.wy-plain-list-disc li li,.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,article ul li li{list-style:circle}.wy-plain-list-disc li li li,.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,article ul li li li{list-style:square}.wy-plain-list-disc li ol li,.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,article ul li ol li{list-style:decimal}.wy-plain-list-decimal,.rst-content .section ol,.rst-content ol.arabic,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.wy-plain-list-decimal li,.rst-content .section ol li,.rst-content ol.arabic li,article ol li{list-style:decimal;margin-left:24px}.wy-plain-list-decimal li p:last-child,.rst-content .section ol li p:last-child,.rst-content ol.arabic li p:last-child,article ol li p:last-child{margin-bottom:0}.wy-plain-list-decimal li ul,.rst-content .section ol li ul,.rst-content ol.arabic li ul,article ol li ul{margin-bottom:0}.wy-plain-list-decimal li ul li,.rst-content .section ol li ul li,.rst-content ol.arabic li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:before,.wy-breadcrumbs:after{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs li{display:inline-block}.wy-breadcrumbs li.wy-breadcrumbs-aside{float:right}.wy-breadcrumbs li a{display:inline-block;padding:5px}.wy-breadcrumbs li a:first-child{padding-left:0}.wy-breadcrumbs li code,.wy-breadcrumbs li .rst-content tt,.rst-content .wy-breadcrumbs li tt{padding:5px;border:none;background:none}.wy-breadcrumbs li code.literal,.wy-breadcrumbs li .rst-content tt.literal,.rst-content .wy-breadcrumbs li tt.literal{color:#404040}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width: 480px){.wy-breadcrumbs-extra{display:none}.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:before,.wy-menu-horiz:after{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz ul,.wy-menu-horiz li{display:inline-block}.wy-menu-horiz li:hover{background:rgba(255,255,255,0.1)}.wy-menu-horiz li.divide-left{border-left:solid 1px #404040}.wy-menu-horiz li.divide-right{border-right:solid 1px #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{height:32px;display:inline-block;line-height:32px;padding:0 1.618em;margin-bottom:0;display:block;font-weight:bold;text-transform:uppercase;font-size:80%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:solid 1px #404040}.wy-menu-vertical li.divide-bottom{border-bottom:solid 1px #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:gray;border-right:solid 1px #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.wy-menu-vertical li code,.wy-menu-vertical li .rst-content tt,.rst-content .wy-menu-vertical li tt{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li span.toctree-expand{display:block;float:left;margin-left:-1.2em;font-size:.8em;line-height:1.6em;color:#4d4d4d}.wy-menu-vertical li.on a,.wy-menu-vertical li.current>a{color:#404040;padding:.4045em 1.618em;font-weight:bold;position:relative;background:#fcfcfc;border:none;padding-left:1.618em -4px}.wy-menu-vertical li.on a:hover,.wy-menu-vertical li.current>a:hover{background:#fcfcfc}.wy-menu-vertical li.on a:hover span.toctree-expand,.wy-menu-vertical li.current>a:hover span.toctree-expand{color:gray}.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li.current>a span.toctree-expand{display:block;font-size:.8em;line-height:1.6em;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:solid 1px #c9c9c9;border-top:solid 1px #c9c9c9}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a{color:#404040}.wy-menu-vertical li.toctree-l1.current li.toctree-l2>ul,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>ul{display:none}.wy-menu-vertical li.toctree-l1.current li.toctree-l2.current>ul,.wy-menu-vertical li.toctree-l2.current li.toctree-l3.current>ul{display:block}.wy-menu-vertical li.toctree-l2.current>a{background:#c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{display:block;background:#c9c9c9;padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l2 a:hover span.toctree-expand{color:gray}.wy-menu-vertical li.toctree-l2 span.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3{font-size:.9em}.wy-menu-vertical li.toctree-l3.current>a{background:#bdbdbd;padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{display:block;background:#bdbdbd;padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l3 a:hover span.toctree-expand{color:gray}.wy-menu-vertical li.toctree-l3 span.toctree-expand{color:#969696}.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:normal}.wy-menu-vertical a{display:inline-block;line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover span.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980B9;cursor:pointer;color:#fff}.wy-menu-vertical a:active span.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980B9;text-align:center;padding:.809em;display:block;color:#fcfcfc;margin-bottom:.809em}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em auto;height:45px;width:45px;background-color:#2980B9;padding:5px;border-radius:100%}.wy-side-nav-search>a,.wy-side-nav-search .wy-dropdown>a{color:#fcfcfc;font-size:100%;font-weight:bold;display:inline-block;padding:4px 6px;margin-bottom:.809em}.wy-side-nav-search>a:hover,.wy-side-nav-search .wy-dropdown>a:hover{background:rgba(255,255,255,0.1)}.wy-side-nav-search>a img.logo,.wy-side-nav-search .wy-dropdown>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search>a.icon img.logo,.wy-side-nav-search .wy-dropdown>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:normal;color:rgba(255,255,255,0.3)}.wy-nav .wy-menu-vertical header{color:#2980B9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980B9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980B9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:before,.wy-nav-top:after{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:bold}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980B9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,0.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:gray}footer p{margin-bottom:12px}footer span.commit code,footer span.commit .rst-content tt,.rst-content footer span.commit tt{padding:0px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace;font-size:1em;background:none;border:none;color:gray}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:before,.rst-footer-buttons:after{width:100%}.rst-footer-buttons:before,.rst-footer-buttons:after{display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:before,.rst-breadcrumbs-buttons:after{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:solid 1px #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:solid 1px #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:gray;font-size:90%}@media screen and (max-width: 768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-side-scroll{width:auto}.wy-side-nav-search{width:auto}.wy-menu.wy-menu-vertical{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width: 1100px){.wy-nav-content-wrap{background:rgba(0,0,0,0.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,footer,.wy-nav-side{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;z-index:400}.rst-versions a{color:#2980B9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27AE60;*zoom:1}.rst-versions .rst-current-version:before,.rst-versions .rst-current-version:after{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .wy-menu-vertical li span.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version span.toctree-expand,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content p.caption .headerlink,.rst-content p.caption .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .icon{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#E74C3C;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#F1C40F;color:#000}.rst-versions.shift-up{height:auto;max-height:100%}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:gray;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:solid 1px #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px}.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge .rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width: 768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content img{max-width:100%;height:auto}.rst-content div.figure{margin-bottom:24px}.rst-content div.figure p.caption{font-style:italic}.rst-content div.figure p:last-child.caption{margin-bottom:0px}.rst-content div.figure.align-center{text-align:center}.rst-content .section>img,.rst-content .section>a>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px 12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace;display:block;overflow:auto}.rst-content pre.literal-block,.rst-content div[class^='highlight']{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px 0}.rst-content pre.literal-block div[class^='highlight'],.rst-content div[class^='highlight'] div[class^='highlight']{padding:0px;border:none;margin:0}.rst-content div[class^='highlight'] td.code{width:100%}.rst-content .linenodiv pre{border-right:solid 1px #e6e9ea;margin:0;padding:12px 12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^='highlight'] pre{white-space:pre;margin:0;padding:12px 12px;display:block;overflow:auto}.rst-content div[class^='highlight'] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content pre.literal-block,.rst-content div[class^='highlight'] pre,.rst-content .linenodiv pre{font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace;font-size:12px;line-height:1.4}@media print{.rst-content .codeblock,.rst-content div[class^='highlight'],.rst-content div[class^='highlight'] pre{white-space:pre-wrap}}.rst-content .note .last,.rst-content .attention .last,.rst-content .caution .last,.rst-content .danger .last,.rst-content .error .last,.rst-content .hint .last,.rst-content .important .last,.rst-content .tip .last,.rst-content .warning .last,.rst-content .seealso .last,.rst-content .admonition-todo .last,.rst-content .admonition .last{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,0.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent !important;border-color:rgba(0,0,0,0.1) !important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha li{list-style:upper-alpha}.rst-content .section ol p,.rst-content .section ul p{margin-bottom:12px}.rst-content .section ol p:last-child,.rst-content .section ul p:last-child{margin-bottom:24px}.rst-content .line-block{margin-left:0px;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0px}.rst-content .topic-title{font-weight:bold;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0px 0px 24px 24px}.rst-content .align-left{float:left;margin:0px 24px 24px 0px}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content .toctree-wrapper p.caption .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content dl dt .headerlink,.rst-content p.caption .headerlink,.rst-content table>caption .headerlink{visibility:hidden;font-size:14px}.rst-content h1 .headerlink:after,.rst-content h2 .headerlink:after,.rst-content .toctree-wrapper p.caption .headerlink:after,.rst-content h3 .headerlink:after,.rst-content h4 .headerlink:after,.rst-content h5 .headerlink:after,.rst-content h6 .headerlink:after,.rst-content dl dt .headerlink:after,.rst-content p.caption .headerlink:after,.rst-content table>caption .headerlink:after{content:"";font-family:FontAwesome}.rst-content h1:hover .headerlink:after,.rst-content h2:hover .headerlink:after,.rst-content .toctree-wrapper p.caption:hover .headerlink:after,.rst-content h3:hover .headerlink:after,.rst-content h4:hover .headerlink:after,.rst-content h5:hover .headerlink:after,.rst-content h6:hover .headerlink:after,.rst-content dl dt:hover .headerlink:after,.rst-content p.caption:hover .headerlink:after,.rst-content table>caption:hover .headerlink:after{visibility:visible}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:solid 1px #e1e4e5}.rst-content .sidebar p,.rst-content .sidebar ul,.rst-content .sidebar dl{font-size:90%}.rst-content .sidebar .last{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:"Roboto Slab","ff-tisa-web-pro","Georgia",Arial,sans-serif;font-weight:bold;background:#e1e4e5;padding:6px 12px;margin:-24px;margin-bottom:24px;font-size:100%}.rst-content .highlighted{background:#F1C40F;display:inline-block;font-weight:bold;padding:0 6px}.rst-content .footnote-reference,.rst-content .citation-reference{vertical-align:baseline;position:relative;top:-0.4em;line-height:0;font-size:90%}.rst-content table.docutils.citation,.rst-content table.docutils.footnote{background:none;border:none;color:gray}.rst-content table.docutils.citation td,.rst-content table.docutils.citation tr,.rst-content table.docutils.footnote td,.rst-content table.docutils.footnote tr{border:none;background-color:transparent !important;white-space:normal}.rst-content table.docutils.citation td.label,.rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}.rst-content table.docutils.citation tt,.rst-content table.docutils.citation code,.rst-content table.docutils.footnote tt,.rst-content table.docutils.footnote code{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}.rst-content table.docutils td .last,.rst-content table.docutils td .last :last-child{margin-bottom:0}.rst-content table.field-list{border:none}.rst-content table.field-list td{border:none}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content tt,.rst-content tt,.rst-content code{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace;padding:2px 5px}.rst-content tt big,.rst-content tt em,.rst-content tt big,.rst-content code big,.rst-content tt em,.rst-content code em{font-size:100% !important;line-height:normal}.rst-content tt.literal,.rst-content tt.literal,.rst-content code.literal{color:#E74C3C}.rst-content tt.xref,a .rst-content tt,.rst-content tt.xref,.rst-content code.xref,a .rst-content tt,a .rst-content code{font-weight:bold;color:#404040}.rst-content pre,.rst-content kbd,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace}.rst-content a tt,.rst-content a tt,.rst-content a code{color:#2980B9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:bold;margin-bottom:12px}.rst-content dl p,.rst-content dl table,.rst-content dl ul,.rst-content dl ol{margin-bottom:12px !important}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl:not(.docutils){margin-bottom:24px}.rst-content dl:not(.docutils) dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980B9;border-top:solid 3px #6ab0de;padding:6px;position:relative}.rst-content dl:not(.docutils) dt:before{color:#6ab0de}.rst-content dl:not(.docutils) dt .headerlink{color:#404040;font-size:100% !important}.rst-content dl:not(.docutils) dl dt{margin-bottom:6px;border:none;border-left:solid 3px #ccc;background:#f0f0f0;color:#555}.rst-content dl:not(.docutils) dl dt .headerlink{color:#404040;font-size:100% !important}.rst-content dl:not(.docutils) dt:first-child{margin-top:0}.rst-content dl:not(.docutils) tt,.rst-content dl:not(.docutils) tt,.rst-content dl:not(.docutils) code{font-weight:bold}.rst-content dl:not(.docutils) tt.descname,.rst-content dl:not(.docutils) tt.descclassname,.rst-content dl:not(.docutils) tt.descname,.rst-content dl:not(.docutils) code.descname,.rst-content dl:not(.docutils) tt.descclassname,.rst-content dl:not(.docutils) code.descclassname{background-color:transparent;border:none;padding:0;font-size:100% !important}.rst-content dl:not(.docutils) tt.descname,.rst-content dl:not(.docutils) tt.descname,.rst-content dl:not(.docutils) code.descname{font-weight:bold}.rst-content dl:not(.docutils) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:bold}.rst-content dl:not(.docutils) .property{display:inline-block;padding-right:8px}.rst-content .viewcode-link,.rst-content .viewcode-back{display:inline-block;color:#27AE60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:bold}.rst-content tt.download,.rst-content code.download{background:inherit;padding:inherit;font-weight:normal;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content tt.download span:first-child,.rst-content code.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content tt.download span:first-child:before,.rst-content code.download span:first-child:before{margin-right:4px}.rst-content .guilabel{border:1px solid #7fbbe3;background:#e7f2fa;font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .versionmodified{font-style:italic}@media screen and (max-width: 480px){.rst-content .sidebar{width:100%}}span[id*='MathJax-Span']{color:#404040}.math{text-align:center}@font-face{font-family:"Lato";src:url("../fonts/Lato/lato-regular.eot");src:url("../fonts/Lato/lato-regular.eot?#iefix") format("embedded-opentype"),url("../fonts/Lato/lato-regular.woff2") format("woff2"),url("../fonts/Lato/lato-regular.woff") format("woff"),url("../fonts/Lato/lato-regular.ttf") format("truetype");font-weight:400;font-style:normal}@font-face{font-family:"Lato";src:url("../fonts/Lato/lato-bold.eot");src:url("../fonts/Lato/lato-bold.eot?#iefix") format("embedded-opentype"),url("../fonts/Lato/lato-bold.woff2") format("woff2"),url("../fonts/Lato/lato-bold.woff") format("woff"),url("../fonts/Lato/lato-bold.ttf") format("truetype");font-weight:700;font-style:normal}@font-face{font-family:"Lato";src:url("../fonts/Lato/lato-bolditalic.eot");src:url("../fonts/Lato/lato-bolditalic.eot?#iefix") format("embedded-opentype"),url("../fonts/Lato/lato-bolditalic.woff2") format("woff2"),url("../fonts/Lato/lato-bolditalic.woff") format("woff"),url("../fonts/Lato/lato-bolditalic.ttf") format("truetype");font-weight:700;font-style:italic}@font-face{font-family:"Lato";src:url("../fonts/Lato/lato-italic.eot");src:url("../fonts/Lato/lato-italic.eot?#iefix") format("embedded-opentype"),url("../fonts/Lato/lato-italic.woff2") format("woff2"),url("../fonts/Lato/lato-italic.woff") format("woff"),url("../fonts/Lato/lato-italic.ttf") format("truetype");font-weight:400;font-style:italic}@font-face{font-family:"Roboto Slab";font-style:normal;font-weight:400;src:url("../fonts/RobotoSlab/roboto-slab.eot");src:url("../fonts/RobotoSlab/roboto-slab-v7-regular.eot?#iefix") format("embedded-opentype"),url("../fonts/RobotoSlab/roboto-slab-v7-regular.woff2") format("woff2"),url("../fonts/RobotoSlab/roboto-slab-v7-regular.woff") format("woff"),url("../fonts/RobotoSlab/roboto-slab-v7-regular.ttf") format("truetype")}@font-face{font-family:"Roboto Slab";font-style:normal;font-weight:700;src:url("../fonts/RobotoSlab/roboto-slab-v7-bold.eot");src:url("../fonts/RobotoSlab/roboto-slab-v7-bold.eot?#iefix") format("embedded-opentype"),url("../fonts/RobotoSlab/roboto-slab-v7-bold.woff2") format("woff2"),url("../fonts/RobotoSlab/roboto-slab-v7-bold.woff") format("woff"),url("../fonts/RobotoSlab/roboto-slab-v7-bold.ttf") format("truetype")} diff --git a/nsx/nsx/_static/doctools.js b/nsx/nsx/_static/doctools.js new file mode 100644 index 00000000..ffadbec1 --- /dev/null +++ b/nsx/nsx/_static/doctools.js @@ -0,0 +1,315 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for all documentation. + * + * :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/** + * select a different prefix for underscore + */ +$u = _.noConflict(); + +/** + * make the code below compatible with browsers without + * an installed firebug like debugger +if (!window.console || !console.firebug) { + var names = ["log", "debug", "info", "warn", "error", "assert", "dir", + "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", + "profile", "profileEnd"]; + window.console = {}; + for (var i = 0; i < names.length; ++i) + window.console[names[i]] = function() {}; +} + */ + +/** + * small helper function to urldecode strings + */ +jQuery.urldecode = function(x) { + return decodeURIComponent(x).replace(/\+/g, ' '); +}; + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s === 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node, addItems) { + if (node.nodeType === 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && + !jQuery(node.parentNode).hasClass(className) && + !jQuery(node.parentNode).hasClass("nohighlight")) { + var span; + var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.className = className; + } + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + if (isInSVG) { + var bbox = span.getBBox(); + var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute('class', className); + var parentOfText = node.parentNode.parentNode; + addItems.push({ + "parent": node.parentNode, + "target": rect}); + } + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this, addItems); + }); + } + } + var addItems = []; + var result = this.each(function() { + highlight(this, addItems); + }); + for (var i = 0; i < addItems.length; ++i) { + jQuery(addItems[i].parent).before(addItems[i].target); + } + return result; +}; + +/* + * backward compatibility for jQuery.browser + * This will be supported until firefox bug is fixed. + */ +if (!jQuery.browser) { + jQuery.uaMatch = function(ua) { + ua = ua.toLowerCase(); + + var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || + /(webkit)[ \/]([\w.]+)/.exec(ua) || + /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || + /(msie) ([\w.]+)/.exec(ua) || + ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || + []; + + return { + browser: match[ 1 ] || "", + version: match[ 2 ] || "0" + }; + }; + jQuery.browser = {}; + jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; +} + +/** + * Small JavaScript module for the documentation. + */ +var Documentation = { + + init : function() { + this.fixFirefoxAnchorBug(); + this.highlightSearchWords(); + this.initIndexTable(); + if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) { + this.initOnKeyListeners(); + } + }, + + /** + * i18n support + */ + TRANSLATIONS : {}, + PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; }, + LOCALE : 'unknown', + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext : function(string) { + var translated = Documentation.TRANSLATIONS[string]; + if (typeof translated === 'undefined') + return string; + return (typeof translated === 'string') ? translated : translated[0]; + }, + + ngettext : function(singular, plural, n) { + var translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated === 'undefined') + return (n == 1) ? singular : plural; + return translated[Documentation.PLURALEXPR(n)]; + }, + + addTranslations : function(catalog) { + for (var key in catalog.messages) + this.TRANSLATIONS[key] = catalog.messages[key]; + this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); + this.LOCALE = catalog.locale; + }, + + /** + * add context elements like header anchor links + */ + addContextElements : function() { + $('div[id] > :header:first').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this headline')). + appendTo(this); + }); + $('dt[id]').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this definition')). + appendTo(this); + }); + }, + + /** + * workaround a firefox stupidity + * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075 + */ + fixFirefoxAnchorBug : function() { + if (document.location.hash && $.browser.mozilla) + window.setTimeout(function() { + document.location.href += ''; + }, 10); + }, + + /** + * highlight the search words provided in the url in the text + */ + highlightSearchWords : function() { + var params = $.getQueryParameters(); + var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; + if (terms.length) { + var body = $('div.body'); + if (!body.length) { + body = $('body'); + } + window.setTimeout(function() { + $.each(terms, function() { + body.highlightText(this.toLowerCase(), 'highlighted'); + }); + }, 10); + $('

' + _('Hide Search Matches') + '

') + .appendTo($('#searchbox')); + } + }, + + /** + * init the domain index toggle buttons + */ + initIndexTable : function() { + var togglers = $('img.toggler').click(function() { + var src = $(this).attr('src'); + var idnum = $(this).attr('id').substr(7); + $('tr.cg-' + idnum).toggle(); + if (src.substr(-9) === 'minus.png') + $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); + else + $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); + }).css('display', ''); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { + togglers.click(); + } + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords : function() { + $('#searchbox .highlight-link').fadeOut(300); + $('span.highlighted').removeClass('highlighted'); + }, + + /** + * make the url absolute + */ + makeURL : function(relativeURL) { + return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; + }, + + /** + * get the current relative url + */ + getCurrentURL : function() { + var path = document.location.pathname; + var parts = path.split(/\//); + $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { + if (this === '..') + parts.pop(); + }); + var url = parts.join('/'); + return path.substring(url.lastIndexOf('/') + 1, path.length - 1); + }, + + initOnKeyListeners: function() { + $(document).keyup(function(event) { + var activeElementType = document.activeElement.tagName; + // don't navigate when in search box or textarea + if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT') { + switch (event.keyCode) { + case 37: // left + var prevHref = $('link[rel="prev"]').prop('href'); + if (prevHref) { + window.location.href = prevHref; + return false; + } + case 39: // right + var nextHref = $('link[rel="next"]').prop('href'); + if (nextHref) { + window.location.href = nextHref; + return false; + } + } + } + }); + } +}; + +// quick alias for translations +_ = Documentation.gettext; + +$(document).ready(function() { + Documentation.init(); +}); diff --git a/nsx/nsx/_static/documentation_options.js b/nsx/nsx/_static/documentation_options.js new file mode 100644 index 00000000..1d8839f6 --- /dev/null +++ b/nsx/nsx/_static/documentation_options.js @@ -0,0 +1,296 @@ +var DOCUMENTATION_OPTIONS = { + URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), + VERSION: '2.3.0.0.1', + LANGUAGE: 'en', + COLLAPSE_INDEX: false, + FILE_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false, + SEARCH_LANGUAGE_STOP_WORDS: ["a","and","are","as","at","be","but","by","for","if","in","into","is","it","near","no","not","of","on","or","such","that","the","their","then","there","these","they","this","to","was","will","with"] +}; + + + +/* Non-minified version JS is _stemmer.js if file is provided */ +/** + * Porter Stemmer + */ +var Stemmer = function() { + + var step2list = { + ational: 'ate', + tional: 'tion', + enci: 'ence', + anci: 'ance', + izer: 'ize', + bli: 'ble', + alli: 'al', + entli: 'ent', + eli: 'e', + ousli: 'ous', + ization: 'ize', + ation: 'ate', + ator: 'ate', + alism: 'al', + iveness: 'ive', + fulness: 'ful', + ousness: 'ous', + aliti: 'al', + iviti: 'ive', + biliti: 'ble', + logi: 'log' + }; + + var step3list = { + icate: 'ic', + ative: '', + alize: 'al', + iciti: 'ic', + ical: 'ic', + ful: '', + ness: '' + }; + + var c = "[^aeiou]"; // consonant + var v = "[aeiouy]"; // vowel + var C = c + "[^aeiouy]*"; // consonant sequence + var V = v + "[aeiou]*"; // vowel sequence + + var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0 + var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 + var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 + var s_v = "^(" + C + ")?" + v; // vowel in stem + + this.stemWord = function (w) { + var stem; + var suffix; + var firstch; + var origword = w; + + if (w.length < 3) + return w; + + var re; + var re2; + var re3; + var re4; + + firstch = w.substr(0,1); + if (firstch == "y") + w = firstch.toUpperCase() + w.substr(1); + + // Step 1a + re = /^(.+?)(ss|i)es$/; + re2 = /^(.+?)([^s])s$/; + + if (re.test(w)) + w = w.replace(re,"$1$2"); + else if (re2.test(w)) + w = w.replace(re2,"$1$2"); + + // Step 1b + re = /^(.+?)eed$/; + re2 = /^(.+?)(ed|ing)$/; + if (re.test(w)) { + var fp = re.exec(w); + re = new RegExp(mgr0); + if (re.test(fp[1])) { + re = /.$/; + w = w.replace(re,""); + } + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1]; + re2 = new RegExp(s_v); + if (re2.test(stem)) { + w = stem; + re2 = /(at|bl|iz)$/; + re3 = new RegExp("([^aeiouylsz])\\1$"); + re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re2.test(w)) + w = w + "e"; + else if (re3.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + else if (re4.test(w)) + w = w + "e"; + } + } + + // Step 1c + re = /^(.+?)y$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(s_v); + if (re.test(stem)) + w = stem + "i"; + } + + // Step 2 + re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step2list[suffix]; + } + + // Step 3 + re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step3list[suffix]; + } + + // Step 4 + re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; + re2 = /^(.+?)(s|t)(ion)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + if (re.test(stem)) + w = stem; + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1] + fp[2]; + re2 = new RegExp(mgr1); + if (re2.test(stem)) + w = stem; + } + + // Step 5 + re = /^(.+?)e$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + re2 = new RegExp(meq1); + re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) + w = stem; + } + re = /ll$/; + re2 = new RegExp(mgr1); + if (re.test(w) && re2.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + + // and turn initial Y back to y + if (firstch == "y") + w = firstch.toLowerCase() + w.substr(1); + return w; + } +} + + + + + +var splitChars = (function() { + var result = {}; + var singles = [96, 180, 187, 191, 215, 247, 749, 885, 903, 907, 909, 930, 1014, 1648, + 1748, 1809, 2416, 2473, 2481, 2526, 2601, 2609, 2612, 2615, 2653, 2702, + 2706, 2729, 2737, 2740, 2857, 2865, 2868, 2910, 2928, 2948, 2961, 2971, + 2973, 3085, 3089, 3113, 3124, 3213, 3217, 3241, 3252, 3295, 3341, 3345, + 3369, 3506, 3516, 3633, 3715, 3721, 3736, 3744, 3748, 3750, 3756, 3761, + 3781, 3912, 4239, 4347, 4681, 4695, 4697, 4745, 4785, 4799, 4801, 4823, + 4881, 5760, 5901, 5997, 6313, 7405, 8024, 8026, 8028, 8030, 8117, 8125, + 8133, 8181, 8468, 8485, 8487, 8489, 8494, 8527, 11311, 11359, 11687, 11695, + 11703, 11711, 11719, 11727, 11735, 12448, 12539, 43010, 43014, 43019, 43587, + 43696, 43713, 64286, 64297, 64311, 64317, 64319, 64322, 64325, 65141]; + var i, j, start, end; + for (i = 0; i < singles.length; i++) { + result[singles[i]] = true; + } + var ranges = [[0, 47], [58, 64], [91, 94], [123, 169], [171, 177], [182, 184], [706, 709], + [722, 735], [741, 747], [751, 879], [888, 889], [894, 901], [1154, 1161], + [1318, 1328], [1367, 1368], [1370, 1376], [1416, 1487], [1515, 1519], [1523, 1568], + [1611, 1631], [1642, 1645], [1750, 1764], [1767, 1773], [1789, 1790], [1792, 1807], + [1840, 1868], [1958, 1968], [1970, 1983], [2027, 2035], [2038, 2041], [2043, 2047], + [2070, 2073], [2075, 2083], [2085, 2087], [2089, 2307], [2362, 2364], [2366, 2383], + [2385, 2391], [2402, 2405], [2419, 2424], [2432, 2436], [2445, 2446], [2449, 2450], + [2483, 2485], [2490, 2492], [2494, 2509], [2511, 2523], [2530, 2533], [2546, 2547], + [2554, 2564], [2571, 2574], [2577, 2578], [2618, 2648], [2655, 2661], [2672, 2673], + [2677, 2692], [2746, 2748], [2750, 2767], [2769, 2783], [2786, 2789], [2800, 2820], + [2829, 2830], [2833, 2834], [2874, 2876], [2878, 2907], [2914, 2917], [2930, 2946], + [2955, 2957], [2966, 2968], [2976, 2978], [2981, 2983], [2987, 2989], [3002, 3023], + [3025, 3045], [3059, 3076], [3130, 3132], [3134, 3159], [3162, 3167], [3170, 3173], + [3184, 3191], [3199, 3204], [3258, 3260], [3262, 3293], [3298, 3301], [3312, 3332], + [3386, 3388], [3390, 3423], [3426, 3429], [3446, 3449], [3456, 3460], [3479, 3481], + [3518, 3519], [3527, 3584], [3636, 3647], [3655, 3663], [3674, 3712], [3717, 3718], + [3723, 3724], [3726, 3731], [3752, 3753], [3764, 3772], [3774, 3775], [3783, 3791], + [3802, 3803], [3806, 3839], [3841, 3871], [3892, 3903], [3949, 3975], [3980, 4095], + [4139, 4158], [4170, 4175], [4182, 4185], [4190, 4192], [4194, 4196], [4199, 4205], + [4209, 4212], [4226, 4237], [4250, 4255], [4294, 4303], [4349, 4351], [4686, 4687], + [4702, 4703], [4750, 4751], [4790, 4791], [4806, 4807], [4886, 4887], [4955, 4968], + [4989, 4991], [5008, 5023], [5109, 5120], [5741, 5742], [5787, 5791], [5867, 5869], + [5873, 5887], [5906, 5919], [5938, 5951], [5970, 5983], [6001, 6015], [6068, 6102], + [6104, 6107], [6109, 6111], [6122, 6127], [6138, 6159], [6170, 6175], [6264, 6271], + [6315, 6319], [6390, 6399], [6429, 6469], [6510, 6511], [6517, 6527], [6572, 6592], + [6600, 6607], [6619, 6655], [6679, 6687], [6741, 6783], [6794, 6799], [6810, 6822], + [6824, 6916], [6964, 6980], [6988, 6991], [7002, 7042], [7073, 7085], [7098, 7167], + [7204, 7231], [7242, 7244], [7294, 7400], [7410, 7423], [7616, 7679], [7958, 7959], + [7966, 7967], [8006, 8007], [8014, 8015], [8062, 8063], [8127, 8129], [8141, 8143], + [8148, 8149], [8156, 8159], [8173, 8177], [8189, 8303], [8306, 8307], [8314, 8318], + [8330, 8335], [8341, 8449], [8451, 8454], [8456, 8457], [8470, 8472], [8478, 8483], + [8506, 8507], [8512, 8516], [8522, 8525], [8586, 9311], [9372, 9449], [9472, 10101], + [10132, 11263], [11493, 11498], [11503, 11516], [11518, 11519], [11558, 11567], + [11622, 11630], [11632, 11647], [11671, 11679], [11743, 11822], [11824, 12292], + [12296, 12320], [12330, 12336], [12342, 12343], [12349, 12352], [12439, 12444], + [12544, 12548], [12590, 12592], [12687, 12689], [12694, 12703], [12728, 12783], + [12800, 12831], [12842, 12880], [12896, 12927], [12938, 12976], [12992, 13311], + [19894, 19967], [40908, 40959], [42125, 42191], [42238, 42239], [42509, 42511], + [42540, 42559], [42592, 42593], [42607, 42622], [42648, 42655], [42736, 42774], + [42784, 42785], [42889, 42890], [42893, 43002], [43043, 43055], [43062, 43071], + [43124, 43137], [43188, 43215], [43226, 43249], [43256, 43258], [43260, 43263], + [43302, 43311], [43335, 43359], [43389, 43395], [43443, 43470], [43482, 43519], + [43561, 43583], [43596, 43599], [43610, 43615], [43639, 43641], [43643, 43647], + [43698, 43700], [43703, 43704], [43710, 43711], [43715, 43738], [43742, 43967], + [44003, 44015], [44026, 44031], [55204, 55215], [55239, 55242], [55292, 55295], + [57344, 63743], [64046, 64047], [64110, 64111], [64218, 64255], [64263, 64274], + [64280, 64284], [64434, 64466], [64830, 64847], [64912, 64913], [64968, 65007], + [65020, 65135], [65277, 65295], [65306, 65312], [65339, 65344], [65371, 65381], + [65471, 65473], [65480, 65481], [65488, 65489], [65496, 65497]]; + for (i = 0; i < ranges.length; i++) { + start = ranges[i][0]; + end = ranges[i][1]; + for (j = start; j <= end; j++) { + result[j] = true; + } + } + return result; +})(); + +function splitQuery(query) { + var result = []; + var start = -1; + for (var i = 0; i < query.length; i++) { + if (splitChars[query.charCodeAt(i)]) { + if (start !== -1) { + result.push(query.slice(start, i)); + start = -1; + } + } else if (start === -1) { + start = i; + } + } + if (start !== -1) { + result.push(query.slice(start)); + } + return result; +} + + diff --git a/nsx/nsx/_static/down-pressed.png b/nsx/nsx/_static/down-pressed.png new file mode 100644 index 00000000..5756c8ca Binary files /dev/null and b/nsx/nsx/_static/down-pressed.png differ diff --git a/nsx/nsx/_static/down.png b/nsx/nsx/_static/down.png new file mode 100644 index 00000000..1b3bdad2 Binary files /dev/null and b/nsx/nsx/_static/down.png differ diff --git a/nsx/nsx/_static/file.png b/nsx/nsx/_static/file.png new file mode 100644 index 00000000..a858a410 Binary files /dev/null and b/nsx/nsx/_static/file.png differ diff --git a/nsx/nsx/_static/fonts/Inconsolata-Bold.ttf b/nsx/nsx/_static/fonts/Inconsolata-Bold.ttf new file mode 100644 index 00000000..809c1f58 Binary files /dev/null and b/nsx/nsx/_static/fonts/Inconsolata-Bold.ttf differ diff --git a/nsx/nsx/_static/fonts/Inconsolata-Regular.ttf b/nsx/nsx/_static/fonts/Inconsolata-Regular.ttf new file mode 100644 index 00000000..fc981ce7 Binary files /dev/null and b/nsx/nsx/_static/fonts/Inconsolata-Regular.ttf differ diff --git a/nsx/nsx/_static/fonts/Inconsolata.ttf b/nsx/nsx/_static/fonts/Inconsolata.ttf new file mode 100644 index 00000000..4b8a36d2 Binary files /dev/null and b/nsx/nsx/_static/fonts/Inconsolata.ttf differ diff --git a/nsx/nsx/_static/fonts/Lato-Bold.ttf b/nsx/nsx/_static/fonts/Lato-Bold.ttf new file mode 100644 index 00000000..1d23c706 Binary files /dev/null and b/nsx/nsx/_static/fonts/Lato-Bold.ttf differ diff --git a/nsx/nsx/_static/fonts/Lato-Regular.ttf b/nsx/nsx/_static/fonts/Lato-Regular.ttf new file mode 100644 index 00000000..0f3d0f83 Binary files /dev/null and b/nsx/nsx/_static/fonts/Lato-Regular.ttf differ diff --git a/nsx/nsx/_static/fonts/Lato/lato-bold.eot b/nsx/nsx/_static/fonts/Lato/lato-bold.eot new file mode 100644 index 00000000..3361183a Binary files /dev/null and b/nsx/nsx/_static/fonts/Lato/lato-bold.eot differ diff --git a/nsx/nsx/_static/fonts/Lato/lato-bold.ttf b/nsx/nsx/_static/fonts/Lato/lato-bold.ttf new file mode 100644 index 00000000..29f691d5 Binary files /dev/null and b/nsx/nsx/_static/fonts/Lato/lato-bold.ttf differ diff --git a/nsx/nsx/_static/fonts/Lato/lato-bold.woff b/nsx/nsx/_static/fonts/Lato/lato-bold.woff new file mode 100644 index 00000000..c6dff51f Binary files /dev/null and b/nsx/nsx/_static/fonts/Lato/lato-bold.woff differ diff --git a/nsx/nsx/_static/fonts/Lato/lato-bold.woff2 b/nsx/nsx/_static/fonts/Lato/lato-bold.woff2 new file mode 100644 index 00000000..bb195043 Binary files /dev/null and b/nsx/nsx/_static/fonts/Lato/lato-bold.woff2 differ diff --git a/nsx/nsx/_static/fonts/Lato/lato-bolditalic.eot b/nsx/nsx/_static/fonts/Lato/lato-bolditalic.eot new file mode 100644 index 00000000..3d415493 Binary files /dev/null and b/nsx/nsx/_static/fonts/Lato/lato-bolditalic.eot differ diff --git a/nsx/nsx/_static/fonts/Lato/lato-bolditalic.ttf b/nsx/nsx/_static/fonts/Lato/lato-bolditalic.ttf new file mode 100644 index 00000000..f402040b Binary files /dev/null and b/nsx/nsx/_static/fonts/Lato/lato-bolditalic.ttf differ diff --git a/nsx/nsx/_static/fonts/Lato/lato-bolditalic.woff b/nsx/nsx/_static/fonts/Lato/lato-bolditalic.woff new file mode 100644 index 00000000..88ad05b9 Binary files /dev/null and b/nsx/nsx/_static/fonts/Lato/lato-bolditalic.woff differ diff --git a/nsx/nsx/_static/fonts/Lato/lato-bolditalic.woff2 b/nsx/nsx/_static/fonts/Lato/lato-bolditalic.woff2 new file mode 100644 index 00000000..c4e3d804 Binary files /dev/null and b/nsx/nsx/_static/fonts/Lato/lato-bolditalic.woff2 differ diff --git a/nsx/nsx/_static/fonts/Lato/lato-italic.eot b/nsx/nsx/_static/fonts/Lato/lato-italic.eot new file mode 100644 index 00000000..3f826421 Binary files /dev/null and b/nsx/nsx/_static/fonts/Lato/lato-italic.eot differ diff --git a/nsx/nsx/_static/fonts/Lato/lato-italic.ttf b/nsx/nsx/_static/fonts/Lato/lato-italic.ttf new file mode 100644 index 00000000..b4bfc9b2 Binary files /dev/null and b/nsx/nsx/_static/fonts/Lato/lato-italic.ttf differ diff --git a/nsx/nsx/_static/fonts/Lato/lato-italic.woff b/nsx/nsx/_static/fonts/Lato/lato-italic.woff new file mode 100644 index 00000000..76114bc0 Binary files /dev/null and b/nsx/nsx/_static/fonts/Lato/lato-italic.woff differ diff --git a/nsx/nsx/_static/fonts/Lato/lato-italic.woff2 b/nsx/nsx/_static/fonts/Lato/lato-italic.woff2 new file mode 100644 index 00000000..3404f37e Binary files /dev/null and b/nsx/nsx/_static/fonts/Lato/lato-italic.woff2 differ diff --git a/nsx/nsx/_static/fonts/Lato/lato-regular.eot b/nsx/nsx/_static/fonts/Lato/lato-regular.eot new file mode 100644 index 00000000..11e3f2a5 Binary files /dev/null and b/nsx/nsx/_static/fonts/Lato/lato-regular.eot differ diff --git a/nsx/nsx/_static/fonts/Lato/lato-regular.ttf b/nsx/nsx/_static/fonts/Lato/lato-regular.ttf new file mode 100644 index 00000000..74decd9e Binary files /dev/null and b/nsx/nsx/_static/fonts/Lato/lato-regular.ttf differ diff --git a/nsx/nsx/_static/fonts/Lato/lato-regular.woff b/nsx/nsx/_static/fonts/Lato/lato-regular.woff new file mode 100644 index 00000000..ae1307ff Binary files /dev/null and b/nsx/nsx/_static/fonts/Lato/lato-regular.woff differ diff --git a/nsx/nsx/_static/fonts/Lato/lato-regular.woff2 b/nsx/nsx/_static/fonts/Lato/lato-regular.woff2 new file mode 100644 index 00000000..3bf98433 Binary files /dev/null and b/nsx/nsx/_static/fonts/Lato/lato-regular.woff2 differ diff --git a/nsx/nsx/_static/fonts/RobotoSlab-Bold.ttf b/nsx/nsx/_static/fonts/RobotoSlab-Bold.ttf new file mode 100644 index 00000000..df5d1df2 Binary files /dev/null and b/nsx/nsx/_static/fonts/RobotoSlab-Bold.ttf differ diff --git a/nsx/nsx/_static/fonts/RobotoSlab-Regular.ttf b/nsx/nsx/_static/fonts/RobotoSlab-Regular.ttf new file mode 100644 index 00000000..eb52a790 Binary files /dev/null and b/nsx/nsx/_static/fonts/RobotoSlab-Regular.ttf differ diff --git a/nsx/nsx/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot b/nsx/nsx/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot new file mode 100644 index 00000000..79dc8efe Binary files /dev/null and b/nsx/nsx/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot differ diff --git a/nsx/nsx/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf b/nsx/nsx/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf new file mode 100644 index 00000000..df5d1df2 Binary files /dev/null and b/nsx/nsx/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf differ diff --git a/nsx/nsx/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff b/nsx/nsx/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff new file mode 100644 index 00000000..6cb60000 Binary files /dev/null and b/nsx/nsx/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff differ diff --git a/nsx/nsx/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 b/nsx/nsx/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 new file mode 100644 index 00000000..7059e231 Binary files /dev/null and b/nsx/nsx/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 differ diff --git a/nsx/nsx/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot b/nsx/nsx/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot new file mode 100644 index 00000000..2f7ca78a Binary files /dev/null and b/nsx/nsx/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot differ diff --git a/nsx/nsx/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf b/nsx/nsx/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf new file mode 100644 index 00000000..eb52a790 Binary files /dev/null and b/nsx/nsx/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf differ diff --git a/nsx/nsx/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff b/nsx/nsx/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff new file mode 100644 index 00000000..f815f63f Binary files /dev/null and b/nsx/nsx/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff differ diff --git a/nsx/nsx/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 b/nsx/nsx/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 new file mode 100644 index 00000000..f2c76e5b Binary files /dev/null and b/nsx/nsx/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 differ diff --git a/nsx/nsx/_static/fonts/fontawesome-webfont.eot b/nsx/nsx/_static/fonts/fontawesome-webfont.eot new file mode 100644 index 00000000..e9f60ca9 Binary files /dev/null and b/nsx/nsx/_static/fonts/fontawesome-webfont.eot differ diff --git a/nsx/nsx/_static/fonts/fontawesome-webfont.svg b/nsx/nsx/_static/fonts/fontawesome-webfont.svg new file mode 100644 index 00000000..855c845e --- /dev/null +++ b/nsx/nsx/_static/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/nsx/nsx/_static/fonts/fontawesome-webfont.ttf b/nsx/nsx/_static/fonts/fontawesome-webfont.ttf new file mode 100644 index 00000000..35acda2f Binary files /dev/null and b/nsx/nsx/_static/fonts/fontawesome-webfont.ttf differ diff --git a/nsx/nsx/_static/fonts/fontawesome-webfont.woff b/nsx/nsx/_static/fonts/fontawesome-webfont.woff new file mode 100644 index 00000000..400014a4 Binary files /dev/null and b/nsx/nsx/_static/fonts/fontawesome-webfont.woff differ diff --git a/nsx/nsx/_static/fonts/fontawesome-webfont.woff2 b/nsx/nsx/_static/fonts/fontawesome-webfont.woff2 new file mode 100644 index 00000000..4d13fc60 Binary files /dev/null and b/nsx/nsx/_static/fonts/fontawesome-webfont.woff2 differ diff --git a/nsx/nsx/_static/jquery-3.2.1.js b/nsx/nsx/_static/jquery-3.2.1.js new file mode 100644 index 00000000..d2d8ca47 --- /dev/null +++ b/nsx/nsx/_static/jquery-3.2.1.js @@ -0,0 +1,10253 @@ +/*! + * jQuery JavaScript Library v3.2.1 + * https://jquery.com/ + * + * Includes Sizzle.js + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://jquery.org/license + * + * Date: 2017-03-20T18:59Z + */ +( function( global, factory ) { + + "use strict"; + + if ( typeof module === "object" && typeof module.exports === "object" ) { + + // For CommonJS and CommonJS-like environments where a proper `window` + // is present, execute the factory and get jQuery. + // For environments that do not have a `window` with a `document` + // (such as Node.js), expose a factory as module.exports. + // This accentuates the need for the creation of a real `window`. + // e.g. var jQuery = require("jquery")(window); + // See ticket #14549 for more info. + module.exports = global.document ? + factory( global, true ) : + function( w ) { + if ( !w.document ) { + throw new Error( "jQuery requires a window with a document" ); + } + return factory( w ); + }; + } else { + factory( global ); + } + +// Pass this if window is not defined yet +} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { + +// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 +// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode +// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common +// enough that all such attempts are guarded in a try block. +"use strict"; + +var arr = []; + +var document = window.document; + +var getProto = Object.getPrototypeOf; + +var slice = arr.slice; + +var concat = arr.concat; + +var push = arr.push; + +var indexOf = arr.indexOf; + +var class2type = {}; + +var toString = class2type.toString; + +var hasOwn = class2type.hasOwnProperty; + +var fnToString = hasOwn.toString; + +var ObjectFunctionString = fnToString.call( Object ); + +var support = {}; + + + + function DOMEval( code, doc ) { + doc = doc || document; + + var script = doc.createElement( "script" ); + + script.text = code; + doc.head.appendChild( script ).parentNode.removeChild( script ); + } +/* global Symbol */ +// Defining this global in .eslintrc.json would create a danger of using the global +// unguarded in another place, it seems safer to define global only for this module + + + +var + version = "3.2.1", + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + + // The jQuery object is actually just the init constructor 'enhanced' + // Need init if jQuery is called (just allow error to be thrown if not included) + return new jQuery.fn.init( selector, context ); + }, + + // Support: Android <=4.0 only + // Make sure we trim BOM and NBSP + rtrim = /^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g, + + // Matches dashed string for camelizing + rmsPrefix = /^-ms-/, + rdashAlpha = /-([a-z])/g, + + // Used by jQuery.camelCase as callback to replace() + fcamelCase = function( all, letter ) { + return letter.toUpperCase(); + }; + +jQuery.fn = jQuery.prototype = { + + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + + // Return all the elements in a clean array + if ( num == null ) { + return slice.call( this ); + } + + // Return just the one element from the set + return num < 0 ? this[ num + this.length ] : this[ num ]; + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + each: function( callback ) { + return jQuery.each( this, callback ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map( this, function( elem, i ) { + return callback.call( elem, i, elem ); + } ) ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: arr.sort, + splice: arr.splice +}; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[ 0 ] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + + // Skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !jQuery.isFunction( target ) ) { + target = {}; + } + + // Extend jQuery itself if only one argument is passed + if ( i === length ) { + target = this; + i--; + } + + for ( ; i < length; i++ ) { + + // Only deal with non-null/undefined values + if ( ( options = arguments[ i ] ) != null ) { + + // Extend the base object + for ( name in options ) { + src = target[ name ]; + copy = options[ name ]; + + // Prevent never-ending loop + if ( target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject( copy ) || + ( copyIsArray = Array.isArray( copy ) ) ) ) { + + if ( copyIsArray ) { + copyIsArray = false; + clone = src && Array.isArray( src ) ? src : []; + + } else { + clone = src && jQuery.isPlainObject( src ) ? src : {}; + } + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend( { + + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + isFunction: function( obj ) { + return jQuery.type( obj ) === "function"; + }, + + isWindow: function( obj ) { + return obj != null && obj === obj.window; + }, + + isNumeric: function( obj ) { + + // As of jQuery 3.0, isNumeric is limited to + // strings and numbers (primitives or objects) + // that can be coerced to finite numbers (gh-2662) + var type = jQuery.type( obj ); + return ( type === "number" || type === "string" ) && + + // parseFloat NaNs numeric-cast false positives ("") + // ...but misinterprets leading-number strings, particularly hex literals ("0x...") + // subtraction forces infinities to NaN + !isNaN( obj - parseFloat( obj ) ); + }, + + isPlainObject: function( obj ) { + var proto, Ctor; + + // Detect obvious negatives + // Use toString instead of jQuery.type to catch host objects + if ( !obj || toString.call( obj ) !== "[object Object]" ) { + return false; + } + + proto = getProto( obj ); + + // Objects with no prototype (e.g., `Object.create( null )`) are plain + if ( !proto ) { + return true; + } + + // Objects with prototype are plain iff they were constructed by a global Object function + Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; + return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; + }, + + isEmptyObject: function( obj ) { + + /* eslint-disable no-unused-vars */ + // See https://github.com/eslint/eslint/issues/6125 + var name; + + for ( name in obj ) { + return false; + } + return true; + }, + + type: function( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; + }, + + // Evaluates a script in a global context + globalEval: function( code ) { + DOMEval( code ); + }, + + // Convert dashed to camelCase; used by the css and data modules + // Support: IE <=9 - 11, Edge 12 - 13 + // Microsoft forgot to hump their vendor prefix (#9572) + camelCase: function( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); + }, + + each: function( obj, callback ) { + var length, i = 0; + + if ( isArrayLike( obj ) ) { + length = obj.length; + for ( ; i < length; i++ ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } else { + for ( i in obj ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } + + return obj; + }, + + // Support: Android <=4.0 only + trim: function( text ) { + return text == null ? + "" : + ( text + "" ).replace( rtrim, "" ); + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArrayLike( Object( arr ) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : indexOf.call( arr, elem, i ); + }, + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + for ( ; j < len; j++ ) { + first[ i++ ] = second[ j ]; + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var length, value, + i = 0, + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArrayLike( elems ) ) { + length = elems.length; + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return concat.apply( [], ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // Bind a function to a context, optionally partially applying any + // arguments. + proxy: function( fn, context ) { + var tmp, args, proxy; + + if ( typeof context === "string" ) { + tmp = fn[ context ]; + context = fn; + fn = tmp; + } + + // Quick check to determine if target is callable, in the spec + // this throws a TypeError, but we will just return undefined. + if ( !jQuery.isFunction( fn ) ) { + return undefined; + } + + // Simulated bind + args = slice.call( arguments, 2 ); + proxy = function() { + return fn.apply( context || this, args.concat( slice.call( arguments ) ) ); + }; + + // Set the guid of unique handler to the same of original handler, so it can be removed + proxy.guid = fn.guid = fn.guid || jQuery.guid++; + + return proxy; + }, + + now: Date.now, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +} ); + +if ( typeof Symbol === "function" ) { + jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; +} + +// Populate the class2type map +jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), +function( i, name ) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); +} ); + +function isArrayLike( obj ) { + + // Support: real iOS 8.2 only (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = !!obj && "length" in obj && obj.length, + type = jQuery.type( obj ); + + if ( type === "function" || jQuery.isWindow( obj ) ) { + return false; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.3.3 + * https://sizzlejs.com/ + * + * Copyright jQuery Foundation and other contributors + * Released under the MIT license + * http://jquery.org/license + * + * Date: 2016-08-08 + */ +(function( window ) { + +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // Instance methods + hasOwn = ({}).hasOwnProperty, + arr = [], + pop = arr.pop, + push_native = arr.push, + push = arr.push, + slice = arr.slice, + // Use a stripped-down indexOf as it's faster than native + // https://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[i] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + + // http://www.w3.org/TR/CSS21/syndata.html#value-def-identifier + identifier = "(?:\\\\.|[\\w-]|[^\0-\\xa0])+", + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + // "Attribute values must be CSS identifiers [capture 5] or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + whitespace + + "*\\]", + + pseudos = ":(" + identifier + ")(?:\\((" + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + "*" ), + + rattributeQuotes = new RegExp( "=" + whitespace + "*([^\\]'\"]*?)" + whitespace + "*\\]", "g" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + identifier + ")" ), + "CLASS": new RegExp( "^\\.(" + identifier + ")" ), + "TAG": new RegExp( "^(" + identifier + "|[*])" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + whitespace + + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + whitespace + + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + + whitespace + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + + // CSS escapes + // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\([\\da-f]{1,6}" + whitespace + "?|(" + whitespace + ")|.)", "ig" ), + funescape = function( _, escaped, escapedWhitespace ) { + var high = "0x" + escaped - 0x10000; + // NaN means non-codepoint + // Support: Firefox<24 + // Workaround erroneous numeric interpretation of +"0x" + return high !== high || escapedWhitespace ? + escaped : + high < 0 ? + // BMP codepoint + String.fromCharCode( high + 0x10000 ) : + // Supplemental Plane codepoint (surrogate pair) + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // CSS string/identifier serialization + // https://drafts.csswg.org/cssom/#common-serializing-idioms + rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, + fcssescape = function( ch, asCodePoint ) { + if ( asCodePoint ) { + + // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER + if ( ch === "\0" ) { + return "\uFFFD"; + } + + // Control characters and (dependent upon position) numbers get escaped as code points + return ch.slice( 0, -1 ) + "\\" + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + } + + // Other potentially-special ASCII characters get backslash-escaped + return "\\" + ch; + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }, + + disabledAncestor = addCombinator( + function( elem ) { + return elem.disabled === true && ("form" in elem || "label" in elem); + }, + { dir: "parentNode", next: "legend" } + ); + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + (arr = slice.call( preferredDoc.childNodes )), + preferredDoc.childNodes + ); + // Support: Android<4.0 + // Detect silently failing push.apply + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + push_native.apply( target, slice.call(els) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + // Can't trust NodeList.length + while ( (target[j++] = els[i++]) ) {} + target.length = j - 1; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var m, i, elem, nid, match, groups, newSelector, + newContext = context && context.ownerDocument, + + // nodeType defaults to 9, since context defaults to document + nodeType = context ? context.nodeType : 9; + + results = results || []; + + // Return early from calls with invalid selector or context + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + // Try to shortcut find operations (as opposed to filters) in HTML documents + if ( !seed ) { + + if ( ( context ? context.ownerDocument || context : preferredDoc ) !== document ) { + setDocument( context ); + } + context = context || document; + + if ( documentIsHTML ) { + + // If the selector is sufficiently simple, try using a "get*By*" DOM method + // (excepting DocumentFragment context, where the methods don't exist) + if ( nodeType !== 11 && (match = rquickExpr.exec( selector )) ) { + + // ID selector + if ( (m = match[1]) ) { + + // Document context + if ( nodeType === 9 ) { + if ( (elem = context.getElementById( m )) ) { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + + // Element context + } else { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( newContext && (elem = newContext.getElementById( m )) && + contains( context, elem ) && + elem.id === m ) { + + results.push( elem ); + return results; + } + } + + // Type selector + } else if ( match[2] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Class selector + } else if ( (m = match[3]) && support.getElementsByClassName && + context.getElementsByClassName ) { + + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // Take advantage of querySelectorAll + if ( support.qsa && + !compilerCache[ selector + " " ] && + (!rbuggyQSA || !rbuggyQSA.test( selector )) ) { + + if ( nodeType !== 1 ) { + newContext = context; + newSelector = selector; + + // qSA looks outside Element context, which is not what we want + // Thanks to Andrew Dupont for this workaround technique + // Support: IE <=8 + // Exclude object elements + } else if ( context.nodeName.toLowerCase() !== "object" ) { + + // Capture the context ID, setting it first if necessary + if ( (nid = context.getAttribute( "id" )) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", (nid = expando) ); + } + + // Prefix every selector in the list + groups = tokenize( selector ); + i = groups.length; + while ( i-- ) { + groups[i] = "#" + nid + " " + toSelector( groups[i] ); + } + newSelector = groups.join( "," ); + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + } + + if ( newSelector ) { + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); + } + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Create key-value caches of limited size + * @returns {function(string, object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var keys = []; + + function cache( key, value ) { + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key + " " ) > Expr.cacheLength ) { + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return (cache[ key + " " ] = value); + } + return cache; +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created element and returns a boolean result + */ +function assert( fn ) { + var el = document.createElement("fieldset"); + + try { + return !!fn( el ); + } catch (e) { + return false; + } finally { + // Remove from its parent by default + if ( el.parentNode ) { + el.parentNode.removeChild( el ); + } + // release memory in IE + el = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split("|"), + i = arr.length; + + while ( i-- ) { + Expr.attrHandle[ arr[i] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + a.sourceIndex - b.sourceIndex; + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( (cur = cur.nextSibling) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for buttons + * @param {String} type + */ +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return (name === "input" || name === "button") && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for :enabled/:disabled + * @param {Boolean} disabled true for :disabled; false for :enabled + */ +function createDisabledPseudo( disabled ) { + + // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable + return function( elem ) { + + // Only certain elements can match :enabled or :disabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled + if ( "form" in elem ) { + + // Check for inherited disabledness on relevant non-disabled elements: + // * listed form-associated elements in a disabled fieldset + // https://html.spec.whatwg.org/multipage/forms.html#category-listed + // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled + // * option elements in a disabled optgroup + // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled + // All such elements have a "form" property. + if ( elem.parentNode && elem.disabled === false ) { + + // Option elements defer to a parent optgroup if present + if ( "label" in elem ) { + if ( "label" in elem.parentNode ) { + return elem.parentNode.disabled === disabled; + } else { + return elem.disabled === disabled; + } + } + + // Support: IE 6 - 11 + // Use the isDisabled shortcut property to check for disabled fieldset ancestors + return elem.isDisabled === disabled || + + // Where there is no isDisabled, check manually + /* jshint -W018 */ + elem.isDisabled !== !disabled && + disabledAncestor( elem ) === disabled; + } + + return elem.disabled === disabled; + + // Try to winnow out elements that can't be disabled before trusting the disabled property. + // Some victims get caught in our net (label, legend, menu, track), but it shouldn't + // even exist on them, let alone have a boolean value. + } else if ( "label" in elem ) { + return elem.disabled === disabled; + } + + // Remaining elements are neither :enabled nor :disabled + return false; + }; +} + +/** + * Returns a function to use in pseudos for positionals + * @param {Function} fn + */ +function createPositionalPseudo( fn ) { + return markFunction(function( argument ) { + argument = +argument; + return markFunction(function( seed, matches ) { + var j, + matchIndexes = fn( [], seed.length, argument ), + i = matchIndexes.length; + + // Match elements found at the specified indexes + while ( i-- ) { + if ( seed[ (j = matchIndexes[i]) ] ) { + seed[j] = !(matches[j] = seed[j]); + } + } + }); + }); +} + +/** + * Checks a node for validity as a Sizzle context + * @param {Element|Object=} context + * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value + */ +function testContext( context ) { + return context && typeof context.getElementsByTagName !== "undefined" && context; +} + +// Expose support vars for convenience +support = Sizzle.support = {}; + +/** + * Detects XML nodes + * @param {Element|Object} elem An element or a document + * @returns {Boolean} True iff elem is a non-HTML XML node + */ +isXML = Sizzle.isXML = function( elem ) { + // documentElement is verified for cases where it doesn't yet exist + // (such as loading iframes in IE - #4833) + var documentElement = elem && (elem.ownerDocument || elem).documentElement; + return documentElement ? documentElement.nodeName !== "HTML" : false; +}; + +/** + * Sets document-related variables once based on the current document + * @param {Element|Object} [doc] An element or document object to use to set the document + * @returns {Object} Returns the current document + */ +setDocument = Sizzle.setDocument = function( node ) { + var hasCompare, subWindow, + doc = node ? node.ownerDocument || node : preferredDoc; + + // Return early if doc is invalid or already selected + if ( doc === document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Update global variables + document = doc; + docElem = document.documentElement; + documentIsHTML = !isXML( document ); + + // Support: IE 9-11, Edge + // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) + if ( preferredDoc !== document && + (subWindow = document.defaultView) && subWindow.top !== subWindow ) { + + // Support: IE 11, Edge + if ( subWindow.addEventListener ) { + subWindow.addEventListener( "unload", unloadHandler, false ); + + // Support: IE 9 - 10 only + } else if ( subWindow.attachEvent ) { + subWindow.attachEvent( "onunload", unloadHandler ); + } + } + + /* Attributes + ---------------------------------------------------------------------- */ + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties + // (excepting IE8 booleans) + support.attributes = assert(function( el ) { + el.className = "i"; + return !el.getAttribute("className"); + }); + + /* getElement(s)By* + ---------------------------------------------------------------------- */ + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert(function( el ) { + el.appendChild( document.createComment("") ); + return !el.getElementsByTagName("*").length; + }); + + // Support: IE<9 + support.getElementsByClassName = rnative.test( document.getElementsByClassName ); + + // Support: IE<10 + // Check if getElementById returns elements by name + // The broken getElementById methods don't pick up programmatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert(function( el ) { + docElem.appendChild( el ).id = expando; + return !document.getElementsByName || !document.getElementsByName( expando ).length; + }); + + // ID filter and find + if ( support.getById ) { + Expr.filter["ID"] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute("id") === attrId; + }; + }; + Expr.find["ID"] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var elem = context.getElementById( id ); + return elem ? [ elem ] : []; + } + }; + } else { + Expr.filter["ID"] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== "undefined" && + elem.getAttributeNode("id"); + return node && node.value === attrId; + }; + }; + + // Support: IE 6 - 7 only + // getElementById is not reliable as a find shortcut + Expr.find["ID"] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var node, i, elems, + elem = context.getElementById( id ); + + if ( elem ) { + + // Verify the id attribute + node = elem.getAttributeNode("id"); + if ( node && node.value === id ) { + return [ elem ]; + } + + // Fall back on getElementsByName + elems = context.getElementsByName( id ); + i = 0; + while ( (elem = elems[i++]) ) { + node = elem.getAttributeNode("id"); + if ( node && node.value === id ) { + return [ elem ]; + } + } + } + + return []; + } + }; + } + + // Tag + Expr.find["TAG"] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( tag ); + + // DocumentFragment nodes don't have gEBTN + } else if ( support.qsa ) { + return context.querySelectorAll( tag ); + } + } : + + function( tag, context ) { + var elem, + tmp = [], + i = 0, + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too + results = context.getElementsByTagName( tag ); + + // Filter out possible comments + if ( tag === "*" ) { + while ( (elem = results[i++]) ) { + if ( elem.nodeType === 1 ) { + tmp.push( elem ); + } + } + + return tmp; + } + return results; + }; + + // Class + Expr.find["CLASS"] = support.getElementsByClassName && function( className, context ) { + if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + /* QSA/matchesSelector + ---------------------------------------------------------------------- */ + + // QSA and matchesSelector support + + // matchesSelector(:active) reports false when true (IE9/Opera 11.5) + rbuggyMatches = []; + + // qSa(:focus) reports false when true (Chrome 21) + // We allow this because of a bug in IE8/9 that throws an error + // whenever `document.activeElement` is accessed on an iframe + // So, we allow :focus to pass through QSA all the time to avoid the IE error + // See https://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( (support.qsa = rnative.test( document.querySelectorAll )) ) { + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert(function( el ) { + // Select is set to empty string on purpose + // This is to test IE's treatment of not explicitly + // setting a boolean content attribute, + // since its presence should be enough + // https://bugs.jquery.com/ticket/12359 + docElem.appendChild( el ).innerHTML = "" + + ""; + + // Support: IE8, Opera 11-12.16 + // Nothing should be selected when empty strings follow ^= or $= or *= + // The test attribute must be unknown in Opera but "safe" for WinRT + // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section + if ( el.querySelectorAll("[msallowcapture^='']").length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !el.querySelectorAll("[selected]").length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ + if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { + rbuggyQSA.push("~="); + } + + // Webkit/Opera - :checked should return selected option elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + // IE8 throws error here and will not see later tests + if ( !el.querySelectorAll(":checked").length ) { + rbuggyQSA.push(":checked"); + } + + // Support: Safari 8+, iOS 8+ + // https://bugs.webkit.org/show_bug.cgi?id=136851 + // In-page `selector#id sibling-combinator selector` fails + if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { + rbuggyQSA.push(".#.+[+~]"); + } + }); + + assert(function( el ) { + el.innerHTML = "" + + ""; + + // Support: Windows 8 Native Apps + // The type and name attributes are restricted during .innerHTML assignment + var input = document.createElement("input"); + input.setAttribute( "type", "hidden" ); + el.appendChild( input ).setAttribute( "name", "D" ); + + // Support: IE8 + // Enforce case-sensitivity of name attribute + if ( el.querySelectorAll("[name=d]").length ) { + rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); + } + + // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) + // IE8 throws error here and will not see later tests + if ( el.querySelectorAll(":enabled").length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: IE9-11+ + // IE's :disabled selector does not pick up the children of disabled fieldsets + docElem.appendChild( el ).disabled = true; + if ( el.querySelectorAll(":disabled").length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Opera 10-11 does not throw on post-comma invalid pseudos + el.querySelectorAll("*,:x"); + rbuggyQSA.push(",.*:"); + }); + } + + if ( (support.matchesSelector = rnative.test( (matches = docElem.matches || + docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector) )) ) { + + assert(function( el ) { + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( el, "*" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( el, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + }); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join("|") ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join("|") ); + + /* Contains + ---------------------------------------------------------------------- */ + hasCompare = rnative.test( docElem.compareDocumentPosition ); + + // Element contains another + // Purposefully self-exclusive + // As in, an element does not contain itself + contains = hasCompare || rnative.test( docElem.contains ) ? + function( a, b ) { + var adown = a.nodeType === 9 ? a.documentElement : a, + bup = b && b.parentNode; + return a === bup || !!( bup && bup.nodeType === 1 && ( + adown.contains ? + adown.contains( bup ) : + a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 + )); + } : + function( a, b ) { + if ( b ) { + while ( (b = b.parentNode) ) { + if ( b === a ) { + return true; + } + } + } + return false; + }; + + /* Sorting + ---------------------------------------------------------------------- */ + + // Document order sorting + sortOrder = hasCompare ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + // Sort on method existence if only one input has compareDocumentPosition + var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; + if ( compare ) { + return compare; + } + + // Calculate position if both inputs belong to the same document + compare = ( a.ownerDocument || a ) === ( b.ownerDocument || b ) ? + a.compareDocumentPosition( b ) : + + // Otherwise we know they are disconnected + 1; + + // Disconnected nodes + if ( compare & 1 || + (!support.sortDetached && b.compareDocumentPosition( a ) === compare) ) { + + // Choose the first element that is related to our preferred document + if ( a === document || a.ownerDocument === preferredDoc && contains(preferredDoc, a) ) { + return -1; + } + if ( b === document || b.ownerDocument === preferredDoc && contains(preferredDoc, b) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } : + function( a, b ) { + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Parentless nodes are either documents or disconnected + if ( !aup || !bup ) { + return a === document ? -1 : + b === document ? 1 : + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + + // If the nodes are siblings, we can do a quick check + } else if ( aup === bup ) { + return siblingCheck( a, b ); + } + + // Otherwise we need full lists of their ancestors for comparison + cur = a; + while ( (cur = cur.parentNode) ) { + ap.unshift( cur ); + } + cur = b; + while ( (cur = cur.parentNode) ) { + bp.unshift( cur ); + } + + // Walk down the tree looking for a discrepancy + while ( ap[i] === bp[i] ) { + i++; + } + + return i ? + // Do a sibling check if the nodes have a common ancestor + siblingCheck( ap[i], bp[i] ) : + + // Otherwise nodes in our document sort first + ap[i] === preferredDoc ? -1 : + bp[i] === preferredDoc ? 1 : + 0; + }; + + return document; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + // Set document vars if needed + if ( ( elem.ownerDocument || elem ) !== document ) { + setDocument( elem ); + } + + // Make sure that attribute selectors are quoted + expr = expr.replace( rattributeQuotes, "='$1']" ); + + if ( support.matchesSelector && documentIsHTML && + !compilerCache[ expr + " " ] && + ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && + ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { + + try { + var ret = matches.call( elem, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || support.disconnectedMatch || + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { + return ret; + } + } catch (e) {} + } + + return Sizzle( expr, document, null, [ elem ] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + // Set document vars if needed + if ( ( context.ownerDocument || context ) !== document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + // Set document vars if needed + if ( ( elem.ownerDocument || elem ) !== document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + // Don't get fooled by Object.prototype properties (jQuery #13807) + val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? + fn( elem, name, !documentIsHTML ) : + undefined; + + return val !== undefined ? + val : + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + (val = elem.getAttributeNode(name)) && val.specified ? + val.value : + null; +}; + +Sizzle.escape = function( sel ) { + return (sel + "").replace( rcssescape, fcssescape ); +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Document sorting and removing duplicates + * @param {ArrayLike} results + */ +Sizzle.uniqueSort = function( results ) { + var elem, + duplicates = [], + j = 0, + i = 0; + + // Unless we *know* we can detect duplicates, assume their presence + hasDuplicate = !support.detectDuplicates; + sortInput = !support.sortStable && results.slice( 0 ); + results.sort( sortOrder ); + + if ( hasDuplicate ) { + while ( (elem = results[i++]) ) { + if ( elem === results[ i ] ) { + j = duplicates.push( i ); + } + } + while ( j-- ) { + results.splice( duplicates[ j ], 1 ); + } + } + + // Clear input after sorting to release objects + // See https://github.com/jquery/sizzle/pull/225 + sortInput = null; + + return results; +}; + +/** + * Utility function for retrieving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +getText = Sizzle.getText = function( elem ) { + var node, + ret = "", + i = 0, + nodeType = elem.nodeType; + + if ( !nodeType ) { + // If no nodeType, this is expected to be an array + while ( (node = elem[i++]) ) { + // Do not traverse comment nodes + ret += getText( node ); + } + } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + // Use textContent for elements + // innerText usage removed for consistency of new lines (jQuery #11153) + if ( typeof elem.textContent === "string" ) { + return elem.textContent; + } else { + // Traverse its children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + // Do not include comment or processing instruction nodes + + return ret; +}; + +Expr = Sizzle.selectors = { + + // Can be adjusted by the user + cacheLength: 50, + + createPseudo: markFunction, + + match: matchExpr, + + attrHandle: {}, + + find: {}, + + relative: { + ">": { dir: "parentNode", first: true }, + " ": { dir: "parentNode" }, + "+": { dir: "previousSibling", first: true }, + "~": { dir: "previousSibling" } + }, + + preFilter: { + "ATTR": function( match ) { + match[1] = match[1].replace( runescape, funescape ); + + // Move the given value to match[3] whether quoted or unquoted + match[3] = ( match[3] || match[4] || match[5] || "" ).replace( runescape, funescape ); + + if ( match[2] === "~=" ) { + match[3] = " " + match[3] + " "; + } + + return match.slice( 0, 4 ); + }, + + "CHILD": function( match ) { + /* matches from matchExpr["CHILD"] + 1 type (only|nth|...) + 2 what (child|of-type) + 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) + 4 xn-component of xn+y argument ([+-]?\d*n|) + 5 sign of xn-component + 6 x of xn-component + 7 sign of y-component + 8 y of y-component + */ + match[1] = match[1].toLowerCase(); + + if ( match[1].slice( 0, 3 ) === "nth" ) { + // nth-* requires argument + if ( !match[3] ) { + Sizzle.error( match[0] ); + } + + // numeric x and y parameters for Expr.filter.CHILD + // remember that false/true cast respectively to 0/1 + match[4] = +( match[4] ? match[5] + (match[6] || 1) : 2 * ( match[3] === "even" || match[3] === "odd" ) ); + match[5] = +( ( match[7] + match[8] ) || match[3] === "odd" ); + + // other types prohibit arguments + } else if ( match[3] ) { + Sizzle.error( match[0] ); + } + + return match; + }, + + "PSEUDO": function( match ) { + var excess, + unquoted = !match[6] && match[2]; + + if ( matchExpr["CHILD"].test( match[0] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[3] ) { + match[2] = match[4] || match[5] || ""; + + // Strip excess characters from unquoted arguments + } else if ( unquoted && rpseudo.test( unquoted ) && + // Get excess from tokenize (recursively) + (excess = tokenize( unquoted, true )) && + // advance to the next closing parenthesis + (excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length) ) { + + // excess is a negative index + match[0] = match[0].slice( 0, excess ); + match[2] = unquoted.slice( 0, excess ); + } + + // Return only captures needed by the pseudo filter method (type and argument) + return match.slice( 0, 3 ); + } + }, + + filter: { + + "TAG": function( nodeNameSelector ) { + var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); + return nodeNameSelector === "*" ? + function() { return true; } : + function( elem ) { + return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; + }; + }, + + "CLASS": function( className ) { + var pattern = classCache[ className + " " ]; + + return pattern || + (pattern = new RegExp( "(^|" + whitespace + ")" + className + "(" + whitespace + "|$)" )) && + classCache( className, function( elem ) { + return pattern.test( typeof elem.className === "string" && elem.className || typeof elem.getAttribute !== "undefined" && elem.getAttribute("class") || "" ); + }); + }, + + "ATTR": function( name, operator, check ) { + return function( elem ) { + var result = Sizzle.attr( elem, name ); + + if ( result == null ) { + return operator === "!="; + } + if ( !operator ) { + return true; + } + + result += ""; + + return operator === "=" ? result === check : + operator === "!=" ? result !== check : + operator === "^=" ? check && result.indexOf( check ) === 0 : + operator === "*=" ? check && result.indexOf( check ) > -1 : + operator === "$=" ? check && result.slice( -check.length ) === check : + operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + }; + }, + + "CHILD": function( type, what, argument, first, last ) { + var simple = type.slice( 0, 3 ) !== "nth", + forward = type.slice( -4 ) !== "last", + ofType = what === "of-type"; + + return first === 1 && last === 0 ? + + // Shortcut for :nth-*(n) + function( elem ) { + return !!elem.parentNode; + } : + + function( elem, context, xml ) { + var cache, uniqueCache, outerCache, node, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType, + diff = false; + + if ( parent ) { + + // :(first|last|only)-(child|of-type) + if ( simple ) { + while ( dir ) { + node = elem; + while ( (node = node[ dir ]) ) { + if ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) { + + return false; + } + } + // Reverse direction for :only-* (if we haven't yet done so) + start = dir = type === "only" && !start && "nextSibling"; + } + return true; + } + + start = [ forward ? parent.firstChild : parent.lastChild ]; + + // non-xml :nth-child(...) stores cache data on `parent` + if ( forward && useCache ) { + + // Seek `elem` from a previously-cached index + + // ...in a gzip-friendly way + node = parent; + outerCache = node[ expando ] || (node[ expando ] = {}); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + (outerCache[ node.uniqueID ] = {}); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex && cache[ 2 ]; + node = nodeIndex && parent.childNodes[ nodeIndex ]; + + while ( (node = ++nodeIndex && node && node[ dir ] || + + // Fallback to seeking `elem` from the start + (diff = nodeIndex = 0) || start.pop()) ) { + + // When found, cache indexes on `parent` and break + if ( node.nodeType === 1 && ++diff && node === elem ) { + uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + } else { + // Use previously-cached element index if available + if ( useCache ) { + // ...in a gzip-friendly way + node = elem; + outerCache = node[ expando ] || (node[ expando ] = {}); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + (outerCache[ node.uniqueID ] = {}); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex; + } + + // xml :nth-child(...) + // or :nth-last-child(...) or :nth(-last)?-of-type(...) + if ( diff === false ) { + // Use the same loop as above to seek `elem` from the start + while ( (node = ++nodeIndex && node && node[ dir ] || + (diff = nodeIndex = 0) || start.pop()) ) { + + if ( ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) && + ++diff ) { + + // Cache the index of each encountered element + if ( useCache ) { + outerCache = node[ expando ] || (node[ expando ] = {}); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + (outerCache[ node.uniqueID ] = {}); + + uniqueCache[ type ] = [ dirruns, diff ]; + } + + if ( node === elem ) { + break; + } + } + } + } + } + + // Incorporate the offset, then check against cycle size + diff -= last; + return diff === first || ( diff % first === 0 && diff / first >= 0 ); + } + }; + }, + + "PSEUDO": function( pseudo, argument ) { + // pseudo-class names are case-insensitive + // http://www.w3.org/TR/selectors/#pseudo-classes + // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters + // Remember that setFilters inherits from pseudos + var args, + fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || + Sizzle.error( "unsupported pseudo: " + pseudo ); + + // The user may use createPseudo to indicate that + // arguments are needed to create the filter function + // just as Sizzle does + if ( fn[ expando ] ) { + return fn( argument ); + } + + // But maintain support for old signatures + if ( fn.length > 1 ) { + args = [ pseudo, pseudo, "", argument ]; + return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? + markFunction(function( seed, matches ) { + var idx, + matched = fn( seed, argument ), + i = matched.length; + while ( i-- ) { + idx = indexOf( seed, matched[i] ); + seed[ idx ] = !( matches[ idx ] = matched[i] ); + } + }) : + function( elem ) { + return fn( elem, 0, args ); + }; + } + + return fn; + } + }, + + pseudos: { + // Potentially complex pseudos + "not": markFunction(function( selector ) { + // Trim the selector passed to compile + // to avoid treating leading and trailing + // spaces as combinators + var input = [], + results = [], + matcher = compile( selector.replace( rtrim, "$1" ) ); + + return matcher[ expando ] ? + markFunction(function( seed, matches, context, xml ) { + var elem, + unmatched = matcher( seed, null, xml, [] ), + i = seed.length; + + // Match elements unmatched by `matcher` + while ( i-- ) { + if ( (elem = unmatched[i]) ) { + seed[i] = !(matches[i] = elem); + } + } + }) : + function( elem, context, xml ) { + input[0] = elem; + matcher( input, null, xml, results ); + // Don't keep the element (issue #299) + input[0] = null; + return !results.pop(); + }; + }), + + "has": markFunction(function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + }), + + "contains": markFunction(function( text ) { + text = text.replace( runescape, funescape ); + return function( elem ) { + return ( elem.textContent || elem.innerText || getText( elem ) ).indexOf( text ) > -1; + }; + }), + + // "Whether an element is represented by a :lang() selector + // is based solely on the element's language value + // being equal to the identifier C, + // or beginning with the identifier C immediately followed by "-". + // The matching of C against the element's language value is performed case-insensitively. + // The identifier C does not have to be a valid language name." + // http://www.w3.org/TR/selectors/#lang-pseudo + "lang": markFunction( function( lang ) { + // lang value must be a valid identifier + if ( !ridentifier.test(lang || "") ) { + Sizzle.error( "unsupported lang: " + lang ); + } + lang = lang.replace( runescape, funescape ).toLowerCase(); + return function( elem ) { + var elemLang; + do { + if ( (elemLang = documentIsHTML ? + elem.lang : + elem.getAttribute("xml:lang") || elem.getAttribute("lang")) ) { + + elemLang = elemLang.toLowerCase(); + return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; + } + } while ( (elem = elem.parentNode) && elem.nodeType === 1 ); + return false; + }; + }), + + // Miscellaneous + "target": function( elem ) { + var hash = window.location && window.location.hash; + return hash && hash.slice( 1 ) === elem.id; + }, + + "root": function( elem ) { + return elem === docElem; + }, + + "focus": function( elem ) { + return elem === document.activeElement && (!document.hasFocus || document.hasFocus()) && !!(elem.type || elem.href || ~elem.tabIndex); + }, + + // Boolean properties + "enabled": createDisabledPseudo( false ), + "disabled": createDisabledPseudo( true ), + + "checked": function( elem ) { + // In CSS3, :checked should return both checked and selected elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + var nodeName = elem.nodeName.toLowerCase(); + return (nodeName === "input" && !!elem.checked) || (nodeName === "option" && !!elem.selected); + }, + + "selected": function( elem ) { + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), + // but not by others (comment: 8; processing instruction: 7; etc.) + // nodeType < 6 works because attributes (2) do not appear as children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeType < 6 ) { + return false; + } + } + return true; + }, + + "parent": function( elem ) { + return !Expr.pseudos["empty"]( elem ); + }, + + // Element/input types + "header": function( elem ) { + return rheader.test( elem.nodeName ); + }, + + "input": function( elem ) { + return rinputs.test( elem.nodeName ); + }, + + "button": function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === "button" || name === "button"; + }, + + "text": function( elem ) { + var attr; + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + + // Support: IE<8 + // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" + ( (attr = elem.getAttribute("type")) == null || attr.toLowerCase() === "text" ); + }, + + // Position-in-collection + "first": createPositionalPseudo(function() { + return [ 0 ]; + }), + + "last": createPositionalPseudo(function( matchIndexes, length ) { + return [ length - 1 ]; + }), + + "eq": createPositionalPseudo(function( matchIndexes, length, argument ) { + return [ argument < 0 ? argument + length : argument ]; + }), + + "even": createPositionalPseudo(function( matchIndexes, length ) { + var i = 0; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + }), + + "odd": createPositionalPseudo(function( matchIndexes, length ) { + var i = 1; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + }), + + "lt": createPositionalPseudo(function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; --i >= 0; ) { + matchIndexes.push( i ); + } + return matchIndexes; + }), + + "gt": createPositionalPseudo(function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; ++i < length; ) { + matchIndexes.push( i ); + } + return matchIndexes; + }) + } +}; + +Expr.pseudos["nth"] = Expr.pseudos["eq"]; + +// Add button/input type pseudos +for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { + Expr.pseudos[ i ] = createInputPseudo( i ); +} +for ( i in { submit: true, reset: true } ) { + Expr.pseudos[ i ] = createButtonPseudo( i ); +} + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +tokenize = Sizzle.tokenize = function( selector, parseOnly ) { + var matched, match, tokens, type, + soFar, groups, preFilters, + cached = tokenCache[ selector + " " ]; + + if ( cached ) { + return parseOnly ? 0 : cached.slice( 0 ); + } + + soFar = selector; + groups = []; + preFilters = Expr.preFilter; + + while ( soFar ) { + + // Comma and first run + if ( !matched || (match = rcomma.exec( soFar )) ) { + if ( match ) { + // Don't consume trailing commas as valid + soFar = soFar.slice( match[0].length ) || soFar; + } + groups.push( (tokens = []) ); + } + + matched = false; + + // Combinators + if ( (match = rcombinators.exec( soFar )) ) { + matched = match.shift(); + tokens.push({ + value: matched, + // Cast descendant combinators to space + type: match[0].replace( rtrim, " " ) + }); + soFar = soFar.slice( matched.length ); + } + + // Filters + for ( type in Expr.filter ) { + if ( (match = matchExpr[ type ].exec( soFar )) && (!preFilters[ type ] || + (match = preFilters[ type ]( match ))) ) { + matched = match.shift(); + tokens.push({ + value: matched, + type: type, + matches: match + }); + soFar = soFar.slice( matched.length ); + } + } + + if ( !matched ) { + break; + } + } + + // Return the length of the invalid excess + // if we're just parsing + // Otherwise, throw an error or return tokens + return parseOnly ? + soFar.length : + soFar ? + Sizzle.error( selector ) : + // Cache the tokens + tokenCache( selector, groups ).slice( 0 ); +}; + +function toSelector( tokens ) { + var i = 0, + len = tokens.length, + selector = ""; + for ( ; i < len; i++ ) { + selector += tokens[i].value; + } + return selector; +} + +function addCombinator( matcher, combinator, base ) { + var dir = combinator.dir, + skip = combinator.next, + key = skip || dir, + checkNonElements = base && key === "parentNode", + doneName = done++; + + return combinator.first ? + // Check against closest ancestor/preceding element + function( elem, context, xml ) { + while ( (elem = elem[ dir ]) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + return matcher( elem, context, xml ); + } + } + return false; + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var oldCache, uniqueCache, outerCache, + newCache = [ dirruns, doneName ]; + + // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching + if ( xml ) { + while ( (elem = elem[ dir ]) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + if ( matcher( elem, context, xml ) ) { + return true; + } + } + } + } else { + while ( (elem = elem[ dir ]) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + outerCache = elem[ expando ] || (elem[ expando ] = {}); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ elem.uniqueID ] || (outerCache[ elem.uniqueID ] = {}); + + if ( skip && skip === elem.nodeName.toLowerCase() ) { + elem = elem[ dir ] || elem; + } else if ( (oldCache = uniqueCache[ key ]) && + oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { + + // Assign to newCache so results back-propagate to previous elements + return (newCache[ 2 ] = oldCache[ 2 ]); + } else { + // Reuse newcache so results back-propagate to previous elements + uniqueCache[ key ] = newCache; + + // A match means we're done; a fail means we have to keep checking + if ( (newCache[ 2 ] = matcher( elem, context, xml )) ) { + return true; + } + } + } + } + } + return false; + }; +} + +function elementMatcher( matchers ) { + return matchers.length > 1 ? + function( elem, context, xml ) { + var i = matchers.length; + while ( i-- ) { + if ( !matchers[i]( elem, context, xml ) ) { + return false; + } + } + return true; + } : + matchers[0]; +} + +function multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[i], results ); + } + return results; +} + +function condense( unmatched, map, filter, context, xml ) { + var elem, + newUnmatched = [], + i = 0, + len = unmatched.length, + mapped = map != null; + + for ( ; i < len; i++ ) { + if ( (elem = unmatched[i]) ) { + if ( !filter || filter( elem, context, xml ) ) { + newUnmatched.push( elem ); + if ( mapped ) { + map.push( i ); + } + } + } + } + + return newUnmatched; +} + +function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { + if ( postFilter && !postFilter[ expando ] ) { + postFilter = setMatcher( postFilter ); + } + if ( postFinder && !postFinder[ expando ] ) { + postFinder = setMatcher( postFinder, postSelector ); + } + return markFunction(function( seed, results, context, xml ) { + var temp, i, elem, + preMap = [], + postMap = [], + preexisting = results.length, + + // Get initial elements from seed or context + elems = seed || multipleContexts( selector || "*", context.nodeType ? [ context ] : context, [] ), + + // Prefilter to get matcher input, preserving a map for seed-results synchronization + matcherIn = preFilter && ( seed || !selector ) ? + condense( elems, preMap, preFilter, context, xml ) : + elems, + + matcherOut = matcher ? + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, + postFinder || ( seed ? preFilter : preexisting || postFilter ) ? + + // ...intermediate processing is necessary + [] : + + // ...otherwise use results directly + results : + matcherIn; + + // Find primary matches + if ( matcher ) { + matcher( matcherIn, matcherOut, context, xml ); + } + + // Apply postFilter + if ( postFilter ) { + temp = condense( matcherOut, postMap ); + postFilter( temp, [], context, xml ); + + // Un-match failing elements by moving them back to matcherIn + i = temp.length; + while ( i-- ) { + if ( (elem = temp[i]) ) { + matcherOut[ postMap[i] ] = !(matcherIn[ postMap[i] ] = elem); + } + } + } + + if ( seed ) { + if ( postFinder || preFilter ) { + if ( postFinder ) { + // Get the final matcherOut by condensing this intermediate into postFinder contexts + temp = []; + i = matcherOut.length; + while ( i-- ) { + if ( (elem = matcherOut[i]) ) { + // Restore matcherIn since elem is not yet a final match + temp.push( (matcherIn[i] = elem) ); + } + } + postFinder( null, (matcherOut = []), temp, xml ); + } + + // Move matched elements from seed to results to keep them synchronized + i = matcherOut.length; + while ( i-- ) { + if ( (elem = matcherOut[i]) && + (temp = postFinder ? indexOf( seed, elem ) : preMap[i]) > -1 ) { + + seed[temp] = !(results[temp] = elem); + } + } + } + + // Add elements to results, through postFinder if defined + } else { + matcherOut = condense( + matcherOut === results ? + matcherOut.splice( preexisting, matcherOut.length ) : + matcherOut + ); + if ( postFinder ) { + postFinder( null, results, matcherOut, xml ); + } else { + push.apply( results, matcherOut ); + } + } + }); +} + +function matcherFromTokens( tokens ) { + var checkContext, matcher, j, + len = tokens.length, + leadingRelative = Expr.relative[ tokens[0].type ], + implicitRelative = leadingRelative || Expr.relative[" "], + i = leadingRelative ? 1 : 0, + + // The foundational matcher ensures that elements are reachable from top-level context(s) + matchContext = addCombinator( function( elem ) { + return elem === checkContext; + }, implicitRelative, true ), + matchAnyContext = addCombinator( function( elem ) { + return indexOf( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + (checkContext = context).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + // Avoid hanging onto element (issue #299) + checkContext = null; + return ret; + } ]; + + for ( ; i < len; i++ ) { + if ( (matcher = Expr.relative[ tokens[i].type ]) ) { + matchers = [ addCombinator(elementMatcher( matchers ), matcher) ]; + } else { + matcher = Expr.filter[ tokens[i].type ].apply( null, tokens[i].matches ); + + // Return special upon seeing a positional matcher + if ( matcher[ expando ] ) { + // Find the next relative operator (if any) for proper handling + j = ++i; + for ( ; j < len; j++ ) { + if ( Expr.relative[ tokens[j].type ] ) { + break; + } + } + return setMatcher( + i > 1 && elementMatcher( matchers ), + i > 1 && toSelector( + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens.slice( 0, i - 1 ).concat({ value: tokens[ i - 2 ].type === " " ? "*" : "" }) + ).replace( rtrim, "$1" ), + matcher, + i < j && matcherFromTokens( tokens.slice( i, j ) ), + j < len && matcherFromTokens( (tokens = tokens.slice( j )) ), + j < len && toSelector( tokens ) + ); + } + matchers.push( matcher ); + } + } + + return elementMatcher( matchers ); +} + +function matcherFromGroupMatchers( elementMatchers, setMatchers ) { + var bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, outermost ) { + var elem, j, matcher, + matchedCount = 0, + i = "0", + unmatched = seed && [], + setMatched = [], + contextBackup = outermostContext, + // We must always have either seed elements or outermost context + elems = seed || byElement && Expr.find["TAG"]( "*", outermost ), + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = (dirruns += contextBackup == null ? 1 : Math.random() || 0.1), + len = elems.length; + + if ( outermost ) { + outermostContext = context === document || context || outermost; + } + + // Add elements passing elementMatchers directly to results + // Support: IE<9, Safari + // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id + for ( ; i !== len && (elem = elems[i]) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + if ( !context && elem.ownerDocument !== document ) { + setDocument( elem ); + xml = !documentIsHTML; + } + while ( (matcher = elementMatchers[j++]) ) { + if ( matcher( elem, context || document, xml) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + } + } + + // Track unmatched elements for set filters + if ( bySet ) { + // They will have gone through all possible matchers + if ( (elem = !matcher && elem) ) { + matchedCount--; + } + + // Lengthen the array for every element, matched or not + if ( seed ) { + unmatched.push( elem ); + } + } + } + + // `i` is now the count of elements visited above, and adding it to `matchedCount` + // makes the latter nonnegative. + matchedCount += i; + + // Apply set filters to unmatched elements + // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` + // equals `i`), unless we didn't visit _any_ elements in the above loop because we have + // no element matchers and no seed. + // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that + // case, which will result in a "00" `matchedCount` that differs from `i` but is also + // numerically zero. + if ( bySet && i !== matchedCount ) { + j = 0; + while ( (matcher = setMatchers[j++]) ) { + matcher( unmatched, setMatched, context, xml ); + } + + if ( seed ) { + // Reintegrate element matches to eliminate the need for sorting + if ( matchedCount > 0 ) { + while ( i-- ) { + if ( !(unmatched[i] || setMatched[i]) ) { + setMatched[i] = pop.call( results ); + } + } + } + + // Discard index placeholder values to get only actual matches + setMatched = condense( setMatched ); + } + + // Add matches to results + push.apply( results, setMatched ); + + // Seedless set matches succeeding multiple successful matchers stipulate sorting + if ( outermost && !seed && setMatched.length > 0 && + ( matchedCount + setMatchers.length ) > 1 ) { + + Sizzle.uniqueSort( results ); + } + } + + // Override manipulation of globals by nested matchers + if ( outermost ) { + dirruns = dirrunsUnique; + outermostContext = contextBackup; + } + + return unmatched; + }; + + return bySet ? + markFunction( superMatcher ) : + superMatcher; +} + +compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { + var i, + setMatchers = [], + elementMatchers = [], + cached = compilerCache[ selector + " " ]; + + if ( !cached ) { + // Generate a function of recursive functions that can be used to check each element + if ( !match ) { + match = tokenize( selector ); + } + i = match.length; + while ( i-- ) { + cached = matcherFromTokens( match[i] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( selector, matcherFromGroupMatchers( elementMatchers, setMatchers ) ); + + // Save selector and tokenization + cached.selector = selector; + } + return cached; +}; + +/** + * A low-level selection function that works with Sizzle's compiled + * selector functions + * @param {String|Function} selector A selector or a pre-compiled + * selector function built with Sizzle.compile + * @param {Element} context + * @param {Array} [results] + * @param {Array} [seed] A set of elements to match against + */ +select = Sizzle.select = function( selector, context, results, seed ) { + var i, tokens, token, type, find, + compiled = typeof selector === "function" && selector, + match = !seed && tokenize( (selector = compiled.selector || selector) ); + + results = results || []; + + // Try to minimize operations if there is only one selector in the list and no seed + // (the latter of which guarantees us context) + if ( match.length === 1 ) { + + // Reduce context if the leading compound selector is an ID + tokens = match[0] = match[0].slice( 0 ); + if ( tokens.length > 2 && (token = tokens[0]).type === "ID" && + context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[1].type ] ) { + + context = ( Expr.find["ID"]( token.matches[0].replace(runescape, funescape), context ) || [] )[0]; + if ( !context ) { + return results; + + // Precompiled matchers will still verify ancestry, so step up a level + } else if ( compiled ) { + context = context.parentNode; + } + + selector = selector.slice( tokens.shift().value.length ); + } + + // Fetch a seed set for right-to-left matching + i = matchExpr["needsContext"].test( selector ) ? 0 : tokens.length; + while ( i-- ) { + token = tokens[i]; + + // Abort if we hit a combinator + if ( Expr.relative[ (type = token.type) ] ) { + break; + } + if ( (find = Expr.find[ type ]) ) { + // Search, expanding context for leading sibling combinators + if ( (seed = find( + token.matches[0].replace( runescape, funescape ), + rsibling.test( tokens[0].type ) && testContext( context.parentNode ) || context + )) ) { + + // If seed is empty or no tokens remain, we can return early + tokens.splice( i, 1 ); + selector = seed.length && toSelector( tokens ); + if ( !selector ) { + push.apply( results, seed ); + return results; + } + + break; + } + } + } + } + + // Compile and execute a filtering function if one is not provided + // Provide `match` to avoid retokenization if we modified the selector above + ( compiled || compile( selector, match ) )( + seed, + context, + !documentIsHTML, + results, + !context || rsibling.test( selector ) && testContext( context.parentNode ) || context + ); + return results; +}; + +// One-time assignments + +// Sort stability +support.sortStable = expando.split("").sort( sortOrder ).join("") === expando; + +// Support: Chrome 14-35+ +// Always assume duplicates if they aren't passed to the comparison function +support.detectDuplicates = !!hasDuplicate; + +// Initialize against the default document +setDocument(); + +// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) +// Detached nodes confoundingly follow *each other* +support.sortDetached = assert(function( el ) { + // Should return 1, but returns 4 (following) + return el.compareDocumentPosition( document.createElement("fieldset") ) & 1; +}); + +// Support: IE<8 +// Prevent attribute/property "interpolation" +// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +if ( !assert(function( el ) { + el.innerHTML = ""; + return el.firstChild.getAttribute("href") === "#" ; +}) ) { + addHandle( "type|href|height|width", function( elem, name, isXML ) { + if ( !isXML ) { + return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); + } + }); +} + +// Support: IE<9 +// Use defaultValue in place of getAttribute("value") +if ( !support.attributes || !assert(function( el ) { + el.innerHTML = ""; + el.firstChild.setAttribute( "value", "" ); + return el.firstChild.getAttribute( "value" ) === ""; +}) ) { + addHandle( "value", function( elem, name, isXML ) { + if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { + return elem.defaultValue; + } + }); +} + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +if ( !assert(function( el ) { + return el.getAttribute("disabled") == null; +}) ) { + addHandle( booleans, function( elem, name, isXML ) { + var val; + if ( !isXML ) { + return elem[ name ] === true ? name.toLowerCase() : + (val = elem.getAttributeNode( name )) && val.specified ? + val.value : + null; + } + }); +} + +return Sizzle; + +})( window ); + + + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; + +// Deprecated +jQuery.expr[ ":" ] = jQuery.expr.pseudos; +jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; +jQuery.escapeSelector = Sizzle.escape; + + + + +var dir = function( elem, dir, until ) { + var matched = [], + truncate = until !== undefined; + + while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { + if ( elem.nodeType === 1 ) { + if ( truncate && jQuery( elem ).is( until ) ) { + break; + } + matched.push( elem ); + } + } + return matched; +}; + + +var siblings = function( n, elem ) { + var matched = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + matched.push( n ); + } + } + + return matched; +}; + + +var rneedsContext = jQuery.expr.match.needsContext; + + + +function nodeName( elem, name ) { + + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + +}; +var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); + + + +var risSimple = /^.[^:#\[\.,]*$/; + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( jQuery.isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + return !!qualifier.call( elem, i, elem ) !== not; + } ); + } + + // Single element + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + } ); + } + + // Arraylike of elements (jQuery, arguments, Array) + if ( typeof qualifier !== "string" ) { + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not; + } ); + } + + // Simple selector that can be filtered directly, removing non-Elements + if ( risSimple.test( qualifier ) ) { + return jQuery.filter( qualifier, elements, not ); + } + + // Complex selector, compare the two sets, removing non-Elements + qualifier = jQuery.filter( qualifier, elements ); + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not && elem.nodeType === 1; + } ); +} + +jQuery.filter = function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + if ( elems.length === 1 && elem.nodeType === 1 ) { + return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; + } + + return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + } ) ); +}; + +jQuery.fn.extend( { + find: function( selector ) { + var i, ret, + len = this.length, + self = this; + + if ( typeof selector !== "string" ) { + return this.pushStack( jQuery( selector ).filter( function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + } ) ); + } + + ret = this.pushStack( [] ); + + for ( i = 0; i < len; i++ ) { + jQuery.find( selector, self[ i ], ret ); + } + + return len > 1 ? jQuery.uniqueSort( ret ) : ret; + }, + filter: function( selector ) { + return this.pushStack( winnow( this, selector || [], false ) ); + }, + not: function( selector ) { + return this.pushStack( winnow( this, selector || [], true ) ); + }, + is: function( selector ) { + return !!winnow( + this, + + // If this is a positional/relative selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + typeof selector === "string" && rneedsContext.test( selector ) ? + jQuery( selector ) : + selector || [], + false + ).length; + } +} ); + + +// Initialize a jQuery object + + +// A central reference to the root jQuery(document) +var rootjQuery, + + // A simple way to check for HTML strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + // Strict HTML recognition (#11290: must start with <) + // Shortcut simple #id case for speed + rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, + + init = jQuery.fn.init = function( selector, context, root ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Method init() accepts an alternate rootjQuery + // so migrate can support jQuery.sub (gh-2101) + root = root || rootjQuery; + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector[ 0 ] === "<" && + selector[ selector.length - 1 ] === ">" && + selector.length >= 3 ) { + + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = rquickExpr.exec( selector ); + } + + // Match html or make sure no context is specified for #id + if ( match && ( match[ 1 ] || !context ) ) { + + // HANDLE: $(html) -> $(array) + if ( match[ 1 ] ) { + context = context instanceof jQuery ? context[ 0 ] : context; + + // Option to run scripts is true for back-compat + // Intentionally let the error be thrown if parseHTML is not present + jQuery.merge( this, jQuery.parseHTML( + match[ 1 ], + context && context.nodeType ? context.ownerDocument || context : document, + true + ) ); + + // HANDLE: $(html, props) + if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { + for ( match in context ) { + + // Properties of context are called as methods if possible + if ( jQuery.isFunction( this[ match ] ) ) { + this[ match ]( context[ match ] ); + + // ...and otherwise set as attributes + } else { + this.attr( match, context[ match ] ); + } + } + } + + return this; + + // HANDLE: $(#id) + } else { + elem = document.getElementById( match[ 2 ] ); + + if ( elem ) { + + // Inject the element directly into the jQuery object + this[ 0 ] = elem; + this.length = 1; + } + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || root ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(DOMElement) + } else if ( selector.nodeType ) { + this[ 0 ] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( jQuery.isFunction( selector ) ) { + return root.ready !== undefined ? + root.ready( selector ) : + + // Execute immediately if ready is not present + selector( jQuery ); + } + + return jQuery.makeArray( selector, this ); + }; + +// Give the init function the jQuery prototype for later instantiation +init.prototype = jQuery.fn; + +// Initialize central reference +rootjQuery = jQuery( document ); + + +var rparentsprev = /^(?:parents|prev(?:Until|All))/, + + // Methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend( { + has: function( target ) { + var targets = jQuery( target, this ), + l = targets.length; + + return this.filter( function() { + var i = 0; + for ( ; i < l; i++ ) { + if ( jQuery.contains( this, targets[ i ] ) ) { + return true; + } + } + } ); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + targets = typeof selectors !== "string" && jQuery( selectors ); + + // Positional selectors never match, since there's no _selection_ context + if ( !rneedsContext.test( selectors ) ) { + for ( ; i < l; i++ ) { + for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { + + // Always skip document fragments + if ( cur.nodeType < 11 && ( targets ? + targets.index( cur ) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector( cur, selectors ) ) ) { + + matched.push( cur ); + break; + } + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); + }, + + // Determine the position of an element within the set + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; + } + + // Index in selector + if ( typeof elem === "string" ) { + return indexOf.call( jQuery( elem ), this[ 0 ] ); + } + + // Locate the position of the desired element + return indexOf.call( this, + + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[ 0 ] : elem + ); + }, + + add: function( selector, context ) { + return this.pushStack( + jQuery.uniqueSort( + jQuery.merge( this.get(), jQuery( selector, context ) ) + ) + ); + }, + + addBack: function( selector ) { + return this.add( selector == null ? + this.prevObject : this.prevObject.filter( selector ) + ); + } +} ); + +function sibling( cur, dir ) { + while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} + return cur; +} + +jQuery.each( { + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, i, until ) { + return dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, i, until ) { + return dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, i, until ) { + return dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return siblings( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return siblings( elem.firstChild ); + }, + contents: function( elem ) { + if ( nodeName( elem, "iframe" ) ) { + return elem.contentDocument; + } + + // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only + // Treat the template element as a regular one in browsers that + // don't support it. + if ( nodeName( elem, "template" ) ) { + elem = elem.content || elem; + } + + return jQuery.merge( [], elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var matched = jQuery.map( this, fn, until ); + + if ( name.slice( -5 ) !== "Until" ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + matched = jQuery.filter( selector, matched ); + } + + if ( this.length > 1 ) { + + // Remove duplicates + if ( !guaranteedUnique[ name ] ) { + jQuery.uniqueSort( matched ); + } + + // Reverse order for parents* and prev-derivatives + if ( rparentsprev.test( name ) ) { + matched.reverse(); + } + } + + return this.pushStack( matched ); + }; +} ); +var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); + + + +// Convert String-formatted options into Object-formatted ones +function createOptions( options ) { + var object = {}; + jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { + object[ flag ] = true; + } ); + return object; +} + +/* + * Create a callback list using the following parameters: + * + * options: an optional list of space-separated options that will change how + * the callback list behaves or a more traditional option object + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible options: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( options ) { + + // Convert options from String-formatted to Object-formatted if needed + // (we check in cache first) + options = typeof options === "string" ? + createOptions( options ) : + jQuery.extend( {}, options ); + + var // Flag to know if list is currently firing + firing, + + // Last fire value for non-forgettable lists + memory, + + // Flag to know if list was already fired + fired, + + // Flag to prevent firing + locked, + + // Actual callback list + list = [], + + // Queue of execution data for repeatable lists + queue = [], + + // Index of currently firing callback (modified by add/remove as needed) + firingIndex = -1, + + // Fire callbacks + fire = function() { + + // Enforce single-firing + locked = locked || options.once; + + // Execute callbacks for all pending executions, + // respecting firingIndex overrides and runtime changes + fired = firing = true; + for ( ; queue.length; firingIndex = -1 ) { + memory = queue.shift(); + while ( ++firingIndex < list.length ) { + + // Run callback and check for early termination + if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && + options.stopOnFalse ) { + + // Jump to end and forget the data so .add doesn't re-fire + firingIndex = list.length; + memory = false; + } + } + } + + // Forget the data if we're done with it + if ( !options.memory ) { + memory = false; + } + + firing = false; + + // Clean up if we're done firing for good + if ( locked ) { + + // Keep an empty list if we have data for future add calls + if ( memory ) { + list = []; + + // Otherwise, this object is spent + } else { + list = ""; + } + } + }, + + // Actual Callbacks object + self = { + + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + + // If we have memory from a past run, we should fire after adding + if ( memory && !firing ) { + firingIndex = list.length - 1; + queue.push( memory ); + } + + ( function add( args ) { + jQuery.each( args, function( _, arg ) { + if ( jQuery.isFunction( arg ) ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && jQuery.type( arg ) !== "string" ) { + + // Inspect recursively + add( arg ); + } + } ); + } )( arguments ); + + if ( memory && !firing ) { + fire(); + } + } + return this; + }, + + // Remove a callback from the list + remove: function() { + jQuery.each( arguments, function( _, arg ) { + var index; + while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + + // Handle firing indexes + if ( index <= firingIndex ) { + firingIndex--; + } + } + } ); + return this; + }, + + // Check if a given callback is in the list. + // If no argument is given, return whether or not list has callbacks attached. + has: function( fn ) { + return fn ? + jQuery.inArray( fn, list ) > -1 : + list.length > 0; + }, + + // Remove all callbacks from the list + empty: function() { + if ( list ) { + list = []; + } + return this; + }, + + // Disable .fire and .add + // Abort any current/pending executions + // Clear all callbacks and values + disable: function() { + locked = queue = []; + list = memory = ""; + return this; + }, + disabled: function() { + return !list; + }, + + // Disable .fire + // Also disable .add unless we have memory (since it would have no effect) + // Abort any pending executions + lock: function() { + locked = queue = []; + if ( !memory && !firing ) { + list = memory = ""; + } + return this; + }, + locked: function() { + return !!locked; + }, + + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( !locked ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + queue.push( args ); + if ( !firing ) { + fire(); + } + } + return this; + }, + + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + +function Identity( v ) { + return v; +} +function Thrower( ex ) { + throw ex; +} + +function adoptValue( value, resolve, reject, noValue ) { + var method; + + try { + + // Check for promise aspect first to privilege synchronous behavior + if ( value && jQuery.isFunction( ( method = value.promise ) ) ) { + method.call( value ).done( resolve ).fail( reject ); + + // Other thenables + } else if ( value && jQuery.isFunction( ( method = value.then ) ) ) { + method.call( value, resolve, reject ); + + // Other non-thenables + } else { + + // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: + // * false: [ value ].slice( 0 ) => resolve( value ) + // * true: [ value ].slice( 1 ) => resolve() + resolve.apply( undefined, [ value ].slice( noValue ) ); + } + + // For Promises/A+, convert exceptions into rejections + // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in + // Deferred#then to conditionally suppress rejection. + } catch ( value ) { + + // Support: Android 4.0 only + // Strict mode functions invoked without .call/.apply get global-object context + reject.apply( undefined, [ value ] ); + } +} + +jQuery.extend( { + + Deferred: function( func ) { + var tuples = [ + + // action, add listener, callbacks, + // ... .then handlers, argument index, [final state] + [ "notify", "progress", jQuery.Callbacks( "memory" ), + jQuery.Callbacks( "memory" ), 2 ], + [ "resolve", "done", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 0, "resolved" ], + [ "reject", "fail", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 1, "rejected" ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + "catch": function( fn ) { + return promise.then( null, fn ); + }, + + // Keep pipe for back-compat + pipe: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + + return jQuery.Deferred( function( newDefer ) { + jQuery.each( tuples, function( i, tuple ) { + + // Map tuples (progress, done, fail) to arguments (done, fail, progress) + var fn = jQuery.isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; + + // deferred.progress(function() { bind to newDefer or newDefer.notify }) + // deferred.done(function() { bind to newDefer or newDefer.resolve }) + // deferred.fail(function() { bind to newDefer or newDefer.reject }) + deferred[ tuple[ 1 ] ]( function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && jQuery.isFunction( returned.promise ) ) { + returned.promise() + .progress( newDefer.notify ) + .done( newDefer.resolve ) + .fail( newDefer.reject ); + } else { + newDefer[ tuple[ 0 ] + "With" ]( + this, + fn ? [ returned ] : arguments + ); + } + } ); + } ); + fns = null; + } ).promise(); + }, + then: function( onFulfilled, onRejected, onProgress ) { + var maxDepth = 0; + function resolve( depth, deferred, handler, special ) { + return function() { + var that = this, + args = arguments, + mightThrow = function() { + var returned, then; + + // Support: Promises/A+ section 2.3.3.3.3 + // https://promisesaplus.com/#point-59 + // Ignore double-resolution attempts + if ( depth < maxDepth ) { + return; + } + + returned = handler.apply( that, args ); + + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError( "Thenable self-resolution" ); + } + + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; + + // Handle a returned thenable + if ( jQuery.isFunction( then ) ) { + + // Special processors (notify) just wait for resolution + if ( special ) { + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ) + ); + + // Normal processors (resolve) also hook into progress + } else { + + // ...and disregard older resolution values + maxDepth++; + + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ), + resolve( maxDepth, deferred, Identity, + deferred.notifyWith ) + ); + } + + // Handle all other returned values + } else { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Identity ) { + that = undefined; + args = [ returned ]; + } + + // Process the value(s) + // Default process is resolve + ( special || deferred.resolveWith )( that, args ); + } + }, + + // Only normal processors (resolve) catch and reject exceptions + process = special ? + mightThrow : + function() { + try { + mightThrow(); + } catch ( e ) { + + if ( jQuery.Deferred.exceptionHook ) { + jQuery.Deferred.exceptionHook( e, + process.stackTrace ); + } + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Thrower ) { + that = undefined; + args = [ e ]; + } + + deferred.rejectWith( that, args ); + } + } + }; + + // Support: Promises/A+ section 2.3.3.3.1 + // https://promisesaplus.com/#point-57 + // Re-resolve promises immediately to dodge false rejection from + // subsequent errors + if ( depth ) { + process(); + } else { + + // Call an optional hook to record the stack, in case of exception + // since it's otherwise lost when execution goes async + if ( jQuery.Deferred.getStackHook ) { + process.stackTrace = jQuery.Deferred.getStackHook(); + } + window.setTimeout( process ); + } + }; + } + + return jQuery.Deferred( function( newDefer ) { + + // progress_handlers.add( ... ) + tuples[ 0 ][ 3 ].add( + resolve( + 0, + newDefer, + jQuery.isFunction( onProgress ) ? + onProgress : + Identity, + newDefer.notifyWith + ) + ); + + // fulfilled_handlers.add( ... ) + tuples[ 1 ][ 3 ].add( + resolve( + 0, + newDefer, + jQuery.isFunction( onFulfilled ) ? + onFulfilled : + Identity + ) + ); + + // rejected_handlers.add( ... ) + tuples[ 2 ][ 3 ].add( + resolve( + 0, + newDefer, + jQuery.isFunction( onRejected ) ? + onRejected : + Thrower + ) + ); + } ).promise(); + }, + + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + return obj != null ? jQuery.extend( obj, promise ) : promise; + } + }, + deferred = {}; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 5 ]; + + // promise.progress = list.add + // promise.done = list.add + // promise.fail = list.add + promise[ tuple[ 1 ] ] = list.add; + + // Handle state + if ( stateString ) { + list.add( + function() { + + // state = "resolved" (i.e., fulfilled) + // state = "rejected" + state = stateString; + }, + + // rejected_callbacks.disable + // fulfilled_callbacks.disable + tuples[ 3 - i ][ 2 ].disable, + + // progress_callbacks.lock + tuples[ 0 ][ 2 ].lock + ); + } + + // progress_handlers.fire + // fulfilled_handlers.fire + // rejected_handlers.fire + list.add( tuple[ 3 ].fire ); + + // deferred.notify = function() { deferred.notifyWith(...) } + // deferred.resolve = function() { deferred.resolveWith(...) } + // deferred.reject = function() { deferred.rejectWith(...) } + deferred[ tuple[ 0 ] ] = function() { + deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); + return this; + }; + + // deferred.notifyWith = list.fireWith + // deferred.resolveWith = list.fireWith + // deferred.rejectWith = list.fireWith + deferred[ tuple[ 0 ] + "With" ] = list.fireWith; + } ); + + // Make the deferred a promise + promise.promise( deferred ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( singleValue ) { + var + + // count of uncompleted subordinates + remaining = arguments.length, + + // count of unprocessed arguments + i = remaining, + + // subordinate fulfillment data + resolveContexts = Array( i ), + resolveValues = slice.call( arguments ), + + // the master Deferred + master = jQuery.Deferred(), + + // subordinate callback factory + updateFunc = function( i ) { + return function( value ) { + resolveContexts[ i ] = this; + resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; + if ( !( --remaining ) ) { + master.resolveWith( resolveContexts, resolveValues ); + } + }; + }; + + // Single- and empty arguments are adopted like Promise.resolve + if ( remaining <= 1 ) { + adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject, + !remaining ); + + // Use .then() to unwrap secondary thenables (cf. gh-3000) + if ( master.state() === "pending" || + jQuery.isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + + return master.then(); + } + } + + // Multiple arguments are aggregated like Promise.all array elements + while ( i-- ) { + adoptValue( resolveValues[ i ], updateFunc( i ), master.reject ); + } + + return master.promise(); + } +} ); + + +// These usually indicate a programmer mistake during development, +// warn about them ASAP rather than swallowing them by default. +var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; + +jQuery.Deferred.exceptionHook = function( error, stack ) { + + // Support: IE 8 - 9 only + // Console exists when dev tools are open, which can happen at any time + if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { + window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); + } +}; + + + + +jQuery.readyException = function( error ) { + window.setTimeout( function() { + throw error; + } ); +}; + + + + +// The deferred used on DOM ready +var readyList = jQuery.Deferred(); + +jQuery.fn.ready = function( fn ) { + + readyList + .then( fn ) + + // Wrap jQuery.readyException in a function so that the lookup + // happens at the time of error handling instead of callback + // registration. + .catch( function( error ) { + jQuery.readyException( error ); + } ); + + return this; +}; + +jQuery.extend( { + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Handle when the DOM is ready + ready: function( wait ) { + + // Abort if there are pending holds or we're already ready + if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { + return; + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.resolveWith( document, [ jQuery ] ); + } +} ); + +jQuery.ready.then = readyList.then; + +// The ready event handler and self cleanup method +function completed() { + document.removeEventListener( "DOMContentLoaded", completed ); + window.removeEventListener( "load", completed ); + jQuery.ready(); +} + +// Catch cases where $(document).ready() is called +// after the browser event has already occurred. +// Support: IE <=9 - 10 only +// Older IE sometimes signals "interactive" too soon +if ( document.readyState === "complete" || + ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { + + // Handle it asynchronously to allow scripts the opportunity to delay ready + window.setTimeout( jQuery.ready ); + +} else { + + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", completed ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", completed ); +} + + + + +// Multifunctional method to get and set values of a collection +// The value/s can optionally be executed if it's a function +var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { + var i = 0, + len = elems.length, + bulk = key == null; + + // Sets many values + if ( jQuery.type( key ) === "object" ) { + chainable = true; + for ( i in key ) { + access( elems, fn, i, key[ i ], true, emptyGet, raw ); + } + + // Sets one value + } else if ( value !== undefined ) { + chainable = true; + + if ( !jQuery.isFunction( value ) ) { + raw = true; + } + + if ( bulk ) { + + // Bulk operations run against the entire set + if ( raw ) { + fn.call( elems, value ); + fn = null; + + // ...except when executing function values + } else { + bulk = fn; + fn = function( elem, key, value ) { + return bulk.call( jQuery( elem ), value ); + }; + } + } + + if ( fn ) { + for ( ; i < len; i++ ) { + fn( + elems[ i ], key, raw ? + value : + value.call( elems[ i ], i, fn( elems[ i ], key ) ) + ); + } + } + } + + if ( chainable ) { + return elems; + } + + // Gets + if ( bulk ) { + return fn.call( elems ); + } + + return len ? fn( elems[ 0 ], key ) : emptyGet; +}; +var acceptData = function( owner ) { + + // Accepts only: + // - Node + // - Node.ELEMENT_NODE + // - Node.DOCUMENT_NODE + // - Object + // - Any + return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); +}; + + + + +function Data() { + this.expando = jQuery.expando + Data.uid++; +} + +Data.uid = 1; + +Data.prototype = { + + cache: function( owner ) { + + // Check if the owner object already has a cache + var value = owner[ this.expando ]; + + // If not, create one + if ( !value ) { + value = {}; + + // We can accept data for non-element nodes in modern browsers, + // but we should not, see #8335. + // Always return an empty object. + if ( acceptData( owner ) ) { + + // If it is a node unlikely to be stringify-ed or looped over + // use plain assignment + if ( owner.nodeType ) { + owner[ this.expando ] = value; + + // Otherwise secure it in a non-enumerable property + // configurable must be true to allow the property to be + // deleted when data is removed + } else { + Object.defineProperty( owner, this.expando, { + value: value, + configurable: true + } ); + } + } + } + + return value; + }, + set: function( owner, data, value ) { + var prop, + cache = this.cache( owner ); + + // Handle: [ owner, key, value ] args + // Always use camelCase key (gh-2257) + if ( typeof data === "string" ) { + cache[ jQuery.camelCase( data ) ] = value; + + // Handle: [ owner, { properties } ] args + } else { + + // Copy the properties one-by-one to the cache object + for ( prop in data ) { + cache[ jQuery.camelCase( prop ) ] = data[ prop ]; + } + } + return cache; + }, + get: function( owner, key ) { + return key === undefined ? + this.cache( owner ) : + + // Always use camelCase key (gh-2257) + owner[ this.expando ] && owner[ this.expando ][ jQuery.camelCase( key ) ]; + }, + access: function( owner, key, value ) { + + // In cases where either: + // + // 1. No key was specified + // 2. A string key was specified, but no value provided + // + // Take the "read" path and allow the get method to determine + // which value to return, respectively either: + // + // 1. The entire cache object + // 2. The data stored at the key + // + if ( key === undefined || + ( ( key && typeof key === "string" ) && value === undefined ) ) { + + return this.get( owner, key ); + } + + // When the key is not a string, or both a key and value + // are specified, set or extend (existing objects) with either: + // + // 1. An object of properties + // 2. A key and value + // + this.set( owner, key, value ); + + // Since the "set" path can have two possible entry points + // return the expected data based on which path was taken[*] + return value !== undefined ? value : key; + }, + remove: function( owner, key ) { + var i, + cache = owner[ this.expando ]; + + if ( cache === undefined ) { + return; + } + + if ( key !== undefined ) { + + // Support array or space separated string of keys + if ( Array.isArray( key ) ) { + + // If key is an array of keys... + // We always set camelCase keys, so remove that. + key = key.map( jQuery.camelCase ); + } else { + key = jQuery.camelCase( key ); + + // If a key with the spaces exists, use it. + // Otherwise, create an array by matching non-whitespace + key = key in cache ? + [ key ] : + ( key.match( rnothtmlwhite ) || [] ); + } + + i = key.length; + + while ( i-- ) { + delete cache[ key[ i ] ]; + } + } + + // Remove the expando if there's no more data + if ( key === undefined || jQuery.isEmptyObject( cache ) ) { + + // Support: Chrome <=35 - 45 + // Webkit & Blink performance suffers when deleting properties + // from DOM nodes, so set to undefined instead + // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) + if ( owner.nodeType ) { + owner[ this.expando ] = undefined; + } else { + delete owner[ this.expando ]; + } + } + }, + hasData: function( owner ) { + var cache = owner[ this.expando ]; + return cache !== undefined && !jQuery.isEmptyObject( cache ); + } +}; +var dataPriv = new Data(); + +var dataUser = new Data(); + + + +// Implementation Summary +// +// 1. Enforce API surface and semantic compatibility with 1.9.x branch +// 2. Improve the module's maintainability by reducing the storage +// paths to a single mechanism. +// 3. Use the same single mechanism to support "private" and "user" data. +// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) +// 5. Avoid exposing implementation details on user objects (eg. expando properties) +// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 + +var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, + rmultiDash = /[A-Z]/g; + +function getData( data ) { + if ( data === "true" ) { + return true; + } + + if ( data === "false" ) { + return false; + } + + if ( data === "null" ) { + return null; + } + + // Only convert to a number if it doesn't change the string + if ( data === +data + "" ) { + return +data; + } + + if ( rbrace.test( data ) ) { + return JSON.parse( data ); + } + + return data; +} + +function dataAttr( elem, key, data ) { + var name; + + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = getData( data ); + } catch ( e ) {} + + // Make sure we set the data so it isn't changed later + dataUser.set( elem, key, data ); + } else { + data = undefined; + } + } + return data; +} + +jQuery.extend( { + hasData: function( elem ) { + return dataUser.hasData( elem ) || dataPriv.hasData( elem ); + }, + + data: function( elem, name, data ) { + return dataUser.access( elem, name, data ); + }, + + removeData: function( elem, name ) { + dataUser.remove( elem, name ); + }, + + // TODO: Now that all calls to _data and _removeData have been replaced + // with direct calls to dataPriv methods, these can be deprecated. + _data: function( elem, name, data ) { + return dataPriv.access( elem, name, data ); + }, + + _removeData: function( elem, name ) { + dataPriv.remove( elem, name ); + } +} ); + +jQuery.fn.extend( { + data: function( key, value ) { + var i, name, data, + elem = this[ 0 ], + attrs = elem && elem.attributes; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = dataUser.get( elem ); + + if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { + i = attrs.length; + while ( i-- ) { + + // Support: IE 11 only + // The attrs elements can be null (#14894) + if ( attrs[ i ] ) { + name = attrs[ i ].name; + if ( name.indexOf( "data-" ) === 0 ) { + name = jQuery.camelCase( name.slice( 5 ) ); + dataAttr( elem, name, data[ name ] ); + } + } + } + dataPriv.set( elem, "hasDataAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each( function() { + dataUser.set( this, key ); + } ); + } + + return access( this, function( value ) { + var data; + + // The calling jQuery object (element matches) is not empty + // (and therefore has an element appears at this[ 0 ]) and the + // `value` parameter was not undefined. An empty jQuery object + // will result in `undefined` for elem = this[ 0 ] which will + // throw an exception if an attempt to read a data cache is made. + if ( elem && value === undefined ) { + + // Attempt to get data from the cache + // The key will always be camelCased in Data + data = dataUser.get( elem, key ); + if ( data !== undefined ) { + return data; + } + + // Attempt to "discover" the data in + // HTML5 custom data-* attrs + data = dataAttr( elem, key ); + if ( data !== undefined ) { + return data; + } + + // We tried really hard, but the data doesn't exist. + return; + } + + // Set the data... + this.each( function() { + + // We always store the camelCased key + dataUser.set( this, key, value ); + } ); + }, null, value, arguments.length > 1, null, true ); + }, + + removeData: function( key ) { + return this.each( function() { + dataUser.remove( this, key ); + } ); + } +} ); + + +jQuery.extend( { + queue: function( elem, type, data ) { + var queue; + + if ( elem ) { + type = ( type || "fx" ) + "queue"; + queue = dataPriv.get( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !queue || Array.isArray( data ) ) { + queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); + } else { + queue.push( data ); + } + } + return queue || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + startLength = queue.length, + fn = queue.shift(), + hooks = jQuery._queueHooks( elem, type ), + next = function() { + jQuery.dequeue( elem, type ); + }; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + startLength--; + } + + if ( fn ) { + + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + // Clear up the last queue stop function + delete hooks.stop; + fn.call( elem, next, hooks ); + } + + if ( !startLength && hooks ) { + hooks.empty.fire(); + } + }, + + // Not public - generate a queueHooks object, or return the current one + _queueHooks: function( elem, type ) { + var key = type + "queueHooks"; + return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { + empty: jQuery.Callbacks( "once memory" ).add( function() { + dataPriv.remove( elem, [ type + "queue", key ] ); + } ) + } ); + } +} ); + +jQuery.fn.extend( { + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[ 0 ], type ); + } + + return data === undefined ? + this : + this.each( function() { + var queue = jQuery.queue( this, type, data ); + + // Ensure a hooks for this queue + jQuery._queueHooks( this, type ); + + if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + } ); + }, + dequeue: function( type ) { + return this.each( function() { + jQuery.dequeue( this, type ); + } ); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, obj ) { + var tmp, + count = 1, + defer = jQuery.Deferred(), + elements = this, + i = this.length, + resolve = function() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + }; + + if ( typeof type !== "string" ) { + obj = type; + type = undefined; + } + type = type || "fx"; + + while ( i-- ) { + tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); + if ( tmp && tmp.empty ) { + count++; + tmp.empty.add( resolve ); + } + } + resolve(); + return defer.promise( obj ); + } +} ); +var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; + +var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); + + +var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; + +var isHiddenWithinTree = function( elem, el ) { + + // isHiddenWithinTree might be called from jQuery#filter function; + // in that case, element will be second argument + elem = el || elem; + + // Inline style trumps all + return elem.style.display === "none" || + elem.style.display === "" && + + // Otherwise, check computed style + // Support: Firefox <=43 - 45 + // Disconnected elements can have computed display: none, so first confirm that elem is + // in the document. + jQuery.contains( elem.ownerDocument, elem ) && + + jQuery.css( elem, "display" ) === "none"; + }; + +var swap = function( elem, options, callback, args ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.apply( elem, args || [] ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + + + +function adjustCSS( elem, prop, valueParts, tween ) { + var adjusted, + scale = 1, + maxIterations = 20, + currentValue = tween ? + function() { + return tween.cur(); + } : + function() { + return jQuery.css( elem, prop, "" ); + }, + initial = currentValue(), + unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), + + // Starting value computation is required for potential unit mismatches + initialInUnit = ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && + rcssNum.exec( jQuery.css( elem, prop ) ); + + if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { + + // Trust units reported by jQuery.css + unit = unit || initialInUnit[ 3 ]; + + // Make sure we update the tween properties later on + valueParts = valueParts || []; + + // Iteratively approximate from a nonzero starting point + initialInUnit = +initial || 1; + + do { + + // If previous iteration zeroed out, double until we get *something*. + // Use string for doubling so we don't accidentally see scale as unchanged below + scale = scale || ".5"; + + // Adjust and apply + initialInUnit = initialInUnit / scale; + jQuery.style( elem, prop, initialInUnit + unit ); + + // Update scale, tolerating zero or NaN from tween.cur() + // Break the loop if scale is unchanged or perfect, or if we've just had enough. + } while ( + scale !== ( scale = currentValue() / initial ) && scale !== 1 && --maxIterations + ); + } + + if ( valueParts ) { + initialInUnit = +initialInUnit || +initial || 0; + + // Apply relative offset (+=/-=) if specified + adjusted = valueParts[ 1 ] ? + initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : + +valueParts[ 2 ]; + if ( tween ) { + tween.unit = unit; + tween.start = initialInUnit; + tween.end = adjusted; + } + } + return adjusted; +} + + +var defaultDisplayMap = {}; + +function getDefaultDisplay( elem ) { + var temp, + doc = elem.ownerDocument, + nodeName = elem.nodeName, + display = defaultDisplayMap[ nodeName ]; + + if ( display ) { + return display; + } + + temp = doc.body.appendChild( doc.createElement( nodeName ) ); + display = jQuery.css( temp, "display" ); + + temp.parentNode.removeChild( temp ); + + if ( display === "none" ) { + display = "block"; + } + defaultDisplayMap[ nodeName ] = display; + + return display; +} + +function showHide( elements, show ) { + var display, elem, + values = [], + index = 0, + length = elements.length; + + // Determine new display value for elements that need to change + for ( ; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + + display = elem.style.display; + if ( show ) { + + // Since we force visibility upon cascade-hidden elements, an immediate (and slow) + // check is required in this first loop unless we have a nonempty display value (either + // inline or about-to-be-restored) + if ( display === "none" ) { + values[ index ] = dataPriv.get( elem, "display" ) || null; + if ( !values[ index ] ) { + elem.style.display = ""; + } + } + if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { + values[ index ] = getDefaultDisplay( elem ); + } + } else { + if ( display !== "none" ) { + values[ index ] = "none"; + + // Remember what we're overwriting + dataPriv.set( elem, "display", display ); + } + } + } + + // Set the display of the elements in a second loop to avoid constant reflow + for ( index = 0; index < length; index++ ) { + if ( values[ index ] != null ) { + elements[ index ].style.display = values[ index ]; + } + } + + return elements; +} + +jQuery.fn.extend( { + show: function() { + return showHide( this, true ); + }, + hide: function() { + return showHide( this ); + }, + toggle: function( state ) { + if ( typeof state === "boolean" ) { + return state ? this.show() : this.hide(); + } + + return this.each( function() { + if ( isHiddenWithinTree( this ) ) { + jQuery( this ).show(); + } else { + jQuery( this ).hide(); + } + } ); + } +} ); +var rcheckableType = ( /^(?:checkbox|radio)$/i ); + +var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]+)/i ); + +var rscriptType = ( /^$|\/(?:java|ecma)script/i ); + + + +// We have to close these tags to support XHTML (#13200) +var wrapMap = { + + // Support: IE <=9 only + option: [ 1, "" ], + + // XHTML parsers do not magically insert elements in the + // same way that tag soup parsers do. So we cannot shorten + // this by omitting or other required elements. + thead: [ 1, "", "
" ], + col: [ 2, "", "
" ], + tr: [ 2, "", "
" ], + td: [ 3, "", "
" ], + + _default: [ 0, "", "" ] +}; + +// Support: IE <=9 only +wrapMap.optgroup = wrapMap.option; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (#15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, contains, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( jQuery.type( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (#12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + contains = jQuery.contains( elem.ownerDocument, elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( contains ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +( function() { + var fragment = document.createDocumentFragment(), + div = fragment.appendChild( document.createElement( "div" ) ), + input = document.createElement( "input" ); + + // Support: Android 4.0 - 4.3 only + // Check state lost if the name is set (#11217) + // Support: Windows Web Apps (WWA) + // `name` and `type` must use .setAttribute for WWA (#14901) + input.setAttribute( "type", "radio" ); + input.setAttribute( "checked", "checked" ); + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + + // Support: Android <=4.1 only + // Older WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE <=11 only + // Make sure textarea (and checkbox) defaultValue is properly cloned + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; +} )(); +var documentElement = document.documentElement; + + + +var + rkeyEvent = /^key/, + rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/, + rtypenamespace = /^([^.]*)(?:\.(.+)|)/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +// Support: IE <=9 only +// See #13393 for more info +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +function on( elem, types, selector, data, fn, one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + on( elem, type, selector, data, types[ type ], one ); + } + return elem; + } + + if ( data == null && fn == null ) { + + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return elem; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return elem.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + } ); +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + + var handleObjIn, eventHandle, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.get( elem ); + + // Don't attach events to noData or text/comment nodes (but allow plain objects) + if ( !elemData ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, selector ); + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !( events = elemData.events ) ) { + events = elemData.events = {}; + } + if ( !( eventHandle = elemData.handle ) ) { + eventHandle = elemData.handle = function( e ) { + + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend( { + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join( "." ) + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !( handlers = events[ type ] ) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || + special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[ 2 ] && + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || + selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || + special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + // Make a writable jQuery.Event from the native event object + var event = jQuery.event.fix( nativeEvent ); + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + handlers = ( dataPriv.get( this, "events" ) || {} )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( ( handleObj = matched.handlers[ j++ ] ) && + !event.isImmediatePropagationStopped() ) { + + // Triggered event must either 1) have no namespace, or 2) have namespace(s) + // a subset or equal to those in the bound event (both can have no namespace). + if ( !event.rnamespace || event.rnamespace.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || + handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( ( event.result = ret ) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: jQuery.isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + focus: { + + // Fire native event if possible so blur/focus sequence is correct + trigger: function() { + if ( this !== safeActiveElement() && this.focus ) { + this.focus(); + return false; + } + }, + delegateType: "focusin" + }, + blur: { + trigger: function() { + if ( this === safeActiveElement() && this.blur ) { + this.blur(); + return false; + } + }, + delegateType: "focusout" + }, + click: { + + // For checkbox, fire native event so checked state will be right + trigger: function() { + if ( this.type === "checkbox" && this.click && nodeName( this, "input" ) ) { + this.click(); + return false; + } + }, + + // For cross-browser consistency, don't fire native .click() on links + _default: function( event ) { + return nodeName( event.target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +jQuery.removeEvent = function( elem, type, handle ) { + + // This "if" is needed for plain objects + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle ); + } +}; + +jQuery.Event = function( src, props ) { + + // Allow instantiation without the 'new' keyword + if ( !( this instanceof jQuery.Event ) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = src.defaultPrevented || + src.defaultPrevented === undefined && + + // Support: Android <=2.3 only + src.returnValue === false ? + returnTrue : + returnFalse; + + // Create target properties + // Support: Safari <=6 - 7 only + // Target should not be a text node (#504, #13143) + this.target = ( src.target && src.target.nodeType === 3 ) ? + src.target.parentNode : + src.target; + + this.currentTarget = src.currentTarget; + this.relatedTarget = src.relatedTarget; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || jQuery.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + constructor: jQuery.Event, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + isSimulated: false, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && !this.isSimulated ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Includes all common event props including KeyEvent and MouseEvent specific props +jQuery.each( { + altKey: true, + bubbles: true, + cancelable: true, + changedTouches: true, + ctrlKey: true, + detail: true, + eventPhase: true, + metaKey: true, + pageX: true, + pageY: true, + shiftKey: true, + view: true, + "char": true, + charCode: true, + key: true, + keyCode: true, + button: true, + buttons: true, + clientX: true, + clientY: true, + offsetX: true, + offsetY: true, + pointerId: true, + pointerType: true, + screenX: true, + screenY: true, + targetTouches: true, + toElement: true, + touches: true, + + which: function( event ) { + var button = event.button; + + // Add which for key events + if ( event.which == null && rkeyEvent.test( event.type ) ) { + return event.charCode != null ? event.charCode : event.keyCode; + } + + // Add which for click: 1 === left; 2 === middle; 3 === right + if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) { + if ( button & 1 ) { + return 1; + } + + if ( button & 2 ) { + return 3; + } + + if ( button & 4 ) { + return 2; + } + + return 0; + } + + return event.which; + } +}, jQuery.event.addProp ); + +// Create mouseenter/leave events using mouseover/out and event-time checks +// so that event delegation works in jQuery. +// Do the same for pointerenter/pointerleave and pointerover/pointerout +// +// Support: Safari 7 only +// Safari sends mouseenter too often; see: +// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 +// for the description of the bug (it existed in older Chrome versions as well). +jQuery.each( { + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mouseenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +} ); + +jQuery.fn.extend( { + + on: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn ); + }, + one: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? + handleObj.origType + "." + handleObj.namespace : + handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each( function() { + jQuery.event.remove( this, types, fn, selector ); + } ); + } +} ); + + +var + + /* eslint-disable max-len */ + + // See https://github.com/eslint/eslint/issues/3229 + rxhtmlTag = /<(?!area|br|col|embed|hr|img|input|link|meta|param)(([a-z][^\/\0>\x20\t\r\n\f]*)[^>]*)\/>/gi, + + /* eslint-enable */ + + // Support: IE <=10 - 11, Edge 12 - 13 + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( ">tbody", elem )[ 0 ] || elem; + } + + return elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + var match = rscriptTypeMasked.exec( elem.type ); + + if ( match ) { + elem.type = match[ 1 ]; + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, pdataCur, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.access( src ); + pdataCur = dataPriv.set( dest, pdataOld ); + events = pdataOld.events; + + if ( events ) { + delete pdataCur.handle; + pdataCur.events = {}; + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = concat.apply( [], args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + isFunction = jQuery.isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( isFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( isFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item + // instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl ) { + jQuery._evalUrl( node.src ); + } + } else { + DOMEval( node.textContent.replace( rcleanScript, "" ), doc ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && jQuery.contains( node.ownerDocument, node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html.replace( rxhtmlTag, "<$1>" ); + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = jQuery.contains( elem.ownerDocument, elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + } ); + }, + + before: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + empty: function() { + var elem, + i = 0; + + for ( ; ( elem = this[ i ] ) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + } ); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = jQuery.htmlPrefilter( value ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch ( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +jQuery.each( { + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rmargin = ( /^margin/ ); + +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (#15098, #14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + div.style.cssText = + "box-sizing:border-box;" + + "position:relative;display:block;" + + "margin:auto;border:1px;padding:1px;" + + "top:1%;width:50%"; + div.innerHTML = ""; + documentElement.appendChild( container ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = divStyle.marginLeft === "2px"; + boxSizingReliableVal = divStyle.width === "4px"; + + // Support: Android 4.0 - 4.3 only + // Some styles come back with percentage values, even though they shouldn't + div.style.marginRight = "50%"; + pixelMarginRightVal = divStyle.marginRight === "4px"; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + var pixelPositionVal, boxSizingReliableVal, pixelMarginRightVal, reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (#8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + container.style.cssText = "border:0;width:8px;height:0;top:0;left:-9999px;" + + "padding:0;margin-top:1px;position:absolute"; + container.appendChild( div ); + + jQuery.extend( support, { + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelMarginRight: function() { + computeStyleTests(); + return pixelMarginRightVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, #12537) + // .css('--customProperty) (#3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + if ( ret === "" && !jQuery.contains( elem.ownerDocument, elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelMarginRight() && rnumnonpx.test( ret ) && rmargin.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }, + + cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style; + +// Return a css property mapped to a potentially vendor prefixed property +function vendorPropName( name ) { + + // Shortcut for names that are not vendor prefixed + if ( name in emptyStyle ) { + return name; + } + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a property mapped along what jQuery.cssProps suggests or to +// a vendor prefixed property. +function finalPropName( name ) { + var ret = jQuery.cssProps[ name ]; + if ( !ret ) { + ret = jQuery.cssProps[ name ] = vendorPropName( name ) || name; + } + return ret; +} + +function setPositiveNumber( elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function augmentWidthOrHeight( elem, name, extra, isBorderBox, styles ) { + var i, + val = 0; + + // If we already have the right measurement, avoid augmentation + if ( extra === ( isBorderBox ? "border" : "content" ) ) { + i = 4; + + // Otherwise initialize for horizontal or vertical properties + } else { + i = name === "width" ? 1 : 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin, so add it if we want it + if ( extra === "margin" ) { + val += jQuery.css( elem, extra + cssExpand[ i ], true, styles ); + } + + if ( isBorderBox ) { + + // border-box includes padding, so remove it if we want content + if ( extra === "content" ) { + val -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // At this point, extra isn't border nor margin, so remove border + if ( extra !== "margin" ) { + val -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } else { + + // At this point, extra isn't content, so add padding + val += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // At this point, extra isn't content nor padding, so add border + if ( extra !== "padding" ) { + val += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + return val; +} + +function getWidthOrHeight( elem, name, extra ) { + + // Start with computed style + var valueIsBorderBox, + styles = getStyles( elem ), + val = curCSS( elem, name, styles ), + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // Computed unit is not pixels. Stop here and return. + if ( rnumnonpx.test( val ) ) { + return val; + } + + // Check for style in case a browser which returns unreliable values + // for getComputedStyle silently falls back to the reliable elem.style + valueIsBorderBox = isBorderBox && + ( support.boxSizingReliable() || val === elem.style[ name ] ); + + // Fall back to offsetWidth/Height when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + if ( val === "auto" ) { + val = elem[ "offset" + name[ 0 ].toUpperCase() + name.slice( 1 ) ]; + } + + // Normalize "", auto, and prepare for extra + val = parseFloat( val ) || 0; + + // Use the active box-sizing model to add/subtract irrelevant styles + return ( val + + augmentWidthOrHeight( + elem, + name, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles + ) + ) + "px"; +} + +jQuery.extend( { + + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "lineHeight": true, + "opacity": true, + "order": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: { + "float": "cssFloat" + }, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = jQuery.camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (#7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug #9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (#7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + if ( type === "number" ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !( "set" in hooks ) || + ( value = hooks.set( elem, value, extra ) ) !== undefined ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + style[ name ] = value; + } + } + + } else { + + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && + ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { + + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = jQuery.camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + // Convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( i, name ) { + jQuery.cssHooks[ name ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, name, extra ); + } ) : + getWidthOrHeight( elem, name, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = extra && getStyles( elem ), + subtract = extra && augmentWidthOrHeight( + elem, + name, + extra, + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + styles + ); + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ name ] = value; + value = jQuery.css( elem, name ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( !rmargin.test( prefix ) ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && + ( tween.elem.style[ jQuery.cssProps[ tween.prop ] ] != null || + jQuery.cssHooks[ tween.prop ] ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = jQuery.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 13 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = jQuery.camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( jQuery.isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + jQuery.proxy( result.stop, result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( jQuery.isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( jQuery.isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + jQuery.isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !jQuery.isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( jQuery.isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue && type !== false ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = jQuery.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ +jQuery.fn.delay = function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; + +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + // Use proper attribute retrieval(#12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://html.spec.whatwg.org/multipage/infrastructure.html#strip-and-collapse-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( jQuery.isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( typeof value === "string" && value ) { + classes = value.match( rnothtmlwhite ) || []; + + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( jQuery.isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + if ( typeof value === "string" && value ) { + classes = value.match( rnothtmlwhite ) || []; + + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) > -1 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value; + + if ( typeof stateVal === "boolean" && type === "string" ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + if ( jQuery.isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + return this.each( function() { + var className, i, self, classNames; + + if ( type === "string" ) { + + // Toggle individual class names + i = 0; + self = jQuery( this ); + classNames = value.match( rnothtmlwhite ) || []; + + while ( ( className = classNames[ i++ ] ) ) { + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", className ); + } + + // If the element has a class name or if we're passed `false`, + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, isFunction, + elem = this[ 0 ]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || + jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && + "get" in hooks && + ( ret = hooks.get( elem, "value" ) ) !== undefined + ) { + return ret; + } + + ret = elem.value; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + isFunction = jQuery.isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( isFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.isArray( val ) ) { + val = jQuery.map( val, function( value ) { + return value == null ? "" : value + ""; + } ); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + } ); + } +} ); + +jQuery.extend( { + valHooks: { + option: { + get: function( elem ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (#14686, #14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-9 doesn't update selected after form reset (#2551) + if ( ( option.selected || i === index ) && + + // Don't return options that are disabled or in a disabled optgroup + !option.disabled && + ( !option.parentNode.disabled || + !nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "." ) > -1 ) { + + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split( "." ); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf( ":" ) < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join( "." ); + event.rnamespace = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !jQuery.isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === ( elem.ownerDocument || document ) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { + + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( dataPriv.get( cur, "events" ) || {} )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( ( !special._default || + special._default.apply( eventPath.pop(), data ) === false ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && jQuery.isFunction( elem[ type ] ) && !jQuery.isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + elem[ type ](); + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + trigger: function( type, data ) { + return this.each( function() { + jQuery.event.trigger( type, data, this ); + } ); + }, + triggerHandler: function( type, data ) { + var elem = this[ 0 ]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +} ); + + +jQuery.each( ( "blur focus focusin focusout resize scroll click dblclick " + + "mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave " + + "change select submit keydown keypress keyup contextmenu" ).split( " " ), + function( i, name ) { + + // Handle event binding + jQuery.fn[ name ] = function( data, fn ) { + return arguments.length > 0 ? + this.on( name, null, data, fn ) : + this.trigger( name ); + }; +} ); + +jQuery.fn.extend( { + hover: function( fnOver, fnOut ) { + return this.mouseenter( fnOver ).mouseleave( fnOut || fnOver ); + } +} ); + + + + +support.focusin = "onfocusin" in window; + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + var doc = this.ownerDocument || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = jQuery.now(); + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE 9 - 11 only + // IE throws on parseFromString with invalid input. + try { + xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); + } catch ( e ) { + xml = undefined; + } + + if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) { + jQuery.error( "Invalid XML: " + data ); + } + return xml; +}; + + +var + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, + rsubmittable = /^(?:input|select|textarea|keygen)/i; + +function buildParams( prefix, obj, traditional, add ) { + var name; + + if ( Array.isArray( obj ) ) { + + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + + // Item is non-scalar (array or object), encode its numeric index. + buildParams( + prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", + v, + traditional, + add + ); + } + } ); + + } else if ( !traditional && jQuery.type( obj ) === "object" ) { + + // Serialize object item. + for ( name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + + // Serialize scalar item. + add( prefix, obj ); + } +} + +// Serialize an array of form elements or a set of +// key/values into a query string +jQuery.param = function( a, traditional ) { + var prefix, + s = [], + add = function( key, valueOrFunction ) { + + // If value is a function, invoke it and use its return value + var value = jQuery.isFunction( valueOrFunction ) ? + valueOrFunction() : + valueOrFunction; + + s[ s.length ] = encodeURIComponent( key ) + "=" + + encodeURIComponent( value == null ? "" : value ); + }; + + // If an array was passed in, assume that it is an array of form elements. + if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + } ); + + } else { + + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ); +}; + +jQuery.fn.extend( { + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + serializeArray: function() { + return this.map( function() { + + // Can add propHook for "elements" to filter or add form elements + var elements = jQuery.prop( this, "elements" ); + return elements ? jQuery.makeArray( elements ) : this; + } ) + .filter( function() { + var type = this.type; + + // Use .is( ":disabled" ) so that fieldset[disabled] works + return this.name && !jQuery( this ).is( ":disabled" ) && + rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && + ( this.checked || !rcheckableType.test( type ) ); + } ) + .map( function( i, elem ) { + var val = jQuery( this ).val(); + + if ( val == null ) { + return null; + } + + if ( Array.isArray( val ) ) { + return jQuery.map( val, function( val ) { + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ); + } + + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ).get(); + } +} ); + + +var + r20 = /%20/g, + rhash = /#.*$/, + rantiCache = /([?&])_=[^&]*/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, + + // #7653, #8125, #8152: local protocol detection + rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression + allTypes = "*/".concat( "*" ), + + // Anchor tag for parsing the document origin + originAnchor = document.createElement( "a" ); + originAnchor.href = location.href; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + var dataType, + i = 0, + dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; + + if ( jQuery.isFunction( func ) ) { + + // For each dataType in the dataTypeExpression + while ( ( dataType = dataTypes[ i++ ] ) ) { + + // Prepend if requested + if ( dataType[ 0 ] === "+" ) { + dataType = dataType.slice( 1 ) || "*"; + ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); + + // Otherwise append + } else { + ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); + } + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { + + var inspected = {}, + seekingTransport = ( structure === transports ); + + function inspect( dataType ) { + var selected; + inspected[ dataType ] = true; + jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { + var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); + if ( typeof dataTypeOrTransport === "string" && + !seekingTransport && !inspected[ dataTypeOrTransport ] ) { + + options.dataTypes.unshift( dataTypeOrTransport ); + inspect( dataTypeOrTransport ); + return false; + } else if ( seekingTransport ) { + return !( selected = dataTypeOrTransport ); + } + } ); + return selected; + } + + return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes #9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } + + return target; +} + +/* Handles responses to an ajax request: + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var ct, type, finalDataType, firstDataType, + contents = s.contents, + dataTypes = s.dataTypes; + + // Remove auto dataType and get content-type in the process + while ( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +/* Chain conversions given the request and the original response + * Also sets the responseXXX fields on the jqXHR instance + */ +function ajaxConvert( s, response, jqXHR, isSuccess ) { + var conv2, current, conv, tmp, prev, + converters = {}, + + // Work with a copy of dataTypes in case we need to modify it for conversion + dataTypes = s.dataTypes.slice(); + + // Create converters map with lowercased keys + if ( dataTypes[ 1 ] ) { + for ( conv in s.converters ) { + converters[ conv.toLowerCase() ] = s.converters[ conv ]; + } + } + + current = dataTypes.shift(); + + // Convert to each sequential dataType + while ( current ) { + + if ( s.responseFields[ current ] ) { + jqXHR[ s.responseFields[ current ] ] = response; + } + + // Apply the dataFilter if provided + if ( !prev && isSuccess && s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + prev = current; + current = dataTypes.shift(); + + if ( current ) { + + // There's only work to do if current dataType is non-auto + if ( current === "*" ) { + + current = prev; + + // Convert response if prev dataType is non-auto and differs from current + } else if ( prev !== "*" && prev !== current ) { + + // Seek a direct converter + conv = converters[ prev + " " + current ] || converters[ "* " + current ]; + + // If none found, seek a pair + if ( !conv ) { + for ( conv2 in converters ) { + + // If conv2 outputs current + tmp = conv2.split( " " ); + if ( tmp[ 1 ] === current ) { + + // If prev can be converted to accepted input + conv = converters[ prev + " " + tmp[ 0 ] ] || + converters[ "* " + tmp[ 0 ] ]; + if ( conv ) { + + // Condense equivalence converters + if ( conv === true ) { + conv = converters[ conv2 ]; + + // Otherwise, insert the intermediate dataType + } else if ( converters[ conv2 ] !== true ) { + current = tmp[ 0 ]; + dataTypes.unshift( tmp[ 1 ] ); + } + break; + } + } + } + } + + // Apply converter (if not an equivalence) + if ( conv !== true ) { + + // Unless errors are allowed to bubble, catch and return them + if ( conv && s.throws ) { + response = conv( response ); + } else { + try { + response = conv( response ); + } catch ( e ) { + return { + state: "parsererror", + error: conv ? e : "No conversion from " + prev + " to " + current + }; + } + } + } + } + } + } + + return { state: "success", data: response }; +} + +jQuery.extend( { + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {}, + + ajaxSettings: { + url: location.href, + type: "GET", + isLocal: rlocalProtocol.test( location.protocol ), + global: true, + processData: true, + async: true, + contentType: "application/x-www-form-urlencoded; charset=UTF-8", + + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + throws: false, + traditional: false, + headers: {}, + */ + + accepts: { + "*": allTypes, + text: "text/plain", + html: "text/html", + xml: "application/xml, text/xml", + json: "application/json, text/javascript" + }, + + contents: { + xml: /\bxml\b/, + html: /\bhtml/, + json: /\bjson\b/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText", + json: "responseJSON" + }, + + // Data converters + // Keys separate source (or catchall "*") and destination types with a single space + converters: { + + // Convert anything to text + "* text": String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": JSON.parse, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + url: true, + context: true + } + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + return settings ? + + // Building a settings object + ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : + + // Extending ajaxSettings + ajaxExtend( jQuery.ajaxSettings, target ); + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var transport, + + // URL without anti-cache param + cacheURL, + + // Response headers + responseHeadersString, + responseHeaders, + + // timeout handle + timeoutTimer, + + // Url cleanup var + urlAnchor, + + // Request state (becomes false upon send and true upon completion) + completed, + + // To know if global events are to be dispatched + fireGlobals, + + // Loop variable + i, + + // uncached part of the url + uncached, + + // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + + // Callbacks context + callbackContext = s.context || s, + + // Context for global events is callbackContext if it is a DOM node or jQuery collection + globalEventContext = s.context && + ( callbackContext.nodeType || callbackContext.jquery ) ? + jQuery( callbackContext ) : + jQuery.event, + + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + + // Status-dependent callbacks + statusCode = s.statusCode || {}, + + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + + // Default abort message + strAbort = "canceled", + + // Fake xhr + jqXHR = { + readyState: 0, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( completed ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while ( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[ 1 ].toLowerCase() ] = match[ 2 ]; + } + } + match = responseHeaders[ key.toLowerCase() ]; + } + return match == null ? null : match; + }, + + // Raw string + getAllResponseHeaders: function() { + return completed ? responseHeadersString : null; + }, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( completed == null ) { + name = requestHeadersNames[ name.toLowerCase() ] = + requestHeadersNames[ name.toLowerCase() ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( completed == null ) { + s.mimeType = type; + } + return this; + }, + + // Status-dependent callbacks + statusCode: function( map ) { + var code; + if ( map ) { + if ( completed ) { + + // Execute the appropriate callbacks + jqXHR.always( map[ jqXHR.status ] ); + } else { + + // Lazy-add the new callbacks in a way that preserves old ones + for ( code in map ) { + statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; + } + } + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + var finalText = statusText || strAbort; + if ( transport ) { + transport.abort( finalText ); + } + done( 0, finalText ); + return this; + } + }; + + // Attach deferreds + deferred.promise( jqXHR ); + + // Add protocol if not provided (prefilters might expect it) + // Handle falsy url in the settings object (#10093: consistency with old signature) + // We also use the url parameter if available + s.url = ( ( url || s.url || location.href ) + "" ) + .replace( rprotocol, location.protocol + "//" ); + + // Alias method option to type as per ticket #12004 + s.type = options.method || options.type || s.method || s.type; + + // Extract dataTypes list + s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; + + // A cross-domain request is in order when the origin doesn't match the current origin. + if ( s.crossDomain == null ) { + urlAnchor = document.createElement( "a" ); + + // Support: IE <=8 - 11, Edge 12 - 13 + // IE throws exception on accessing the href property if url is malformed, + // e.g. http://example.com:80x/ + try { + urlAnchor.href = s.url; + + // Support: IE <=8 - 11 only + // Anchor's host property isn't correctly set when s.url is relative + urlAnchor.href = urlAnchor.href; + s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== + urlAnchor.protocol + "//" + urlAnchor.host; + } catch ( e ) { + + // If there is an error parsing the URL, assume it is crossDomain, + // it can be rejected by the transport if it is invalid + s.crossDomain = true; + } + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefilter, stop there + if ( completed ) { + return jqXHR; + } + + // We can fire global events as of now if asked to + // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) + fireGlobals = jQuery.event && s.global; + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Save the URL in case we're toying with the If-Modified-Since + // and/or If-None-Match header later on + // Remove hash to simplify url manipulation + cacheURL = s.url.replace( rhash, "" ); + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // Remember the hash so we can put it back + uncached = s.url.slice( cacheURL.length ); + + // If data is available, append data to url + if ( s.data ) { + cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; + + // #9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Add or update anti-cache param if needed + if ( s.cache === false ) { + cacheURL = cacheURL.replace( rantiCache, "$1" ); + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce++ ) + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( jQuery.isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + + +jQuery._evalUrl = function( url ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (#11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + "throws": true + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( jQuery.isFunction( html ) ) { + html = html.call( this[ 0 ] ); + } + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map( function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + } ).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( jQuery.isFunction( html ) ) { + return this.each( function( i ) { + jQuery( this ).wrapInner( html.call( this, i ) ); + } ); + } + + return this.each( function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + } ); + }, + + wrap: function( html ) { + var isFunction = jQuery.isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( isFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // #1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see #8605, #14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // #14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain requests + if ( s.crossDomain ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( " + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

com package

+
+

Subpackages

+
+ +
+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/com.vmware.html b/nsx/nsx/com.vmware.html new file mode 100644 index 00000000..94f8c64c --- /dev/null +++ b/nsx/nsx/com.vmware.html @@ -0,0 +1,8947 @@ + + + + + + + + + + + com.vmware package — NSX-T SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

com.vmware package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.nsx_client module

+
+
+class com.vmware.nsx_client.Associations(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+LIST_ASSOCIATED_RESOURCE_TYPE_NSGROUP = 'NSGroup'
+

Possible value for associatedResourceType of method +Associations.list().

+
+ +
+
+LIST_RESOURCE_TYPE_DIRECTORYGROUP = 'DirectoryGroup'
+

Possible value for resourceType of method Associations.list().

+
+ +
+
+LIST_RESOURCE_TYPE_IPSET = 'IPSet'
+

Possible value for resourceType of method Associations.list().

+
+ +
+
+LIST_RESOURCE_TYPE_LOGICALPORT = 'LogicalPort'
+

Possible value for resourceType of method Associations.list().

+
+ +
+
+LIST_RESOURCE_TYPE_LOGICALSWITCH = 'LogicalSwitch'
+

Possible value for resourceType of method Associations.list().

+
+ +
+
+LIST_RESOURCE_TYPE_MACSET = 'MACSet'
+

Possible value for resourceType of method Associations.list().

+
+ +
+
+LIST_RESOURCE_TYPE_NSGROUP = 'NSGroup'
+

Possible value for resourceType of method Associations.list().

+
+ +
+
+LIST_RESOURCE_TYPE_VIRTUALMACHINE = 'VirtualMachine'
+

Possible value for resourceType of method Associations.list().

+
+ +
+
+list(associated_resource_type, resource_id, resource_type, cursor=None, fetch_ancestors=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Returns information about resources that are associated with the given +resource. Id and type of the resource for which associated resources +are to be fetched are to be specified as query parameter in the URI. +Resource type of the associated resources must be specified as query +parameter.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • associated_resource_type (str) – Resource type valid for use as target in association API (required)
    • +
  • resource_id (str) – The resource for which associated resources are to be fetched +(required)
    • +
  • resource_type (str) – Resource type valid for use as source in association API (required)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • fetch_ancestors (bool or None) – Fetch complete list of associated resources considering containment +and nesting (optional, default to false)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.AssociationListResult

+
Returns:

com.vmware.nsx.model.AssociationListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx_client.Batch(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(batch_request, atomic=None)
+

Enables you to make multiple API requests using a single request. The +batch API takes in an array of logical HTTP requests represented as +JSON arrays. Each request has a method (GET, PUT, POST, or DELETE), a +relative_url (the portion of the URL after https://<nsx-mgr>/api/), +optional headers array (corresponding to HTTP headers) and an optional +body (for POST and PUT requests). The batch API returns an array of +logical HTTP responses represented as JSON arrays. Each response has a +status code, an optional headers array and an optional body (which is a +JSON-encoded string).

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • batch_request (com.vmware.nsx.model_client.BatchRequest) – (required)
    • +
  • atomic (bool or None) – transactional atomicity for the batch of requests embedded in the +batch list (optional, default to false)
    • +
+
Return type:

com.vmware.nsx.model_client.BatchResponse

+
Returns:

com.vmware.nsx.model.BatchResponse

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx_client.BridgeClusters(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(bridge_cluster)
+

Creates a bridge cluster. It is collection of transport nodes that will +do the bridging for overlay network to vlan networks. Bridge cluster +may have one or more transport nodes

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:bridge_cluster (com.vmware.nsx.model_client.BridgeCluster) – (required)
Return type:com.vmware.nsx.model_client.BridgeCluster
Returns:com.vmware.nsx.model.BridgeCluster
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(bridgecluster_id)
+

Removes the specified Bridge Cluster.

+ +++ + + + + + + + + + + + + + +
Parameters:bridgecluster_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(bridgecluster_id)
+

Returns information about a specified bridge cluster.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:bridgecluster_id (str) – (required)
Return type:com.vmware.nsx.model_client.BridgeCluster
Returns:com.vmware.nsx.model.BridgeCluster
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Returns information about all configured bridge clusters

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.BridgeClusterListResult

+
Returns:

com.vmware.nsx.model.BridgeClusterListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(bridgecluster_id, bridge_cluster)
+

Modifies a existing bridge cluster. One of more transport nodes can be +added or removed from the bridge cluster using this API.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.BridgeCluster

+
Returns:

com.vmware.nsx.model.BridgeCluster

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx_client.BridgeEndpointProfiles(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(bridge_endpoint_profile)
+

Creates a Bridge Endpoint Profile. Profile contains edge cluster id, +indexes of the member nodes, fialover mode and high availability mode +for a Bridge EndPoint

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:bridge_endpoint_profile (com.vmware.nsx.model_client.BridgeEndpointProfile) – (required)
Return type:com.vmware.nsx.model_client.BridgeEndpointProfile
Returns:com.vmware.nsx.model.BridgeEndpointProfile
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(bridgeendpointprofile_id)
+

Deletes the specified Bridge Endpoint Profile.

+ +++ + + + + + + + + + + + + + +
Parameters:bridgeendpointprofile_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(bridgeendpointprofile_id)
+

Returns information about a specified bridge endpoint profile.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:bridgeendpointprofile_id (str) – (required)
Return type:com.vmware.nsx.model_client.BridgeEndpointProfile
Returns:com.vmware.nsx.model.BridgeEndpointProfile
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, edge_cluster_id=None, failover_mode=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Returns information about all configured bridge endoint profiles

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • edge_cluster_id (str or None) – Edge Cluster Identifier (optional)
    • +
  • failover_mode (str or None) – (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.BridgeEndpointProfileListResult

+
Returns:

com.vmware.nsx.model.BridgeEndpointProfileListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(bridgeendpointprofile_id, bridge_endpoint_profile)
+

Modifies a existing bridge endpoint profile.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.BridgeEndpointProfile

+
Returns:

com.vmware.nsx.model.BridgeEndpointProfile

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx_client.BridgeEndpoints(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(bridge_endpoint)
+

Creates a Bridge Endpoint. It describes the physical attributes of the +bridge like vlan. A logical port can be attached to a vif providing +bridging functionality from the logical overlay network to the physical +vlan network

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:bridge_endpoint (com.vmware.nsx.model_client.BridgeEndpoint) – (required)
Return type:com.vmware.nsx.model_client.BridgeEndpoint
Returns:com.vmware.nsx.model.BridgeEndpoint
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(bridgeendpoint_id)
+

Deletes the specified Bridge Endpoint.

+ +++ + + + + + + + + + + + + + +
Parameters:bridgeendpoint_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(bridgeendpoint_id)
+

Returns information about a specified bridge endpoint.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:bridgeendpoint_id (str) – (required)
Return type:com.vmware.nsx.model_client.BridgeEndpoint
Returns:com.vmware.nsx.model.BridgeEndpoint
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(bridge_cluster_id=None, bridge_endpoint_profile_id=None, cursor=None, included_fields=None, logical_switch_id=None, page_size=None, sort_ascending=None, sort_by=None, vlan_transport_zone_id=None)
+

Returns information about all configured bridge endoints

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • bridge_cluster_id (str or None) – Bridge Cluster Identifier (optional)
    • +
  • bridge_endpoint_profile_id (str or None) – Bridge endpoint profile used by the edge cluster (optional)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • logical_switch_id (str or None) – Logical Switch Identifier (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
  • vlan_transport_zone_id (str or None) – VLAN transport zone id used by the edge cluster (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.BridgeEndpointListResult

+
Returns:

com.vmware.nsx.model.BridgeEndpointListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(bridgeendpoint_id, bridge_endpoint)
+

Modifies a existing bridge endpoint.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.BridgeEndpoint

+
Returns:

com.vmware.nsx.model.BridgeEndpoint

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx_client.Cluster(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+backuptoremote()
+

Request one-time backup. The backup will be uploaded using the same +server configuration as for automatic backup.

+ +++ + + + + + + + + + + + +
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+create(target_node_id, target_uri)
+

Invoke POST request on target cluster node

+ +++ + + + + + + + + + + + + + + + +
Parameters:
    +
  • target_node_id (str) – Target node UUID or keyword self (required)
    • +
  • target_uri (str) – URI of API to invoke on target node (required)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.TimedOut +Gateway Timeout

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+delete(target_node_id, target_uri)
+

Invoke DELETE request on target cluster node

+ +++ + + + + + + + + + + + + + + + +
Parameters:
    +
  • target_node_id (str) – Target node UUID or keyword self (required)
    • +
  • target_uri (str) – URI of API to invoke on target node (required)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.TimedOut +Gateway Timeout

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get()
+

Returns information about the NSX cluster configuration. An NSX cluster +has two functions or purposes, commonly referred to as "roles." +These two roles are control and management. Each NSX installation has a +single cluster. Separate NSX clusters do not share data. In other +words, a given data-plane node is attached to only one cluster, not to +multiple clusters.

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.ClusterConfig
Returns:com.vmware.nsx.model.ClusterConfig
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get_0(target_node_id, target_uri)
+

Invoke GET request on target cluster node

+ +++ + + + + + + + + + + + + + + + +
Parameters:
    +
  • target_node_id (str) – Target node UUID or keyword self (required)
    • +
  • target_uri (str) – URI of API to invoke on target node (required)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.TimedOut +Gateway Timeout

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+summarizeinventorytoremote()
+

Request one-time inventory summary. The backup will be uploaded using +the same server configuration as for an automatic backup.

+ +++ + + + + + + + + + + + +
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+update(target_node_id, target_uri)
+

Invoke PUT request on target cluster node

+ +++ + + + + + + + + + + + + + + + +
Parameters:
    +
  • target_node_id (str) – Target node UUID or keyword self (required)
    • +
  • target_uri (str) – URI of API to invoke on target node (required)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.TimedOut +Gateway Timeout

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx_client.ClusterProfiles(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+LIST_RESOURCE_TYPE_BRIDGEHIGHAVAILABILITYCLUSTERPROFILE = 'BridgeHighAvailabilityClusterProfile'
+

Possible value for resourceType of method ClusterProfiles.list().

+
+ +
+
+LIST_RESOURCE_TYPE_EDGEHIGHAVAILABILITYPROFILE = 'EdgeHighAvailabilityProfile'
+

Possible value for resourceType of method ClusterProfiles.list().

+
+ +
+
+create(cluster_profile)
+

Create a cluster profile. The resource_type is required.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:cluster_profile (vmware.vapi.struct.VapiStruct) – (required) +The parameter must contain all the attributes defined in +com.vmware.nsx.model_client.ClusterProfile.
Return type:vmware.vapi.struct.VapiStruct
Returns:com.vmware.nsx.model.ClusterProfile +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.ClusterProfile.
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(cluster_profile_id)
+

Delete a specified cluster profile.

+ +++ + + + + + + + + + + + + + +
Parameters:cluster_profile_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(cluster_profile_id)
+

Returns information about a specified cluster profile.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:cluster_profile_id (str) – (required)
Return type:vmware.vapi.struct.VapiStruct
Returns:com.vmware.nsx.model.ClusterProfile +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.ClusterProfile.
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, include_system_owned=None, included_fields=None, page_size=None, resource_type=None, sort_ascending=None, sort_by=None)
+

Returns paginated list of cluster profiles Cluster profiles define +policies for edge cluster and bridge cluster.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • include_system_owned (bool or None) – Whether the list result contains system resources (optional, +default to true)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • resource_type (str or None) – Supported cluster profiles. (optional)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.ClusterProfileListResult

+
Returns:

com.vmware.nsx.model.ClusterProfileListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(cluster_profile_id, cluster_profile)
+

Modifie a specified cluster profile. The body of the PUT request must +include the resource_type.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cluster_profile_id (str) – (required)
    • +
  • cluster_profile (vmware.vapi.struct.VapiStruct) – (required) +The parameter must contain all the attributes defined in +com.vmware.nsx.model_client.ClusterProfile.
    • +
+
Return type:

vmware.vapi.struct.VapiStruct

+
Returns:

com.vmware.nsx.model.ClusterProfile +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.ClusterProfile.

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx_client.ComputeCollectionTransportNodeTemplates(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(compute_collection_transport_node_template)
+

If automated transport node creation is configured on compute +collection, this template will serve as the default setting for +transport node creation.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:compute_collection_transport_node_template (com.vmware.nsx.model_client.ComputeCollectionTransportNodeTemplate) – (required)
Return type:com.vmware.nsx.model_client.ComputeCollectionTransportNodeTemplate
Returns:com.vmware.nsx.model.ComputeCollectionTransportNodeTemplate
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(template_id)
+

Delete the specified compute collection transport node template.

+ +++ + + + + + + + + + + + + + +
Parameters:template_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(template_id)
+

Returns compute collection transportnode template by id

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:template_id (str) – (required)
Return type:com.vmware.nsx.model_client.ComputeCollectionTransportNodeTemplate
Returns:com.vmware.nsx.model.ComputeCollectionTransportNodeTemplate
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(compute_collection_id=None)
+

Returns all eligible compute collection transportnode templates

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:compute_collection_id (str or None) – Compute collection id (optional)
Return type:com.vmware.nsx.model_client.TransportNodeTemplateListResult
Returns:com.vmware.nsx.model.TransportNodeTemplateListResult
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+update(template_id, compute_collection_transport_node_template)
+

Update configuration of compute collection transportnode template. +Compute_collection_id isn’t allowed to be changed since it represents +the association between ComputeCollection and this template. This is +determined when ComputeCollectionTransportNodeTemplate got created.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.ComputeCollectionTransportNodeTemplate

+
Returns:

com.vmware.nsx.model.ComputeCollectionTransportNodeTemplate

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx_client.EdgeClusters(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(edge_cluster)
+

Creates a new edge cluster. It only supports homogeneous members. The +TransportNodes backed by EdgeNode are only allowed in cluster members. +DeploymentType (VIRTUAL_MACHINE|PHYSICAL_MACHINE) of these EdgeNodes is +recommended to be the same. EdgeCluster supports members of different +deployment types.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:edge_cluster (com.vmware.nsx.model_client.EdgeCluster) – (required)
Return type:com.vmware.nsx.model_client.EdgeCluster
Returns:com.vmware.nsx.model.EdgeCluster
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(edge_cluster_id)
+

Deletes the specified edge cluster.

+ +++ + + + + + + + + + + + + + +
Parameters:edge_cluster_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(edge_cluster_id)
+

Returns information about the specified edge cluster.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:edge_cluster_id (str) – (required)
Return type:com.vmware.nsx.model_client.EdgeCluster
Returns:com.vmware.nsx.model.EdgeCluster
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Returns information about the configured edge clusters, which enable +you to group together transport nodes of the type EdgeNode and apply +fabric profiles to all members of the edge cluster. Each edge node can +participate in only one edge cluster.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.EdgeClusterListResult

+
Returns:

com.vmware.nsx.model.EdgeClusterListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+replacetransportnode(edge_cluster_id, edge_cluster_member_transport_node)
+

Replace the transport node in the specified member of the edge-cluster. +This is a disruptive action. This will move all the +LogicalRouterPorts(uplink and routerLink) host on the old +transport_node to the new transport_node. The transportNode cannot be +present in another member of any edgeClusters.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.EdgeCluster

+
Returns:

com.vmware.nsx.model.EdgeCluster

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(edge_cluster_id, edge_cluster)
+

Modifies the specified edge cluster. Modifiable parameters include the +description, display_name, transport-node-id. If the optional +fabric_profile_binding is included, resource_type and profile_id are +required. User should do a GET on the edge-cluster and obtain the +payload and retain the member_index of the existing members as +returning in the GET output. For new member additions, the member_index +cannot be defined by the user, user can read the system allocated index +to the new member in the output of this API call or by doing a GET +call. User cannot use this PUT api to replace the transport_node of an +existing member because this is a disruption action, we have exposed a +explicit API for doing so, refer to +"ReplaceEdgeClusterMemberTransportNode" EdgeCluster only +supports homogeneous members. The TransportNodes backed by EdgeNode are +only allowed in cluster members. DeploymentType +(VIRTUAL_MACHINE|PHYSICAL_MACHINE) of these EdgeNodes is recommended to +be the same. EdgeCluster supports members of different deployment +types.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.EdgeCluster

+
Returns:

com.vmware.nsx.model.EdgeCluster

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx_client.ErrorResolver(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(error_id)
+

Returns some metadata about the given error_id. This includes +information of whether there is a resolver present for the given +error_id and its associated user input data

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:error_id (str) – (required)
Return type:com.vmware.nsx.model_client.ErrorResolverInfo
Returns:com.vmware.nsx.model.ErrorResolverInfo
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list()
+

Returns a list of metadata for all the error resolvers registered.

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.ErrorResolverInfoList
Returns:com.vmware.nsx.model.ErrorResolverInfoList
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+resolveerror(error_resolver_metadata_list)
+

Invokes the corresponding error resolver for the given error(s) present +in the payload

+ +++ + + + + + + + + + + + + + +
Parameters:error_resolver_metadata_list (com.vmware.nsx.model_client.ErrorResolverMetadataList) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx_client.HostSwitchProfiles(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+LIST_HOSTSWITCH_PROFILE_TYPE_EXTRACONFIGHOSTSWITCHPROFILE = 'ExtraConfigHostSwitchProfile'
+

Possible value for hostswitchProfileType of method +HostSwitchProfiles.list().

+
+ +
+
+LIST_HOSTSWITCH_PROFILE_TYPE_LLDPHOSTSWITCHPROFILE = 'LldpHostSwitchProfile'
+

Possible value for hostswitchProfileType of method +HostSwitchProfiles.list().

+
+ +
+
+LIST_HOSTSWITCH_PROFILE_TYPE_NIOCPROFILE = 'NiocProfile'
+

Possible value for hostswitchProfileType of method +HostSwitchProfiles.list().

+
+ +
+
+LIST_HOSTSWITCH_PROFILE_TYPE_UPLINKHOSTSWITCHPROFILE = 'UplinkHostSwitchProfile'
+

Possible value for hostswitchProfileType of method +HostSwitchProfiles.list().

+
+ +
+
+create(base_host_switch_profile)
+

Creates a hostswitch profile. The resource_type is required. For uplink +profiles, the teaming and policy parameters are required. By default, +the mtu is 1600 and the transport_vlan is 0. The supported MTU range is +1280 through 9000.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:base_host_switch_profile (vmware.vapi.struct.VapiStruct) – (required) +The parameter must contain all the attributes defined in +com.vmware.nsx.model_client.BaseHostSwitchProfile.
Return type:vmware.vapi.struct.VapiStruct
Returns:com.vmware.nsx.model.BaseHostSwitchProfile +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.BaseHostSwitchProfile.
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(host_switch_profile_id)
+

Deletes a specified hostswitch profile.

+ +++ + + + + + + + + + + + + + +
Parameters:host_switch_profile_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(host_switch_profile_id)
+

Returns information about a specified hostswitch profile.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:host_switch_profile_id (str) – (required)
Return type:vmware.vapi.struct.VapiStruct
Returns:com.vmware.nsx.model.BaseHostSwitchProfile +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.BaseHostSwitchProfile.
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, hostswitch_profile_type=None, include_system_owned=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, uplink_teaming_policy_name=None)
+

Returns information about the configured hostswitch profiles. +Hostswitch profiles define networking policies for hostswitches +(sometimes referred to as bridges in OVS). Currently, only uplink +teaming is supported. Uplink teaming allows NSX to load balance traffic +across different physical NICs (PNICs) on the hypervisor hosts. +Multiple teaming policies are supported, including LACP active, LACP +passive, load balancing based on source ID, and failover order.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • hostswitch_profile_type (str or None) – Supported HostSwitch profiles. (optional)
    • +
  • include_system_owned (bool or None) – Whether the list result contains system resources (optional, +default to false)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
  • uplink_teaming_policy_name (str or None) – The host switch profile’s uplink teaming policy name (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.HostSwitchProfilesListResult

+
Returns:

com.vmware.nsx.model.HostSwitchProfilesListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(host_switch_profile_id, base_host_switch_profile)
+

Modifies a specified hostswitch profile. The body of the PUT request +must include the resource_type. For uplink profiles, the put request +must also include teaming parameters. Modifiable attributes include +display_name, mtu, and transport_vlan. For uplink teaming policies, +uplink_name and policy are also modifiable.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

vmware.vapi.struct.VapiStruct

+
Returns:

com.vmware.nsx.model.BaseHostSwitchProfile +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.BaseHostSwitchProfile.

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx_client.IpSets(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(ip_set)
+

Creates a new IPSet that can group either IPv4 or IPv6 individual ip +addresses, ranges or subnets.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:ip_set (com.vmware.nsx.model_client.IPSet) – (required)
Return type:com.vmware.nsx.model_client.IPSet
Returns:com.vmware.nsx.model.IPSet
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(ip_set_id, force=None)
+

Deletes the specified IPSet. By default, if the IPSet is added to an +NSGroup, it won’t be deleted. In such situations, pass +"force=true" as query param to force delete the IPSet.

+ +++ + + + + + + + + + + + + + + + +
Parameters:
    +
  • ip_set_id (str) – IPSet Id (required)
    • +
  • force (bool or None) – Force delete the resource even if it is being used somewhere +(optional, default to false)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.ConcurrentChange +Conflict

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get(ip_set_id)
+

Returns information about the specified IPSet

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:ip_set_id (str) – IPSet Id (required)
Return type:com.vmware.nsx.model_client.IPSet
Returns:com.vmware.nsx.model.IPSet
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Returns paginated list of IPSets

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.IPSetListResult

+
Returns:

com.vmware.nsx.model.IPSetListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(ip_set_id, ip_set)
+

Updates the specified IPSet. Modifiable parameters include description, +display_name and ip_addresses.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.IPSet

+
Returns:

com.vmware.nsx.model.IPSet

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx_client.IpfixCollectorProfiles(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(ipfix_collector_upm_profile)
+

Create a new IPFIX collector profile with essential properties.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:ipfix_collector_upm_profile (com.vmware.nsx.model_client.IpfixCollectorUpmProfile) – (required)
Return type:com.vmware.nsx.model_client.IpfixCollectorUpmProfile
Returns:com.vmware.nsx.model.IpfixCollectorUpmProfile
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(ipfix_collector_profile_id)
+

Delete an existing IPFIX collector profile by ID.

+ +++ + + + + + + + + + + + + + +
Parameters:ipfix_collector_profile_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(ipfix_collector_profile_id)
+

Get an existing IPFIX collector profile by profile ID.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:ipfix_collector_profile_id (str) – (required)
Return type:com.vmware.nsx.model_client.IpfixCollectorUpmProfile
Returns:com.vmware.nsx.model.IpfixCollectorUpmProfile
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, page_size=None, profile_types=None, sort_ascending=None, sort_by=None)
+

Query IPFIX collector profiles with list parameters. List result can be +filtered by profile type defined by IpfixCollectorUpmProfileType.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • profile_types (str or None) – IPFIX Collector Profile Type List (optional)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.IpfixCollectorUpmProfileListResult

+
Returns:

com.vmware.nsx.model.IpfixCollectorUpmProfileListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(ipfix_collector_profile_id, ipfix_collector_upm_profile)
+

Update an existing IPFIX collector profile with profile ID and modified +properties.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.IpfixCollectorUpmProfile

+
Returns:

com.vmware.nsx.model.IpfixCollectorUpmProfile

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx_client.IpfixObsPoints(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+list()
+

Deprecated - Please use /ipfix-profiles for switch IPFIX profile and +/ipfix-collector-profiles for IPFIX collector profile.

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.IpfixObsPointsListResult
Returns:com.vmware.nsx.model.IpfixObsPointsListResult
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx_client.IpfixProfiles(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+LIST_APPLIED_TO_ENTITY_TYPE_LOGICALPORT = 'LogicalPort'
+

Possible value for appliedToEntityType of method +IpfixProfiles.list().

+
+ +
+
+LIST_APPLIED_TO_ENTITY_TYPE_LOGICALSWITCH = 'LogicalSwitch'
+

Possible value for appliedToEntityType of method +IpfixProfiles.list().

+
+ +
+
+LIST_APPLIED_TO_ENTITY_TYPE_NSGROUP = 'NSGroup'
+

Possible value for appliedToEntityType of method +IpfixProfiles.list().

+
+ +
+
+create(ipfix_upm_profile)
+

Create a new IPFIX profile with essential properties.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:ipfix_upm_profile (vmware.vapi.struct.VapiStruct) – (required) +The parameter must contain all the attributes defined in +com.vmware.nsx.model_client.IpfixUpmProfile.
Return type:vmware.vapi.struct.VapiStruct
Returns:com.vmware.nsx.model.IpfixUpmProfile +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.IpfixUpmProfile.
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(ipfix_profile_id)
+

Delete an existing IPFIX profile by ID.

+ +++ + + + + + + + + + + + + + +
Parameters:ipfix_profile_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(ipfix_profile_id)
+

Get an existing IPFIX profile by profile ID.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:ipfix_profile_id (str) – (required)
Return type:vmware.vapi.struct.VapiStruct
Returns:com.vmware.nsx.model.IpfixUpmProfile +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.IpfixUpmProfile.
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(applied_to_entity_id=None, applied_to_entity_type=None, cursor=None, included_fields=None, page_size=None, profile_types=None, sort_ascending=None, sort_by=None)
+

Query IPFIX profiles with list parameters. List result can be filtered +by profile type defined by IpfixUpmProfileType.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • applied_to_entity_id (str or None) – ID of Entity Applied with Profile (optional)
    • +
  • applied_to_entity_type (str or None) – Supported Entity Types (optional)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • profile_types (str or None) – IPFIX Profile Type List (optional)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.IpfixUpmProfileListResult

+
Returns:

com.vmware.nsx.model.IpfixUpmProfileListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(ipfix_profile_id, ipfix_upm_profile)
+

Update an existing IPFIX profile with profile ID and modified +properties.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

vmware.vapi.struct.VapiStruct

+
Returns:

com.vmware.nsx.model.IpfixUpmProfile +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.IpfixUpmProfile.

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx_client.Licenses(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(license)
+

This will add a license key to the system. The API supports adding only +one license key for each license edition type - Standard, Advanced or +Enterprise. If a new license key is tried to add for an edition for +which the license key already exists, then this API will return an +error.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:license (com.vmware.nsx.model_client.License) – (required)
Return type:com.vmware.nsx.model_client.License
Returns:com.vmware.nsx.model.License
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(license_key)
+

Deprecated. Use POST /licenses?action=delete API instead.

+ +++ + + + + + + + + + + + + + +
Parameters:license_key (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete_0(license)
+

This will delete the license key identified in the request body by +"license_key" and its properties from the system. Attempting to +delete the last license key will result in an error.

+ +++ + + + + + + + + + + + + + +
Parameters:license (com.vmware.nsx.model_client.License) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get()
+

Deprecated. Use the GET /licenses API instead.

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.License
Returns:com.vmware.nsx.model.License
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+getlicensebykey(license_key)
+

Deprecated. Use GET /licenses API instead.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:license_key (str) – (required)
Return type:com.vmware.nsx.model_client.License
Returns:com.vmware.nsx.model.License
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list()
+

Returns all licenses.

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.LicensesListResult
Returns:com.vmware.nsx.model.LicensesListResult
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+update(license)
+

Deprecated. Use the POST /licenses API instead

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:license (com.vmware.nsx.model_client.License) – (required)
Return type:com.vmware.nsx.model_client.License
Returns:com.vmware.nsx.model.License
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx_client.LogicalPorts(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+LIST_ATTACHMENT_TYPE_BRIDGEENDPOINT = 'BRIDGEENDPOINT'
+

Possible value for attachmentType of method LogicalPorts.list().

+
+ +
+
+LIST_ATTACHMENT_TYPE_DHCP_SERVICE = 'DHCP_SERVICE'
+

Possible value for attachmentType of method LogicalPorts.list().

+
+ +
+
+LIST_ATTACHMENT_TYPE_L2VPN_SESSION = 'L2VPN_SESSION'
+

Possible value for attachmentType of method LogicalPorts.list().

+
+ +
+
+LIST_ATTACHMENT_TYPE_LOGICALROUTER = 'LOGICALROUTER'
+

Possible value for attachmentType of method LogicalPorts.list().

+
+ +
+
+LIST_ATTACHMENT_TYPE_METADATA_PROXY = 'METADATA_PROXY'
+

Possible value for attachmentType of method LogicalPorts.list().

+
+ +
+
+LIST_ATTACHMENT_TYPE_NONE = 'NONE'
+

Possible value for attachmentType of method LogicalPorts.list().

+
+ +
+
+LIST_ATTACHMENT_TYPE_VIF = 'VIF'
+

Possible value for attachmentType of method LogicalPorts.list().

+
+ +
+
+create(logical_port)
+

Creates a new logical switch port. The required parameters are the +associated logical_switch_id and admin_state (UP or DOWN). Optional +parameters are the attachment and switching_profile_ids. If you don’t +specify switching_profile_ids, default switching profiles are assigned +to the port. If you don’t specify an attachment, the switch port +remains empty. To configure an attachment, you must specify an id, and +optionally you can specify an attachment_type (VIF or LOGICALROUTER). +The attachment_type is VIF by default.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:logical_port (com.vmware.nsx.model_client.LogicalPort) – (required)
Return type:com.vmware.nsx.model_client.LogicalPort
Returns:com.vmware.nsx.model.LogicalPort
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(lport_id, detach=None)
+

Deletes the specified logical switch port. By default, if logical port +has attachments, or it is added to any NSGroup, the deletion will be +failed. Option detach could be used for deleting logical port forcibly.

+ +++ + + + + + + + + + + + + + +
Parameters:
    +
  • lport_id (str) – (required)
    • +
  • detach (bool or None) – force delete even if attached or referenced by a group (optional, +default to false)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get(lport_id)
+

Returns information about a specified logical port.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:lport_id (str) – (required)
Return type:com.vmware.nsx.model_client.LogicalPort
Returns:com.vmware.nsx.model.LogicalPort
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(attachment_id=None, attachment_type=None, bridge_cluster_id=None, container_ports_only=None, cursor=None, diagnostic=None, included_fields=None, logical_switch_id=None, page_size=None, parent_vif_id=None, sort_ascending=None, sort_by=None, switching_profile_id=None, transport_node_id=None, transport_zone_id=None)
+

Returns information about all configured logical switch ports. Logical +switch ports connect to VM virtual network interface cards (NICs). Each +logical port is associated with one logical switch.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • attachment_id (str or None) – Logical Port attachment Id (optional)
    • +
  • attachment_type (str or None) – Type of attachment for logical port; for query only. (optional)
    • +
  • bridge_cluster_id (str or None) – Bridge Cluster identifier (optional)
    • +
  • container_ports_only (bool or None) – Only container VIF logical ports will be returned if true +(optional, default to false)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • diagnostic (bool or None) – Flag to enable showing of transit logical port. (optional, default +to false)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • logical_switch_id (str or None) – Logical Switch identifier (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • parent_vif_id (str or None) – ID of the VIF of type PARENT (optional)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
  • switching_profile_id (str or None) – Network Profile identifier (optional)
    • +
  • transport_node_id (str or None) – Transport node identifier (optional)
    • +
  • transport_zone_id (str or None) – Transport zone identifier (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.LogicalPortListResult

+
Returns:

com.vmware.nsx.model.LogicalPortListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(lport_id, logical_port)
+

Modifies an existing logical switch port. Parameters that can be +modified include attachment_type (LOGICALROUTER, VIF), admin_state (UP +or DOWN), attachment id and switching_profile_ids. You cannot modify +the logical_switch_id. In other words, you cannot move an existing port +from one switch to another switch.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.LogicalPort

+
Returns:

com.vmware.nsx.model.LogicalPort

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx_client.LogicalRouterPorts(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+LIST_RESOURCE_TYPE_LOGICALROUTERCENTRALIZEDSERVICEPORT = 'LogicalRouterCentralizedServicePort'
+

Possible value for resourceType of method LogicalRouterPorts.list().

+
+ +
+
+LIST_RESOURCE_TYPE_LOGICALROUTERDOWNLINKPORT = 'LogicalRouterDownLinkPort'
+

Possible value for resourceType of method LogicalRouterPorts.list().

+
+ +
+
+LIST_RESOURCE_TYPE_LOGICALROUTERIPTUNNELPORT = 'LogicalRouterIPTunnelPort'
+

Possible value for resourceType of method LogicalRouterPorts.list().

+
+ +
+
+LIST_RESOURCE_TYPE_LOGICALROUTERLINKPORTONTIER0 = 'LogicalRouterLinkPortOnTIER0'
+

Possible value for resourceType of method LogicalRouterPorts.list().

+
+ +
+
+LIST_RESOURCE_TYPE_LOGICALROUTERLINKPORTONTIER1 = 'LogicalRouterLinkPortOnTIER1'
+

Possible value for resourceType of method LogicalRouterPorts.list().

+
+ +
+
+LIST_RESOURCE_TYPE_LOGICALROUTERLOOPBACKPORT = 'LogicalRouterLoopbackPort'
+

Possible value for resourceType of method LogicalRouterPorts.list().

+
+ +
+
+LIST_RESOURCE_TYPE_LOGICALROUTERUPLINKPORT = 'LogicalRouterUpLinkPort'
+

Possible value for resourceType of method LogicalRouterPorts.list().

+
+ +
+
+create(logical_router_port)
+

Creates a logical router port. The required parameters include +resource_type (LogicalRouterUpLinkPort, LogicalRouterDownLinkPort, +LogicalRouterLinkPort, LogicalRouterLoopbackPort, +LogicalRouterCentralizedServicePort); and logical_router_id (the router +to which each logical router port is assigned). The service_bindings +parameter is optional.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:logical_router_port (vmware.vapi.struct.VapiStruct) – (required) +The parameter must contain all the attributes defined in +com.vmware.nsx.model_client.LogicalRouterPort.
Return type:vmware.vapi.struct.VapiStruct
Returns:com.vmware.nsx.model.LogicalRouterPort +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.LogicalRouterPort.
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(logical_router_port_id, force=None)
+

Deletes the specified logical router port. You must delete logical +router ports before you can delete the associated logical router. To +Delete Tier0 router link port you must have to delete attached tier1 +router link port, otherwise pass "force=true" as query param to +force delete the Tier0 router link port.

+ +++ + + + + + + + + + + + + + +
Parameters:
    +
  • logical_router_port_id (str) – (required)
    • +
  • force (bool or None) – Force delete the resource even if it is being used somewhere +(optional, default to false)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get(logical_router_port_id)
+

Returns information about the specified logical router port.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:logical_router_port_id (str) – (required)
Return type:vmware.vapi.struct.VapiStruct
Returns:com.vmware.nsx.model.LogicalRouterPort +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.LogicalRouterPort.
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, logical_router_id=None, logical_switch_id=None, page_size=None, resource_type=None, sort_ascending=None, sort_by=None)
+

Returns information about all logical router ports. Information +includes the resource_type (LogicalRouterUpLinkPort, +LogicalRouterDownLinkPort, LogicalRouterLinkPort, +LogicalRouterLoopbackPort, LogicalRouterCentralizedServicePort); +logical_router_id (the router to which each logical router port is +assigned); and any service_bindings (such as DHCP relay service). The +GET request can include a query parameter (logical_router_id or +logical_switch_id).

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • logical_router_id (str or None) – Logical Router identifier (optional)
    • +
  • logical_switch_id (str or None) – Logical Switch identifier (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • resource_type (str or None) – Resource types of logical router port (optional)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.LogicalRouterPortListResult

+
Returns:

com.vmware.nsx.model.LogicalRouterPortListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(logical_router_port_id, logical_router_port)
+

Modifies the specified logical router port. Required parameters include +the resource_type and logical_router_id. Modifiable parameters include +the resource_type (LogicalRouterUpLinkPort, LogicalRouterDownLinkPort, +LogicalRouterLinkPort, LogicalRouterLoopbackPort, +LogicalRouterCentralizedServicePort), logical_router_id (to reassign +the port to a different router), and service_bindings.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

vmware.vapi.struct.VapiStruct

+
Returns:

com.vmware.nsx.model.LogicalRouterPort +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.LogicalRouterPort.

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx_client.LogicalRouters(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+LIST_ROUTER_TYPE_TIER0 = 'TIER0'
+

Possible value for routerType of method LogicalRouters.list().

+
+ +
+
+LIST_ROUTER_TYPE_TIER1 = 'TIER1'
+

Possible value for routerType of method LogicalRouters.list().

+
+ +
+
+create(logical_router)
+

Creates a logical router. The required parameters are router_type +(TIER0 or TIER1) and edge_cluster_id (TIER0 only). Optional parameters +include internal and external transit network addresses.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:logical_router (com.vmware.nsx.model_client.LogicalRouter) – (required)
Return type:com.vmware.nsx.model_client.LogicalRouter
Returns:com.vmware.nsx.model.LogicalRouter
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(logical_router_id, force=None)
+

Deletes the specified logical router. You must delete associated +logical router ports before you can delete a logical router. Otherwise +use force delete which will delete all related ports and other entities +associated with that LR. To force delete logical router pass force=true +in query param.

+ +++ + + + + + + + + + + + + + +
Parameters:
    +
  • logical_router_id (str) – (required)
    • +
  • force (bool or None) – Force delete the resource even if it is being used somewhere +(optional, default to false)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get(logical_router_id)
+

Returns information about the specified logical router.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:logical_router_id (str) – (required)
Return type:com.vmware.nsx.model_client.LogicalRouter
Returns:com.vmware.nsx.model.LogicalRouter
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, page_size=None, router_type=None, sort_ascending=None, sort_by=None)
+

Returns information about all logical routers, including the UUID, +internal and external transit network addresses, and the router type +(TIER0 or TIER1). You can get information for only TIER0 routers or +only the TIER1 routers by including the router_type query parameter.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • router_type (str or None) – Type of Logical Router (optional)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.LogicalRouterListResult

+
Returns:

com.vmware.nsx.model.LogicalRouterListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+reallocate(logical_router_id, service_router_allocation_config)
+

API to re allocate edge node placement for TIER1 logical router. You +can re-allocate service routers of TIER1 in same edge cluster or +different edge cluster. You can also place edge nodes manually and +provide maximum two indices for HA mode ACTIVE_STANDBY. To re-allocate +on new edge cluster you must have existing edge cluster for TIER1 +logical router. This will be disruptive operation and all existing +statistics of logical router will be remove.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.LogicalRouter

+
Returns:

com.vmware.nsx.model.LogicalRouter

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+reprocess(logical_router_id)
+

Reprocess logical router configuration and configuration of related +entities like logical router ports, static routing, etc. Any missing +Updates are published to controller.

+ +++ + + + + + + + + + + + + + +
Parameters:logical_router_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+update(logical_router_id, logical_router)
+

Modifies the specified logical router. Modifiable attributes include +the internal_transit_network, external_transit_networks, and +edge_cluster_id (for TIER0 routers).

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.LogicalRouter

+
Returns:

com.vmware.nsx.model.LogicalRouter

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx_client.LogicalSwitches(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+LIST_TRANSPORT_TYPE_OVERLAY = 'OVERLAY'
+

Possible value for transportType of method LogicalSwitches.list().

+
+ +
+
+LIST_TRANSPORT_TYPE_VLAN = 'VLAN'
+

Possible value for transportType of method LogicalSwitches.list().

+
+ +
+
+create(logical_switch)
+

Creates a new logical switch. The request must include the +transport_zone_id, display_name, and admin_state (UP or DOWN). The +replication_mode (MTEP or SOURCE) is required for overlay logical +switches, but not for VLAN-based logical switches. A vlan needs to be +provided for VLAN-based logical switches

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:logical_switch (com.vmware.nsx.model_client.LogicalSwitch) – (required)
Return type:com.vmware.nsx.model_client.LogicalSwitch
Returns:com.vmware.nsx.model.LogicalSwitch
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(lswitch_id, cascade=None, detach=None)
+

Removes a logical switch from the associated overlay or VLAN transport +zone. By default, a logical switch cannot be deleted if there are +logical ports on the switch, or it is added to a NSGroup. Cascade +option can be used to delete all ports and the logical switch. Detach +option can be used to delete the logical switch forcibly.

+ +++ + + + + + + + + + + + + + +
Parameters:
    +
  • lswitch_id (str) – (required)
    • +
  • cascade (bool or None) – Delete a Logical Switch and all the logical ports in it, if none of +the logical ports have any attachment. (optional, default to false)
    • +
  • detach (bool or None) – Force delete a logical switch (optional, default to false)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get(lswitch_id)
+

Returns information about the specified logical switch Id.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:lswitch_id (str) – (required)
Return type:com.vmware.nsx.model_client.LogicalSwitch
Returns:com.vmware.nsx.model.LogicalSwitch
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, diagnostic=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, switching_profile_id=None, transport_type=None, transport_zone_id=None, uplink_teaming_policy_name=None, vlan=None, vni=None)
+

Returns information about all configured logical switches.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • diagnostic (bool or None) – Flag to enable showing of transit logical switch. (optional, +default to false)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
  • switching_profile_id (str or None) – Switching Profile identifier (optional)
    • +
  • transport_type (str or None) – Mode of transport supported in the transport zone for this logical +switch (optional)
    • +
  • transport_zone_id (str or None) – Transport zone identifier (optional)
    • +
  • uplink_teaming_policy_name (str or None) – The logical switch’s uplink teaming policy name (optional)
    • +
  • vlan (long or None) – Virtual Local Area Network Identifier (optional)
    • +
  • vni (long or None) – VNI of the OVERLAY LogicalSwitch(es) to return. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.LogicalSwitchListResult

+
Returns:

com.vmware.nsx.model.LogicalSwitchListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(lswitch_id, logical_switch)
+

Modifies attributes of an existing logical switch. Modifiable +attributes include admin_state, replication_mode, switching_profile_ids +and VLAN spec. You cannot modify the original transport_zone_id.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.LogicalSwitch

+
Returns:

com.vmware.nsx.model.LogicalSwitch

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx_client.MacSets(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(m_ac_set)
+

Creates a new MACSet that can group individual MAC addresses.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:m_ac_set (com.vmware.nsx.model_client.MACSet) – (required)
Return type:com.vmware.nsx.model_client.MACSet
Returns:com.vmware.nsx.model.MACSet
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(mac_set_id, force=None)
+

Deletes the specified MACSet. By default, if the MACSet is added to an +NSGroup, it won’t be deleted. In such situations, pass +"force=true" as query param to force delete the MACSet.

+ +++ + + + + + + + + + + + + + + + +
Parameters:
    +
  • mac_set_id (str) – MACSet Id (required)
    • +
  • force (bool or None) – Force delete the resource even if it is being used somewhere +(optional, default to false)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.ConcurrentChange +Conflict

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get(mac_set_id)
+

Returns information about the specified MACSet

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:mac_set_id (str) – MACSet Id (required)
Return type:com.vmware.nsx.model_client.MACSet
Returns:com.vmware.nsx.model.MACSet
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Returns paginated list of MACSets

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.MACSetListResult

+
Returns:

com.vmware.nsx.model.MACSetListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(mac_set_id, m_ac_set)
+

Updates the specified MACSet. Modifiable parameters include the +description, display_name and mac_addresses.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.MACSet

+
Returns:

com.vmware.nsx.model.MACSet

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx_client.MdProxies(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(metadata_proxy)
+

Create a metadata proxy

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:metadata_proxy (com.vmware.nsx.model_client.MetadataProxy) – (required)
Return type:com.vmware.nsx.model_client.MetadataProxy
Returns:com.vmware.nsx.model.MetadataProxy
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(proxy_id)
+

Delete a metadata proxy

+ +++ + + + + + + + + + + + + + +
Parameters:proxy_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(proxy_id)
+

Get a metadata proxy

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:proxy_id (str) – (required)
Return type:com.vmware.nsx.model_client.MetadataProxy
Returns:com.vmware.nsx.model.MetadataProxy
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Get a paginated list of metadata proxies

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.MetadataProxyListResult

+
Returns:

com.vmware.nsx.model.MetadataProxyListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(proxy_id, metadata_proxy)
+

Update a metadata proxy

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.MetadataProxy

+
Returns:

com.vmware.nsx.model.MetadataProxy

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx_client.Migration(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+upgrademc()
+

Upgrade the migration coordinator.

+ +++ + + + + + + + + + + + +
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx_client.MirrorSessions(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(port_mirroring_session)
+

Create a mirror session

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:port_mirroring_session (com.vmware.nsx.model_client.PortMirroringSession) – (required)
Return type:com.vmware.nsx.model_client.PortMirroringSession
Returns:com.vmware.nsx.model.PortMirroringSession
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(mirror_session_id)
+

Delete the mirror session

+ +++ + + + + + + + + + + + + + +
Parameters:mirror_session_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(mirror_session_id)
+

Get the mirror session

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:mirror_session_id (str) – (required)
Return type:com.vmware.nsx.model_client.PortMirroringSession
Returns:com.vmware.nsx.model.PortMirroringSession
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

List all mirror sessions

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.PortMirroringSessionListResult

+
Returns:

com.vmware.nsx.model.PortMirroringSessionListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(mirror_session_id, port_mirroring_session)
+

Update the mirror session

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.PortMirroringSession

+
Returns:

com.vmware.nsx.model.PortMirroringSession

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+verify(mirror_session_id)
+

Verify whether all participants are on the same transport node

+ +++ + + + + + + + + + + + + + +
Parameters:mirror_session_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx_client.NetworkMigrationSpecs(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+LIST_TYPE_HOSTPROFILENETWORKMIGRATIONSPEC = 'HostProfileNetworkMigrationSpec'
+

Possible value for type of method NetworkMigrationSpecs.list().

+
+ +
+
+create(network_migration_spec)
+

Network migration specification once created and can be used as a +template to indicate associated component which networks should be +migrated and where. Currently migration template can be associated with +compute collections which are managed by vCenter host profiles, to +trigger automatic migration of networks for Stateless ESX hosts. +Currently we only support creation of HostProfileNetworkMigrationSpec +type of specification.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:network_migration_spec (vmware.vapi.struct.VapiStruct) – (required) +The parameter must contain all the attributes defined in +com.vmware.nsx.model_client.NetworkMigrationSpec.
Return type:vmware.vapi.struct.VapiStruct
Returns:com.vmware.nsx.model.NetworkMigrationSpec +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.NetworkMigrationSpec.
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(template_id)
+

Delete the specified network migration specification template. Delete +will fail if this is a HostProfileNetworkMigrationSpec and is +associated with certain compute collection.

+ +++ + + + + + + + + + + + + + +
Parameters:template_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(template_id)
+

Network migration specification once created and can be used as a +template to indicate associated component which networks should be +migrated and where. Currently migration template can be associated with +compute collections which are managed by vCenter host profiles, to +trigger automatic migration of networks for Stateless ESX hosts. +Currently we only support creation of HostProfileNetworkMigrationSpec +type of specification.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:template_id (str) – (required)
Return type:vmware.vapi.struct.VapiStruct
Returns:com.vmware.nsx.model.NetworkMigrationSpec +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.NetworkMigrationSpec.
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, include_system_owned=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, type=None)
+

Network migration specification once created and can be used as a +template to indicate associated component which networks should be +migrated and where. Currently migration template can be associated with +compute collections which are managed by vCenter host profiles, to +trigger automatic migration of networks for Stateless ESX hosts. +Currently we only support creation of HostProfileNetworkMigrationSpec +type of specification.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • include_system_owned (bool or None) – Whether the list result contains system resources (optional, +default to false)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
  • type (str or None) – Supported network migration specification types. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.NetworkMigrationSpecListResult

+
Returns:

com.vmware.nsx.model.NetworkMigrationSpecListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(template_id, network_migration_spec)
+

Network migration specification once created and can be used as a +template to indicate associated component which networks should be +migrated and where. Currently migration template can be associated with +compute collections which are managed by vCenter host profiles, to +trigger automatic migration of networks for Stateless ESX hosts. +Currently we only support creation of HostProfileNetworkMigrationSpec +type of specification. For a HostProfileNetworkMigrationSpec which is +already associated with a compute collection, updating it would mean +next time the system needs to trigger migration for hosts managed by +compute collection, it will use the updated migration specification.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

vmware.vapi.struct.VapiStruct

+
Returns:

com.vmware.nsx.model.NetworkMigrationSpec +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.NetworkMigrationSpec.

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx_client.Node(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Returns information about the NSX Manager appliance. Information +includes release number, time zone, system time, kernel version, +message of the day (motd), and host name.

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeProperties
Returns:com.vmware.nsx.model.NodeProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+restart()
+

Restarts or shuts down the NSX Manager appliance.

+ +++ + + + + + + + + + + + +
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+shutdown()
+

Restarts or shuts down the NSX Manager appliance.

+ +++ + + + + + + + + + + + +
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+update(node_properties)
+

Modifies NSX Manager appliance properties. Modifiable properties +include the timezone, message of the day (motd), and hostname. The NSX +Manager node_version, system_time, and kernel_version are read only and +cannot be modified with this method.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:node_properties (com.vmware.nsx.model_client.NodeProperties) – (required)
Return type:com.vmware.nsx.model_client.NodeProperties
Returns:com.vmware.nsx.model.NodeProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx_client.Normalizations(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+LIST_PREFERRED_NORMALIZATION_TYPE_DIRECTORYGROUP = 'DirectoryGroup'
+

Possible value for preferredNormalizationType of method +Normalizations.list().

+
+ +
+
+LIST_PREFERRED_NORMALIZATION_TYPE_IPSET = 'IPSet'
+

Possible value for preferredNormalizationType of method +Normalizations.list().

+
+ +
+
+LIST_PREFERRED_NORMALIZATION_TYPE_LOGICALPORT = 'LogicalPort'
+

Possible value for preferredNormalizationType of method +Normalizations.list().

+
+ +
+
+LIST_PREFERRED_NORMALIZATION_TYPE_LOGICALSWITCH = 'LogicalSwitch'
+

Possible value for preferredNormalizationType of method +Normalizations.list().

+
+ +
+
+LIST_PREFERRED_NORMALIZATION_TYPE_MACSET = 'MACSet'
+

Possible value for preferredNormalizationType of method +Normalizations.list().

+
+ +
+
+LIST_PREFERRED_NORMALIZATION_TYPE_NSGROUP = 'NSGroup'
+

Possible value for preferredNormalizationType of method +Normalizations.list().

+
+ +
+
+LIST_RESOURCE_TYPE_NSGROUP = 'NSGroup'
+

Possible value for resourceType of method Normalizations.list().

+
+ +
+
+list(preferred_normalization_type, resource_id, resource_type, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Returns the list of normalized resources based on the query parameters. +Id and Type of the resource on which the normalizations is to be +performed, are to be specified as query parameters in the URI. The +target resource types to which normalization is to be done should also +be specified as query parameter.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • preferred_normalization_type (str) – Resource type valid for use as target in normalization API. +(required)
    • +
  • resource_id (str) – Identifier of the resource on which normalization is to be +performed (required)
    • +
  • resource_type (str) – Resource type valid for use as source in normalization API. +(required)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.NormalizedResourceListResult

+
Returns:

com.vmware.nsx.model.NormalizedResourceListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx_client.NsGroups(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+ADDORREMOVEEXPRESSION_ACTION_ADD_MEMBERS = 'ADD_MEMBERS'
+

Possible value for action of method NsGroups.addorremoveexpression().

+
+ +
+
+ADDORREMOVEEXPRESSION_ACTION_REMOVE_MEMBERS = 'REMOVE_MEMBERS'
+

Possible value for action of method NsGroups.addorremoveexpression().

+
+ +
+
+addorremoveexpression(ns_group_id, ns_group_expression_list, action)
+

Add/remove the expressions passed in the request body to/from the +NSGroup

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.NSGroup

+
Returns:

com.vmware.nsx.model.NSGroup

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+create(ns_group)
+

Creates a new NSGroup that can group NSX resources - VIFs, Lports and +LSwitches as well as the grouping objects - IPSet, MACSet and other +NSGroups

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:ns_group (com.vmware.nsx.model_client.NSGroup) – (required)
Return type:com.vmware.nsx.model_client.NSGroup
Returns:com.vmware.nsx.model.NSGroup
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(ns_group_id, force=None)
+

Deletes the specified NSGroup. By default, if the NSGroup is added to +another NSGroup, it won’t be deleted. In such situations, pass +"force=true" as query param to force delete the NSGroup.

+ +++ + + + + + + + + + + + + + +
Parameters:
    +
  • ns_group_id (str) – NSGroup Id (required)
    • +
  • force (bool or None) – Force delete the resource even if it is being used somewhere +(optional, default to false)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get(ns_group_id, populate_references=None)
+

Returns information about the specified NSGroup.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • ns_group_id (str) – NSGroup Id (required)
    • +
  • populate_references (bool or None) – Populate metadata of resource referenced by NSGroupExpressions +(optional, default to false)
    • +
+
Return type:

com.vmware.nsx.model_client.NSGroup

+
Returns:

com.vmware.nsx.model.NSGroup

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+list(cursor=None, included_fields=None, member_types=None, page_size=None, populate_references=None, sort_ascending=None, sort_by=None)
+

List the NSGroups in a paginated format. The page size is restricted to +50 NSGroups so that the size of the response remains small even in the +worst case. Optionally, specify valid member types as request parameter +to filter NSGroups.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • member_types (str or None) – Specify member types to filter corresponding NSGroups (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • populate_references (bool or None) – Populate metadata of resource referenced by NSGroupExpressions +(optional, default to false)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.NSGroupListResult

+
Returns:

com.vmware.nsx.model.NSGroupListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(ns_group_id, ns_group)
+

Updates the specified NSGroup. Modifiable parameters include the +description, display_name and members.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.NSGroup

+
Returns:

com.vmware.nsx.model.NSGroup

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx_client.NsServiceGroups(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(ns_service_group)
+

Creates a new NSServiceGroup which can contain NSServices. A given +NSServiceGroup can contain either only ether type of NSServices or only +non-ether type of NSServices, i.e. an NSServiceGroup cannot contain a +mix of both ether and non-ether types of NSServices.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:ns_service_group (com.vmware.nsx.model_client.NSServiceGroup) – (required)
Return type:com.vmware.nsx.model_client.NSServiceGroup
Returns:com.vmware.nsx.model.NSServiceGroup
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(ns_service_group_id, force=None)
+

Deletes the specified NSServiceGroup. By default, if the NSServiceGroup +is consumed in a Firewall rule, it won’t get deleted. In such +situations, pass "force=true" as query param to force delete +the NSServiceGroup.

+ +++ + + + + + + + + + + + + + + + +
Parameters:
    +
  • ns_service_group_id (str) – NSServiceGroup Id (required)
    • +
  • force (bool or None) – Force delete the resource even if it is being used somewhere +(optional, default to false)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.ConcurrentChange +Conflict

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get(ns_service_group_id)
+

Returns information about the specified NSServiceGroup

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:ns_service_group_id (str) – NSServiceGroup Id (required)
Return type:com.vmware.nsx.model_client.NSServiceGroup
Returns:com.vmware.nsx.model.NSServiceGroup
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, default_service=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Returns paginated list of NSServiceGroups

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • default_service (bool or None) – Fetch all default NSServiceGroups (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.NSServiceGroupListResult

+
Returns:

com.vmware.nsx.model.NSServiceGroupListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(ns_service_group_id, ns_service_group)
+

Updates the specified NSService. Modifiable parameters include the +description, display_name and members.

+ +++ + + + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.NSServiceGroup

+
Returns:

com.vmware.nsx.model.NSServiceGroup

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.ConcurrentChange +Conflict

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx_client.NsServices(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(ns_service)
+

Creates a new NSService which allows users to specify characteristics +to use for matching network traffic.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:ns_service (com.vmware.nsx.model_client.NSService) – (required)
Return type:com.vmware.nsx.model_client.NSService
Returns:com.vmware.nsx.model.NSService
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(ns_service_id, force=None)
+

Deletes the specified NSService. By default, if the NSService is being +referred in an NSServiceGroup, it can’t be deleted. In such situations, +pass "force=true" as a parameter to force delete the NSService. +System defined NSServices can’t be deleted using "force" flag.

+ +++ + + + + + + + + + + + + + + + +
Parameters:
    +
  • ns_service_id (str) – NSService Id (required)
    • +
  • force (bool or None) – Force delete the resource even if it is being used somewhere +(optional, default to false)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.ConcurrentChange +Conflict

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get(ns_service_id)
+

Returns information about the specified NSService

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:ns_service_id (str) – NSService Id (required)
Return type:com.vmware.nsx.model_client.NSService
Returns:com.vmware.nsx.model.NSService
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, default_service=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Returns paginated list of NSServices

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • default_service (bool or None) – Fetch all default NSServices (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.NSServiceListResult

+
Returns:

com.vmware.nsx.model.NSServiceListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(ns_service_id, ns_service)
+

Updates the specified NSService. Modifiable parameters include the +description, display_name and the NSService element. The system defined +NSServices can’t be modified

+ +++ + + + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.NSService

+
Returns:

com.vmware.nsx.model.NSService

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.ConcurrentChange +Conflict

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx_client.ServiceProfiles(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(service_profile)
+

Creates a service profile, which can then be used to create a service. +Services are then applied to one or more logical router ports.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:service_profile (com.vmware.nsx.model_client.ServiceProfile) – (required)
Return type:com.vmware.nsx.model_client.ServiceProfile
Returns:com.vmware.nsx.model.ServiceProfile
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(service_profile_id)
+

Deletes the specified service profile.

+ +++ + + + + + + + + + + + + + +
Parameters:service_profile_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(service_profile_id)
+

Returns information about the specified service profile.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:service_profile_id (str) – (required)
Return type:com.vmware.nsx.model_client.ServiceProfile
Returns:com.vmware.nsx.model.ServiceProfile
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, page_size=None, resource_type=None, sort_ascending=None, sort_by=None)
+

Returns information about all service profiles. A service profile is a +configuration that you can use to create a service, which is then +applied to one or more logical router ports. Currently, only the +DhcpRelayProfile is supported.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • resource_type (str or None) – (optional)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.ServiceProfileListResult

+
Returns:

com.vmware.nsx.model.ServiceProfileListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(service_profile_id, service_profile)
+

Modifies the specified service profile. The PUT request must include +the resource_type parameters. Modifiable parameters include description +and display_name. Other parameters might be modifiable, depending on +the specified service type.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.ServiceProfile

+
Returns:

com.vmware.nsx.model.ServiceProfile

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx_client.Services(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(logical_service)
+

Creates a service that can be applied to one or more logical router +ports. For some service types, you must create a service-profile before +you can create a service.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:logical_service (com.vmware.nsx.model_client.LogicalService) – (required)
Return type:com.vmware.nsx.model_client.LogicalService
Returns:com.vmware.nsx.model.LogicalService
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(service_id)
+

Deletes the specified logical router service.

+ +++ + + + + + + + + + + + + + +
Parameters:service_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(service_id)
+

Returns information about the specified service.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:service_id (str) – (required)
Return type:com.vmware.nsx.model_client.LogicalService
Returns:com.vmware.nsx.model.LogicalService
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, page_size=None, resource_type=None, sort_ascending=None, sort_by=None)
+

Returns information about all configured logical router services that +can be applied to one or more logical router ports. You must create a +service-profile before you can create a service. Currently, only +DhcpRelayService is supported.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • resource_type (str or None) – (optional)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.LogicalServiceListResult

+
Returns:

com.vmware.nsx.model.LogicalServiceListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(service_id, logical_service)
+

Modifies the specified logical router service. The resource_type +parameter is required. The modifiable parameters depend on the service +type.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.LogicalService

+
Returns:

com.vmware.nsx.model.LogicalService

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+class com.vmware.nsx_client.SwitchingProfiles(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(base_switching_profile)
+

Creates a new, custom qos, port-mirroring, spoof-guard or port-security +switching profile. You can override their default switching profile +assignments by creating a new switching profile and assigning it to one +or more logical switches. You cannot override the default ipfix or +ip_discovery switching profiles.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:base_switching_profile (vmware.vapi.struct.VapiStruct) – (required) +The parameter must contain all the attributes defined in +com.vmware.nsx.model_client.BaseSwitchingProfile.
Return type:vmware.vapi.struct.VapiStruct
Returns:com.vmware.nsx.model.BaseSwitchingProfile +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.BaseSwitchingProfile.
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(switching_profile_id, unbind=None)
+

Deletes the specified switching profile.

+ +++ + + + + + + + + + + + + + +
Parameters:
    +
  • switching_profile_id (str) – (required)
    • +
  • unbind (bool or None) – force unbinding of logical switches and ports from a switching +profile (optional, default to false)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get(switching_profile_id)
+

Returns information about a specified switching profile.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:switching_profile_id (str) – (required)
Return type:vmware.vapi.struct.VapiStruct
Returns:com.vmware.nsx.model.BaseSwitchingProfile +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.BaseSwitchingProfile.
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, include_system_owned=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, switching_profile_type=None)
+

Returns information about the system-default and user-configured +switching profiles. Each switching profile has a unique ID, a display +name, and various other read-only and configurable properties. The +default switching profiles are assigned automatically to each switch.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • include_system_owned (bool or None) – Whether the list result contains system resources (optional, +default to false)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
  • switching_profile_type (str or None) – comma-separated list of switching profile types, e.g. +?switching_profile_type=QosSwitchingProfile,PortMirroringSwitchingProfile +(optional)
    • +
+
Return type:

com.vmware.nsx.model_client.SwitchingProfilesListResult

+
Returns:

com.vmware.nsx.model.SwitchingProfilesListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(switching_profile_id, base_switching_profile)
+

Updates the user-configurable parameters of a switching profile. Only +the qos, port-mirroring, spoof-guard and port-security switching +profiles can be modified. You cannot modify the ipfix or ip-discovery +switching profiles.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

vmware.vapi.struct.VapiStruct

+
Returns:

com.vmware.nsx.model.BaseSwitchingProfile +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.BaseSwitchingProfile.

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx_client.Tasks(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(task_id)
+

Get information about the specified task

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:task_id (str) – ID of task to read (required)
Return type:com.vmware.nsx.model_client.TaskProperties
Returns:com.vmware.nsx.model.TaskProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, page_size=None, request_uri=None, sort_ascending=None, sort_by=None, status=None, user=None)
+

Get information about all tasks

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • request_uri (str or None) – Request URI(s) to include in query result (optional)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
  • status (str or None) – Status(es) to include in query result (optional)
    • +
  • user (str or None) – Names of users to include in query result (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.TaskListResult

+
Returns:

com.vmware.nsx.model.TaskListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx_client.Traceflows(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(traceflow_request)
+

Initiate a Traceflow Operation on the Specified Port

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:traceflow_request (com.vmware.nsx.model_client.TraceflowRequest) – (required)
Return type:com.vmware.nsx.model_client.Traceflow
Returns:com.vmware.nsx.model.Traceflow
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(traceflow_id)
+

Delete the Traceflow round

+ +++ + + + + + + + + + + + + + +
Parameters:traceflow_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(traceflow_id)
+

Get the Traceflow round status and result summary

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:traceflow_id (str) – (required)
Return type:com.vmware.nsx.model_client.Traceflow
Returns:com.vmware.nsx.model.Traceflow
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, lport_id=None, page_size=None, sort_ascending=None, sort_by=None)
+

List all Traceflow rounds; if a logical port id is given as a query +parameter, only those originated from the logical port are returned.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • lport_id (str or None) – id of the source logical port where the trace flows originated +(optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.TraceflowListResult

+
Returns:

com.vmware.nsx.model.TraceflowListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx_client.TransportNodes(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+UPDATEMAINTENANCEMODE_ACTION_ENTER_MAINTENANCE_MODE = 'enter_maintenance_mode'
+

Possible value for action of method +TransportNodes.updatemaintenancemode().

+
+ +
+
+UPDATEMAINTENANCEMODE_ACTION_EXIT_MAINTENANCE_MODE = 'exit_maintenance_mode'
+

Possible value for action of method +TransportNodes.updatemaintenancemode().

+
+ +
+
+UPDATEMAINTENANCEMODE_ACTION_FORCED_ENTER_MAINTENANCE_MODE = 'forced_enter_maintenance_mode'
+

Possible value for action of method +TransportNodes.updatemaintenancemode().

+
+ +
+
+create(transport_node)
+

Enables a fabric node to act as a transport node. Additional +documentation on creating a transport node can be found in the NSX-T +Installation Guide. Transport nodes are hypervisor hosts and NSX Edges +that will participate in an NSX-T overlay. For a hypervisor host, this +means that it hosts VMs that will communicate over NSX-T logical +switches. For NSX Edges, this means that it will have logical router +uplinks and downlinks. When creating a transport node, you must provide +the node id of an existing fabric node (hypervisor host or NSX Edge +node) in the node_id property of the payload. This property is +required. Additionally, in order for the transport node to forward +packets, the host_switch_spec property must be specified. Host switches +(called bridges in OVS on KVM hypervisors) are the individual switches +within the host virtual switch. Virtual machines are connected to the +host switches. When creating a transport node, you need to specify if +the host switches are already manually preconfigured on the node, or if +NSX should create and manage the host switches. You specify this choice +by the type of host switches you pass in the host_switch_spec property +of the TransportNode request payload. For a KVM host, you can +preconfigure the host switch, or you can have NSX Manager perform the +configuration. For an ESXi host or NSX Edge node, NSX Manager always +configures the host switch. To preconfigure the host switches on a KVM +host, pass an array of PreconfiguredHostSwitchSpec objects that +describes those host switches. In the current NSX-T release, only one +prefonfigured host switch can be specified. See the +PreconfiguredHostSwitchSpec schema definition for documentation on the +properties that must be provided. Preconfigured host switches are only +supported on KVM hosts, not on ESXi hosts or NSX Edge nodes. To allow +NSX to manage the host switch configuration on KVM hosts, ESXi hosts, +or NSX Edge nodes, pass an array of StandardHostSwitchSpec objects in +the host_switch_spec property, and NSX will automatically create host +switches with the properties you provide. In the current NSX-T release, +up to 5 host switches can be automatically managed. See the +StandardHostSwitchSpec schema definition for documentation on the +properties that must be provided. Note: previous versions of NSX-T used +a property named host_switches to specify the host switch configuration +on the transport node. That property is deprecated, but still +functions. You should configure new host switches using the +host_switch_spec property.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:transport_node (com.vmware.nsx.model_client.TransportNode) – (required)
Return type:com.vmware.nsx.model_client.TransportNode
Returns:com.vmware.nsx.model.TransportNode
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(transportnode_id, force=None)
+

Deletes the specified transport node. Query param force can be used to +force delete the host nodes. Force deletion of edge and public cloud +gateway nodes is not supported.

+ +++ + + + + + + + + + + + + + +
Parameters:
    +
  • transportnode_id (str) – (required)
    • +
  • force (bool or None) – Force delete the resource even if it is being used somewhere +(optional, default to false)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get(transportnode_id)
+

Returns information about a specified transport node.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:transportnode_id (str) – (required)
Return type:com.vmware.nsx.model_client.TransportNode
Returns:com.vmware.nsx.model.TransportNode
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, in_maintenance_mode=None, included_fields=None, node_id=None, node_ip=None, node_types=None, page_size=None, sort_ascending=None, sort_by=None, transport_zone_id=None)
+

Returns information about all transport nodes. A transport node is a +fabric node (host or edge) that contains hostswitches. A hostswitch can +have virtual machines connected to them. Because each transport node +has HostSwitches, transport nodes can also have virtual tunnel +endpoints, which means that they can be part of the overlay.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • in_maintenance_mode (bool or None) – maintenance mode flag (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • node_id (str or None) – node identifier (optional)
    • +
  • node_ip (str or None) – Fabric node IP address (optional)
    • +
  • node_types (str or None) – a list of fabric node types separated by comma or a single type +(optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
  • transport_zone_id (str or None) – Transport zone identifier (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.TransportNodeListResult

+
Returns:

com.vmware.nsx.model.TransportNodeListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+resynchostconfig(transportnode_id)
+

Resync the TransportNode configuration on a host. It is similar to +updating the TransportNode with existing configuration, but force synce +these configurations to the host (no backend optimizations).

+ +++ + + + + + + + + + + + + + +
Parameters:transportnode_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+update(transportnode_id, transport_node, esx_mgmt_if_migration_dest=None, if_id=None, vnic=None, vnic_migration_dest=None)
+

Modifies the transport node information. Modifiable parameters include +the host_switch_spec and transport_zone_endpoints. The host_switch_name +field must match the host_switch_name value specified in the transport +zone (API: transport-zones). You must create the associated uplink +profile (API: host-switch-profiles) before you can specify an +uplink_name here. If the host is an ESX and has only one physical NIC +being used by a vSphere standard switch, TransportNodeUpdateParameters +should be used to migrate the management interface and the physical NIC +into a logical switch that is in a transport zone this transport node +will join or has already joined. If the migration is already done, +TransportNodeUpdateParameters can also be used to migrate the +management interface and the physical NIC back to a vSphere standard +switch. In other cases, the TransportNodeUpdateParameters should NOT be +used. When updating transport node user should follow pattern where he +should fetch the existing transport node and then only modify the +required properties keeping other properties as is. For API backward +compatibility, property host_switches will be still returned in +response and will contain the configuration matching the one in +host_switch_spec. In update call user should only modify configuration +in either host_switch_spec or host_switches, but not both. Property +host_switch_spec should be preferred over deprecated host_switches +property when creating or updating transport nodes.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • transportnode_id (str) – (required)
    • +
  • transport_node (com.vmware.nsx.model_client.TransportNode) – (required)
    • +
  • esx_mgmt_if_migration_dest (str or None) – The network ids to which the ESX vmk interfaces will be migrated +(optional)
    • +
  • if_id (str or None) – The ESX vmk interfaces to migrate (optional)
    • +
  • vnic (str or None) – The ESX vmk interfaces and/or VM NIC to migrate (optional)
    • +
  • vnic_migration_dest (str or None) – The migration destinations of ESX vmk interfaces and/or VM NIC +(optional)
    • +
+
Return type:

com.vmware.nsx.model_client.TransportNode

+
Returns:

com.vmware.nsx.model.TransportNode

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+updatemaintenancemode(transportnode_id, action=None)
+

Put transport node into maintenance mode or exit from maintenance mode.

+ +++ + + + + + + + + + + + + + +
Parameters:
    +
  • transportnode_id (str) – (required)
    • +
  • action (str or None) – (optional)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx_client.TransportZones(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(transport_zone)
+

Creates a new transport zone. The required parameters are +host_switch_name and transport_type (OVERLAY or VLAN). The optional +parameters are description and display_name.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:transport_zone (com.vmware.nsx.model_client.TransportZone) – (required)
Return type:com.vmware.nsx.model_client.TransportZone
Returns:com.vmware.nsx.model.TransportZone
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(zone_id)
+

Deletes an existing transport zone.

+ +++ + + + + + + + + + + + + + +
Parameters:zone_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(zone_id)
+

Returns information about a single transport zone.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:zone_id (str) – (required)
Return type:com.vmware.nsx.model_client.TransportZone
Returns:com.vmware.nsx.model.TransportZone
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, uplink_teaming_policy_name=None)
+

Returns information about configured transport zones. NSX requires at +least one transport zone. NSX uses transport zones to provide +connectivity based on the topology of the underlying network, trust +zones, or organizational separations. For example, you might have +hypervisors that use one network for management traffic and a different +network for VM traffic. This architecture would require two transport +zones. The combination of transport zones plus transport connectors +enables NSX to form tunnels between hypervisors. Transport zones define +which interfaces on the hypervisors can communicate with which other +interfaces on other hypervisors to establish overlay tunnels or provide +connectivity to a VLAN. A logical switch can be in one (and only one) +transport zone. This means that all of a switch’s interfaces must be in +the same transport zone. However, each hypervisor virtual switch (OVS +or VDS) has multiple interfaces (connectors), and each connector can be +attached to a different logical switch. For example, on a single +hypervisor with two connectors, connector A can be attached to logical +switch 1 in transport zone A, while connector B is attached to logical +switch 2 in transport zone B. In this way, a single hypervisor can +participate in multiple transport zones. The API for creating a +transport zone requires that a single host switch be specified for each +transport zone, and multiple transport zones can share the same host +switch.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
  • uplink_teaming_policy_name (str or None) – The transport zone’s uplink teaming policy name (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.TransportZoneListResult

+
Returns:

com.vmware.nsx.model.TransportZoneListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(zone_id, transport_zone)
+

Updates an existing transport zone. Modifiable parameters are +transport_type (VLAN or OVERLAY), description, and display_name. The +request must include the existing host_switch_name.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.TransportZone

+
Returns:

com.vmware.nsx.model.TransportZone

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx_client.TransportzoneProfiles(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(transport_zone_profile)
+

Creates a transport zone profile. The resource_type is required.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:transport_zone_profile (vmware.vapi.struct.VapiStruct) – (required) +The parameter must contain all the attributes defined in +com.vmware.nsx.model_client.TransportZoneProfile.
Return type:vmware.vapi.struct.VapiStruct
Returns:com.vmware.nsx.model.TransportZoneProfile +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.TransportZoneProfile.
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(transportzone_profile_id)
+

Deletes a specified transport zone profile.

+ +++ + + + + + + + + + + + + + +
Parameters:transportzone_profile_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(transportzone_profile_id)
+

Returns information about a specified transport zone profile.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:transportzone_profile_id (str) – (required)
Return type:vmware.vapi.struct.VapiStruct
Returns:com.vmware.nsx.model.TransportZoneProfile +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.TransportZoneProfile.
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, include_system_owned=None, included_fields=None, page_size=None, resource_type=None, sort_ascending=None, sort_by=None)
+

Returns information about the configured transport zone profiles. +Transport zone profiles define networking policies for transport zones +and transport zone endpoints.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • include_system_owned (bool or None) – Whether the list result contains system resources (optional, +default to false)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • resource_type (str or None) – comma-separated list of transport zone profile types, e.g. +?resource_type=BfdHealthMonitoringProfile (optional)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.TransportZoneProfileListResult

+
Returns:

com.vmware.nsx.model.TransportZoneProfileListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(transportzone_profile_id, transport_zone_profile)
+

Modifies a specified transport zone profile. The body of the PUT +request must include the resource_type.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

vmware.vapi.struct.VapiStruct

+
Returns:

com.vmware.nsx.model.TransportZoneProfile +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.TransportZoneProfile.

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx_client.TrustManagement(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Returns information about the supported algorithms and key sizes.

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.TrustManagementData
Returns:com.vmware.nsx.model.TrustManagementData
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx_client.UiViews(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(view)
+

Creates a new View.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:view (com.vmware.nsx.model_client.View) – (required)
Return type:com.vmware.nsx.model_client.View
Returns:com.vmware.nsx.model.View
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(view_id)
+

Delete View

+ +++ + + + + + + + + + + + + + +
Parameters:view_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(view_ids=None, widget_id=None)
+

If no query params are specified then all the views entitled for the +user are returned. The views to which a user is entitled to include the +views created by the user and the shared views.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • view_ids (str or None) – Ids of the Views (optional)
    • +
  • widget_id (str or None) – Id of widget configuration (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.ViewList

+
Returns:

com.vmware.nsx.model.ViewList

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get_0(view_id)
+

Returns Information about a specific View.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:view_id (str) – (required)
Return type:com.vmware.nsx.model_client.View
Returns:com.vmware.nsx.model.View
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+update(view_id, view)
+

Update View

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.View

+
Returns:

com.vmware.nsx.model.View

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx_client.Upgrade(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+upgradeuc()
+

Upgrade the upgrade coordinator.

+ +++ + + + + + + + + + + + +
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+

com.vmware.nsx_client_for_vmc module

+

Convenience methods to get API clients for NSX APIs in VMC

+
+
+class com.vmware.nsx_client_for_vmc.CSPSecurityContextFilter(session, refresh_token, refresh_url)
+

Bases: vmware.vapi.security.client.security_context_filter.SecurityContextFilter

+

CSP Security Context filter in API Provider chain adds the security +context based on a refresh token to the execution context passed in.

+

Initialize SecurityContextFilter

+ +++ + + + +
Parameters:
    +
  • session (requests.Session) – Requests Session object to use for making HTTP calls
    • +
  • refresh_token (str) – Refresh token to use for obtaining an access +token
    • +
  • refresh_url (str) – URL that allows exchanging a refresh token for an +access token
    • +
+
+
+
+get_max_retries()
+

Get the max number of retries

+ +++ + + + + + +
Return type:int
Returns:Number of retries
+
+ +
+
+get_security_context(on_error)
+

Retrieve security context. If this method is called after an error +occured, then a new access token is obtained using the refresh +token and a new security context is created.

+ +++ + + + + + + + +
Parameters:on_error (bool) – Whether this method is called after getting an error
Return type:vmware.vapi.core.SecurityContext
Returns:Security context
+
+ +
+
+should_retry(error_value)
+

Returns whether the request should be retried or not based on the error +specified.

+ +++ + + + + + + + +
Parameters:error_value (vmware.vapi.data.value.ErrorValue) – Method error
Return type:bool
Returns:Returns True if request should be retried in case the error is +either Unauthenticated or Unauthorized else False
+
+ +
+ +
+
+class com.vmware.nsx_client_for_vmc.VmcNsxClient(stub_factory_class, session, refresh_token, vmc_url, csp_url, org_id, sddc_id)
+

Bases: vmware.vapi.bindings.stub.ApiClient

+

Client class that providess access to stubs for all the services in the +VMC NSX API

+

Initialize VmcClient by creating a stub factory instance using a CSP +Security context filter added to the filter chain of the connector

+ +++ + + + +
Parameters:
    +
  • stub_factory_class (type) – Which stub factory class to use
    • +
  • session (requests.Session) – Requests HTTP session instance
    • +
  • refresh_token (str) – Refresh token obtained from CSP
    • +
  • vmc_url (str) – URL of the VMC service
    • +
  • csp_url (str) – URL of the CSP service
    • +
  • org_id (str) – ID of the VMC organization
    • +
  • sddc_id (str) – ID of the VMC Software-Defined Data Center (SDDC)
    • +
+
+
+ +
+
+com.vmware.nsx_client_for_vmc.create_nsx_client_for_vmc(refresh_token, org_id, sddc_id, session=None)
+

Helper method to create an instance of the VMC NSX API client

+ +++ + + + + + + + +
Parameters:
    +
  • refresh_token (str) – Refresh token obtained from CSP
    • +
  • org_id (str) – ID of the VMC organization
    • +
  • sddc_id (str) – ID of the VMC Software-Defined Data Center (SDDC)
    • +
  • session (requests.Session or None) – Requests HTTP session instance. If not specified, then one +is automatically created and used
    • +
+
Return type:

vmware.vapi.vmc.client.VmcNsxClient

+
Returns:

VMC NSX Client instance

+
+
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/com.vmware.nsx.aaa.html b/nsx/nsx/com.vmware.nsx.aaa.html new file mode 100644 index 00000000..88314f56 --- /dev/null +++ b/nsx/nsx/com.vmware.nsx.aaa.html @@ -0,0 +1,457 @@ + + + + + + + + + + + com.vmware.nsx.aaa package — NSX-T SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

com.vmware.nsx.aaa package

+
+

Submodules

+
+
+

com.vmware.nsx.aaa.vidm_client module

+
+
+class com.vmware.nsx.aaa.vidm_client.Groups(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+list(search_string, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Get all the User Groups where vIDM display name matches the search key +case insensitively. The search key is checked to be a substring of +display name. This is a non paginated API.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • search_string (str) – Search string to search for. (required)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.VidmInfoListResult

+
Returns:

com.vmware.nsx.model.VidmInfoListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.aaa.vidm_client.Search(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(search_string, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Get all the users and groups from vIDM matching the search key case +insensitively. The search key is checked to be a substring of name or +given name or family name of user and display name of group. This is a +non paginated API.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • search_string (str) – Search string to search for. (required)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.VidmInfoListResult

+
Returns:

com.vmware.nsx.model.VidmInfoListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.aaa.vidm_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+class com.vmware.nsx.aaa.vidm_client.Users(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+list(search_string, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Get all the users from vIDM whose userName, givenName or familyName +matches the search key case insensitively. The search key is checked to +be a substring of name or given name or family name. This is a non +paginated API.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • search_string (str) – Search string to search for. (required)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.VidmInfoListResult

+
Returns:

com.vmware.nsx.model.VidmInfoListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/com.vmware.nsx.app_discovery.html b/nsx/nsx/com.vmware.nsx.app_discovery.html new file mode 100644 index 00000000..73132b05 --- /dev/null +++ b/nsx/nsx/com.vmware.nsx.app_discovery.html @@ -0,0 +1,573 @@ + + + + + + + + + + + com.vmware.nsx.app_discovery package — NSX-T SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

com.vmware.nsx.app_discovery package

+ +
+

Submodules

+
+
+

com.vmware.nsx.app_discovery.sessions_client module

+
+
+class com.vmware.nsx.app_discovery.sessions_client.AppProfiles(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+list(session_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Returns the application profiles that was part of the application +discovery session | while it was started.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • session_id (str) – (required)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.AppProfileListResult

+
Returns:

com.vmware.nsx.model.AppProfileListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.app_discovery.sessions_client.InstalledApps(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+list(session_id, app_profile_id=None, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, vm_id=None)
+

Returns the details of the installed apps for the app profile ID in +that session

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • session_id (str) – (required)
    • +
  • app_profile_id (str or None) – (optional)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
  • vm_id (str or None) – (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.AppInfoListResult

+
Returns:

com.vmware.nsx.model.AppInfoListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.app_discovery.sessions_client.NsGroups(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+list(session_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Returns the ns groups that was part of the application discovery +session | while it was started

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • session_id (str) – (required)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.NSGroupMetaInfoListResult

+
Returns:

com.vmware.nsx.model.NSGroupMetaInfoListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.app_discovery.sessions_client.ReClassify(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(session_id, session_reclassification_parameter)
+

Re-classify completed application discovery session against input +AppProfiles. If no AppProfiles are specified then we use the previous +AppProfiles of that session.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.AppDiscoverySessionResultSummary

+
Returns:

com.vmware.nsx.model.AppDiscoverySessionResultSummary

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.app_discovery.sessions_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+class com.vmware.nsx.app_discovery.sessions_client.Summary(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(session_id)
+

Returns the summary of the application discovery session

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:session_id (str) – (required)
Return type:com.vmware.nsx.model_client.AppDiscoverySessionResultSummary
Returns:com.vmware.nsx.model.AppDiscoverySessionResultSummary
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/com.vmware.nsx.app_discovery.sessions.html b/nsx/nsx/com.vmware.nsx.app_discovery.sessions.html new file mode 100644 index 00000000..b7b4099a --- /dev/null +++ b/nsx/nsx/com.vmware.nsx.app_discovery.sessions.html @@ -0,0 +1,322 @@ + + + + + + + + + + + com.vmware.nsx.app_discovery.sessions package — NSX-T SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

com.vmware.nsx.app_discovery.sessions package

+
+

Submodules

+
+
+

com.vmware.nsx.app_discovery.sessions.ns_groups_client module

+
+
+class com.vmware.nsx.app_discovery.sessions.ns_groups_client.Members(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+list(session_id, ns_group_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Returns the vms in the ns-group of the application discovery session

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • session_id (str) – (required)
    • +
  • ns_group_id (str) – (required)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.AppDiscoveryVmInfoListResult

+
Returns:

com.vmware.nsx.model.AppDiscoveryVmInfoListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.app_discovery.sessions.ns_groups_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/com.vmware.nsx.cluster.html b/nsx/nsx/com.vmware.nsx.cluster.html new file mode 100644 index 00000000..f118e99b --- /dev/null +++ b/nsx/nsx/com.vmware.nsx.cluster.html @@ -0,0 +1,1003 @@ + + + + + + + + + + + com.vmware.nsx.cluster package — NSX-T SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

com.vmware.nsx.cluster package

+ +
+

Submodules

+
+
+

com.vmware.nsx.cluster.backups_client module

+
+
+class com.vmware.nsx.cluster.backups_client.Config(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Get a configuration of a file server and timers for automated backup. +Fields that contain secrets (password, passphrase) are not returned.

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.BackupConfiguration
Returns:com.vmware.nsx.model.BackupConfiguration
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+update(backup_configuration)
+

Configure file server and timers for automated backup. If secret fields +are omitted (password, passphrase) then use the previously set value.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:backup_configuration (com.vmware.nsx.model_client.BackupConfiguration) – (required)
Return type:com.vmware.nsx.model_client.BackupConfiguration
Returns:com.vmware.nsx.model.BackupConfiguration
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.cluster.backups_client.History(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Get history of previous backup operations

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.BackupOperationHistory
Returns:com.vmware.nsx.model.BackupOperationHistory
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.cluster.backups_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Get status of active backup operations

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.CurrentBackupOperationStatus
Returns:com.vmware.nsx.model.CurrentBackupOperationStatus
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.cluster.backups_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

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

com.vmware.nsx.cluster.nodes_client module

+
+
+class com.vmware.nsx.cluster.nodes_client.Deployments(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(add_cluster_node_vm_info)
+

Deploys a cluster node VM as specified by the deployment config. Once +the VM is deployed, if its role is that of a controller node, it will +automatically register itself with the Manager that deployed it.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:add_cluster_node_vm_info (com.vmware.nsx.model_client.AddClusterNodeVMInfo) – (required)
Return type:com.vmware.nsx.model_client.ClusterNodeVMDeploymentRequestList
Returns:com.vmware.nsx.model.ClusterNodeVMDeploymentRequestList
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(node_id, force_delete=None)
+

Attempts to unregister and undeploy a specified auto-deployed cluster +node VM. If it is a member of a cluster, then the VM will be +automatically detached from the cluster before being unregistered and +undeployed. Alternatively, if the original deployment attempt failed or +the VM is not found, cleans up the deployment information associated +with the deployment attempt. Note: If a VM has been successfully +auto-deployed, then the associated deployment information will not be +deleted unless and until the VM is successfully deleted.

+ +++ + + + + + + + + + + + + + +
Parameters:
    +
  • node_id (str) – (required)
    • +
  • force_delete (bool or None) – Delete by force (optional)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get(node_id)
+

Returns deployment request information for a specific attempted +deployment of a cluster node VM.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:node_id (str) – (required)
Return type:com.vmware.nsx.model_client.ClusterNodeVMDeploymentRequest
Returns:com.vmware.nsx.model.ClusterNodeVMDeploymentRequest
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list()
+

Returns request information for every attempted deployment of a cluster +node VM.

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.ClusterNodeVMDeploymentRequestList
Returns:com.vmware.nsx.model.ClusterNodeVMDeploymentRequestList
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.cluster.nodes_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+GET_SOURCE_CACHED = 'cached'
+

Possible value for source of method Status.get().

+
+ +
+
+GET_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Status.get().

+
+ +
+
+get(node_id, source=None)
+

Read Cluster Node Status

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • node_id (str) – (required)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.ClusterNodeStatus

+
Returns:

com.vmware.nsx.model.ClusterNodeStatus

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+getall()
+

Read Cluster Status

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.ClustersAggregateInfo
Returns:com.vmware.nsx.model.ClustersAggregateInfo
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.cluster.nodes_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

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

com.vmware.nsx.cluster.restore_client module

+
+
+class com.vmware.nsx.cluster.restore_client.Backuptimestamps(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Returns timestamps for all backup files that are available on the SFTP +server.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.ClusterBackupInfoListResult

+
Returns:

com.vmware.nsx.model.ClusterBackupInfoListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.cluster.restore_client.Config(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Get configuration information for the file server used to store +backed-up files. Fields that contain secrets (password, passphrase) are +not returned.

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.RestoreConfiguration
Returns:com.vmware.nsx.model.RestoreConfiguration
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+update(restore_configuration)
+

Configure file server where the backed-up files used for the Restore +operation are available.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:restore_configuration (com.vmware.nsx.model_client.RestoreConfiguration) – (required)
Return type:com.vmware.nsx.model_client.RestoreConfiguration
Returns:com.vmware.nsx.model.RestoreConfiguration
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.cluster.restore_client.InstructionResources(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(instruction_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

For restore operations requiring user input e.g. performing an action, +accepting/rejecting an action, etc. the information to be conveyed to +users is provided in this call.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • instruction_id (str) – Id of the instruction set whose instructions are to be returned +(required)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.ActionableResourceListResult

+
Returns:

com.vmware.nsx.model.ActionableResourceListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.cluster.restore_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Returns status information for the specified NSX cluster restore +request.

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.ClusterRestoreStatus
Returns:com.vmware.nsx.model.ClusterRestoreStatus
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.cluster.restore_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/com.vmware.nsx.cluster.nodes.html b/nsx/nsx/com.vmware.nsx.cluster.nodes.html new file mode 100644 index 00000000..d6ea1d30 --- /dev/null +++ b/nsx/nsx/com.vmware.nsx.cluster.nodes.html @@ -0,0 +1,531 @@ + + + + + + + + + + + com.vmware.nsx.cluster.nodes package — NSX-T SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

com.vmware.nsx.cluster.nodes package

+ +
+

Submodules

+
+
+

com.vmware.nsx.cluster.nodes.deployments_client module

+
+
+class com.vmware.nsx.cluster.nodes.deployments_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(node_id)
+

Returns the current deployment or undeployment status for a VM along +with any other relevant current information, such as error messages.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:node_id (str) – (required)
Return type:com.vmware.nsx.model_client.ClusterNodeVMDeploymentStatusReport
Returns:com.vmware.nsx.model.ClusterNodeVMDeploymentStatusReport
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.cluster.nodes.deployments_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

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

com.vmware.nsx.cluster.nodes.network_client module

+
+
+class com.vmware.nsx.cluster.nodes.network_client.Interfaces(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+GET_SOURCE_CACHED = 'cached'
+

Possible value for source of method Interfaces.get().

+
+ +
+
+GET_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Interfaces.get().

+
+ +
+
+LIST_SOURCE_CACHED = 'cached'
+

Possible value for source of method Interfaces.list().

+
+ +
+
+LIST_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Interfaces.list().

+
+ +
+
+get(node_id, interface_id, source=None)
+

Returns detailed information about the specified interface. Interface +information includes MTU, broadcast and host IP addresses, link and +admin status, MAC address, network mask, and the IP configuration +method (static or DHCP).

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • node_id (str) – (required)
    • +
  • interface_id (str) – (required)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.NodeInterfaceProperties

+
Returns:

com.vmware.nsx.model.NodeInterfaceProperties

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+list(node_id, source=None)
+

Returns the number of interfaces on the node and detailed information +about each interface. Interface information includes MTU, broadcast and +host IP addresses, link and admin status, MAC address, network mask, +and the IP configuration method (static or DHCP).

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • node_id (str) – (required)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.NodeInterfacePropertiesListResult

+
Returns:

com.vmware.nsx.model.NodeInterfacePropertiesListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.cluster.nodes.network_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

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

com.vmware.nsx.cluster.nodes.repo_sync_client module

+
+
+class com.vmware.nsx.cluster.nodes.repo_sync_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(node_id)
+
+++ + + + + + + + + + + + + + + + + + +
Parameters:node_id (str) – (required)
Return type:com.vmware.nsx.model_client.RepoSyncStatusReport
Returns:com.vmware.nsx.model.RepoSyncStatusReport
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.cluster.nodes.repo_sync_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/com.vmware.nsx.cluster.nodes.network.html b/nsx/nsx/com.vmware.nsx.cluster.nodes.network.html new file mode 100644 index 00000000..712af9a8 --- /dev/null +++ b/nsx/nsx/com.vmware.nsx.cluster.nodes.network.html @@ -0,0 +1,332 @@ + + + + + + + + + + + com.vmware.nsx.cluster.nodes.network package — NSX-T SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

com.vmware.nsx.cluster.nodes.network package

+
+

Submodules

+
+
+

com.vmware.nsx.cluster.nodes.network.interfaces_client module

+
+
+class com.vmware.nsx.cluster.nodes.network.interfaces_client.Stats(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+GET_SOURCE_CACHED = 'cached'
+

Possible value for source of method Stats.get().

+
+ +
+
+GET_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Stats.get().

+
+ +
+
+get(node_id, interface_id, source=None)
+

On the specified interface, returns the number of received (rx), +transmitted (tx), and dropped packets; the number of bytes and errors +received and transmitted on the interface; and the number of detected +collisions.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • node_id (str) – (required)
    • +
  • interface_id (str) – (required)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.NodeInterfaceStatisticsProperties

+
Returns:

com.vmware.nsx.model.NodeInterfaceStatisticsProperties

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.cluster.nodes.network.interfaces_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/com.vmware.nsx.dhcp.html b/nsx/nsx/com.vmware.nsx.dhcp.html new file mode 100644 index 00000000..35ccd048 --- /dev/null +++ b/nsx/nsx/com.vmware.nsx.dhcp.html @@ -0,0 +1,898 @@ + + + + + + + + + + + com.vmware.nsx.dhcp package — NSX-T SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

com.vmware.nsx.dhcp package

+
+

Submodules

+
+
+

com.vmware.nsx.dhcp.servers_client module

+
+
+class com.vmware.nsx.dhcp.servers_client.IpPools(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(server_id, dhcp_ip_pool)
+

Create an IP pool for a DHCP server

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.DhcpIpPool

+
Returns:

com.vmware.nsx.model.DhcpIpPool

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+delete(server_id, pool_id)
+

Delete a DHCP server’s IP pool

+ +++ + + + + + + + + + + + + + +
Parameters:
    +
  • server_id (str) – (required)
    • +
  • pool_id (str) – (required)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get(server_id, pool_id)
+

Get a DHCP server’s IP pool with the specified pool ID

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • server_id (str) – (required)
    • +
  • pool_id (str) – (required)
    • +
+
Return type:

com.vmware.nsx.model_client.DhcpIpPool

+
Returns:

com.vmware.nsx.model.DhcpIpPool

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+list(server_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Get a paginated list of a DHCP server’s IP pools

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • server_id (str) – (required)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.DhcpIpPoolListResult

+
Returns:

com.vmware.nsx.model.DhcpIpPoolListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(server_id, pool_id, dhcp_ip_pool)
+

Update a DHCP server’s IP pool

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.DhcpIpPool

+
Returns:

com.vmware.nsx.model.DhcpIpPool

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.dhcp.servers_client.Leases(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+GET_SOURCE_CACHED = 'cached'
+

Possible value for source of method Leases.get().

+
+ +
+
+GET_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Leases.get().

+
+ +
+
+get(server_id, address=None, pool_id=None, source=None)
+

Get lease info of a given dhcp server id. If a "pool_id" is +specified, the lease info of the pool are returned. If an +"address" is specified, only the lease info the this address is +returned. The "address" can be a single IP, an ip-range, or a +mac address. "pool_id" and "address" are mutually +excluded. Either a "pool_id" or an "address" can be +provided, but not both.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • server_id (str) – (required)
    • +
  • address (str or None) – can be an ip address, or an ip range, or a mac address (optional)
    • +
  • pool_id (str or None) – The uuid of dhcp ip pool (optional)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.DhcpLeases

+
Returns:

com.vmware.nsx.model.DhcpLeases

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.dhcp.servers_client.StaticBindings(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(server_id, dhcp_static_binding)
+

Create a static binding for a DHCP server

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.DhcpStaticBinding

+
Returns:

com.vmware.nsx.model.DhcpStaticBinding

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+delete(server_id, binding_id)
+

Delete a static binding

+ +++ + + + + + + + + + + + + + +
Parameters:
    +
  • server_id (str) – (required)
    • +
  • binding_id (str) – (required)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get(server_id, binding_id)
+

Get a DHCP server’s static binding with the specified binding ID

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • server_id (str) – (required)
    • +
  • binding_id (str) – (required)
    • +
+
Return type:

com.vmware.nsx.model_client.DhcpStaticBinding

+
Returns:

com.vmware.nsx.model.DhcpStaticBinding

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+list(server_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Get a paginated list of a DHCP server’s static bindings

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • server_id (str) – (required)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.DhcpStaticBindingListResult

+
Returns:

com.vmware.nsx.model.DhcpStaticBindingListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(server_id, binding_id, dhcp_static_binding)
+

Update a DHCP server’s static binding

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.DhcpStaticBinding

+
Returns:

com.vmware.nsx.model.DhcpStaticBinding

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.dhcp.servers_client.Statistics(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(server_id)
+

Returns the statistics of the given dhcp server.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:server_id (str) – (required)
Return type:com.vmware.nsx.model_client.DhcpStatistics
Returns:com.vmware.nsx.model.DhcpStatistics
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.dhcp.servers_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(server_id)
+

Returns the service status of the given dhcp server.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:server_id (str) – (required)
Return type:com.vmware.nsx.model_client.DhcpServerStatus
Returns:com.vmware.nsx.model.DhcpServerStatus
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.dhcp.servers_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/com.vmware.nsx.dns.html b/nsx/nsx/com.vmware.nsx.dns.html new file mode 100644 index 00000000..c53da04b --- /dev/null +++ b/nsx/nsx/com.vmware.nsx.dns.html @@ -0,0 +1,315 @@ + + + + + + + + + + + com.vmware.nsx.dns package — NSX-T SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

com.vmware.nsx.dns package

+
+

Submodules

+
+
+

com.vmware.nsx.dns.forwarders_client module

+
+
+class com.vmware.nsx.dns.forwarders_client.Nslookup(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(forwarder_id, address=None)
+

Query the nameserver for an ip-address or a FQDN of the given an +address optionally using an specified DNS server. If the address is a +fqdn, nslookup will resolve ip-address with it. If the address is an +ip-address, do a reverse lookup and answer fqdn(s).

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • forwarder_id (str) – (required)
    • +
  • address (str or None) – IP address or FQDN for nslookup (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.DnsAnswer

+
Returns:

com.vmware.nsx.model.DnsAnswer

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.dns.forwarders_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/com.vmware.nsx.fabric.compute_collections.html b/nsx/nsx/com.vmware.nsx.fabric.compute_collections.html new file mode 100644 index 00000000..5f2e50b8 --- /dev/null +++ b/nsx/nsx/com.vmware.nsx.fabric.compute_collections.html @@ -0,0 +1,305 @@ + + + + + + + + + + + com.vmware.nsx.fabric.compute_collections package — NSX-T SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

com.vmware.nsx.fabric.compute_collections package

+
+

Submodules

+
+
+

com.vmware.nsx.fabric.compute_collections.network_client module

+
+
+class com.vmware.nsx.fabric.compute_collections.network_client.PhysicalInterfaces(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+list(cc_ext_id)
+

Returns list of physical network interfaces for all discovered nodes in +compute collection. Interface information includes PNIC name, +hostswitch name it’s attached to(if any) and MAC address.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:cc_ext_id (str) – (required)
Return type:com.vmware.nsx.model_client.ComputeCollectionNetworkInterfacesListResult
Returns:com.vmware.nsx.model.ComputeCollectionNetworkInterfacesListResult
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.fabric.compute_collections.network_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/com.vmware.nsx.fabric.html b/nsx/nsx/com.vmware.nsx.fabric.html new file mode 100644 index 00000000..9c4236c1 --- /dev/null +++ b/nsx/nsx/com.vmware.nsx.fabric.html @@ -0,0 +1,643 @@ + + + + + + + + + + + com.vmware.nsx.fabric package — NSX-T SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

com.vmware.nsx.fabric package

+ +
+

Submodules

+
+
+

com.vmware.nsx.fabric.compute_managers_client module

+
+
+class com.vmware.nsx.fabric.compute_managers_client.State(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(compute_manager_id)
+

Get the realized state of a compute manager

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:compute_manager_id (str) – (required)
Return type:com.vmware.nsx.model_client.ConfigurationState
Returns:com.vmware.nsx.model.ConfigurationState
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.fabric.compute_managers_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(compute_manager_id)
+

Returns connection and version information about a compute manager

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:compute_manager_id (str) – (required)
Return type:com.vmware.nsx.model_client.ComputeManagerStatus
Returns:com.vmware.nsx.model.ComputeManagerStatus
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.fabric.compute_managers_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

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

com.vmware.nsx.fabric.nodes_client module

+
+
+class com.vmware.nsx.fabric.nodes_client.Capabilities(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(node_id)
+

Returns information about capabilities of a single fabric host node. +Edge nodes do not have capabilities.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:node_id (str) – (required)
Return type:com.vmware.nsx.model_client.NodeCapabilitiesResult
Returns:com.vmware.nsx.model.NodeCapabilitiesResult
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.fabric.nodes_client.Modules(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(node_id)
+

Get the module details of a Fabric Node

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:node_id (str) – (required)
Return type:com.vmware.nsx.model_client.SoftwareModuleResult
Returns:com.vmware.nsx.model.SoftwareModuleResult
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.fabric.nodes_client.State(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(node_id)
+

For edge nodes, returns the current install state when deployment is in +progress, NODE_READY when deployment is complete and the failure state +when deployment has failed.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:node_id (str) – (required)
Return type:com.vmware.nsx.model_client.ConfigurationState
Returns:com.vmware.nsx.model.ConfigurationState
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.fabric.nodes_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+GET_SOURCE_CACHED = 'cached'
+

Possible value for source of method Status.get().

+
+ +
+
+GET_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Status.get().

+
+ +
+
+get(node_id, source=None)
+

Returns connectivity, heartbeat, and version information about a fabric +node (host or edge). Note that the LCP connectivity status remains down +until after the fabric node has been added as a transpot node and the +NSX host switch has been successfully installed. See POST +/api/v1/transport-nodes.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • node_id (str) – (required)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.NodeStatus

+
Returns:

com.vmware.nsx.model.NodeStatus

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+getall(node_ids)
+

Returns connectivity, heartbeat, and version information about all +fabric nodes (host or edge).

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:node_ids (str) – List of requested Nodes. (required)
Return type:com.vmware.nsx.model_client.NodeStatusListResult
Returns:com.vmware.nsx.model.NodeStatusListResult
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.fabric.nodes_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/com.vmware.nsx.fabric.nodes.html b/nsx/nsx/com.vmware.nsx.fabric.nodes.html new file mode 100644 index 00000000..867c9261 --- /dev/null +++ b/nsx/nsx/com.vmware.nsx.fabric.nodes.html @@ -0,0 +1,401 @@ + + + + + + + + + + + com.vmware.nsx.fabric.nodes package — NSX-T SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

com.vmware.nsx.fabric.nodes package

+ +
+

Submodules

+
+
+

com.vmware.nsx.fabric.nodes.network_client module

+
+
+class com.vmware.nsx.fabric.nodes.network_client.Interfaces(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+GET_SOURCE_CACHED = 'cached'
+

Possible value for source of method Interfaces.get().

+
+ +
+
+GET_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Interfaces.get().

+
+ +
+
+LIST_SOURCE_CACHED = 'cached'
+

Possible value for source of method Interfaces.list().

+
+ +
+
+LIST_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Interfaces.list().

+
+ +
+
+get(node_id, interface_id, source=None)
+

Returns detailed information about the specified interface. Interface +information includes MTU, broadcast and host IP addresses, link and +admin status, MAC address, network mask, and the IP configuration +method (static or DHCP).

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • node_id (str) – (required)
    • +
  • interface_id (str) – (required)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.NodeInterfaceProperties

+
Returns:

com.vmware.nsx.model.NodeInterfaceProperties

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+list(node_id, source=None)
+

Returns the number of interfaces on the node and detailed information +about each interface. Interface information includes MTU, broadcast and +host IP addresses, link and admin status, MAC address, network mask, +and the IP configuration method (static or DHCP).

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • node_id (str) – (required)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.NodeInterfacePropertiesListResult

+
Returns:

com.vmware.nsx.model.NodeInterfacePropertiesListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.fabric.nodes.network_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/com.vmware.nsx.fabric.nodes.network.html b/nsx/nsx/com.vmware.nsx.fabric.nodes.network.html new file mode 100644 index 00000000..b2733a1c --- /dev/null +++ b/nsx/nsx/com.vmware.nsx.fabric.nodes.network.html @@ -0,0 +1,332 @@ + + + + + + + + + + + com.vmware.nsx.fabric.nodes.network package — NSX-T SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

com.vmware.nsx.fabric.nodes.network package

+
+

Submodules

+
+
+

com.vmware.nsx.fabric.nodes.network.interfaces_client module

+
+
+class com.vmware.nsx.fabric.nodes.network.interfaces_client.Stats(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+GET_SOURCE_CACHED = 'cached'
+

Possible value for source of method Stats.get().

+
+ +
+
+GET_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Stats.get().

+
+ +
+
+get(node_id, interface_id, source=None)
+

On the specified interface, returns the number of received (rx), +transmitted (tx), and dropped packets; the number of bytes and errors +received and transmitted on the interface; and the number of detected +collisions.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • node_id (str) – (required)
    • +
  • interface_id (str) – (required)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.NodeInterfaceStatisticsProperties

+
Returns:

com.vmware.nsx.model.NodeInterfaceStatisticsProperties

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.fabric.nodes.network.interfaces_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/com.vmware.nsx.firewall.html b/nsx/nsx/com.vmware.nsx.firewall.html new file mode 100644 index 00000000..d082bc55 --- /dev/null +++ b/nsx/nsx/com.vmware.nsx.firewall.html @@ -0,0 +1,925 @@ + + + + + + + + + + + com.vmware.nsx.firewall package — NSX-T SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

com.vmware.nsx.firewall package

+ +
+

Submodules

+
+
+

com.vmware.nsx.firewall.rules_client module

+
+
+class com.vmware.nsx.firewall.rules_client.State(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(rule_id, barrier_id=None, request_id=None)
+

Return realized state information of a firewall rule.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • rule_id (str) – (required)
    • +
  • barrier_id (long or None) – (optional)
    • +
  • request_id (str or None) – Realization request ID (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.RuleState

+
Returns:

com.vmware.nsx.model.RuleState

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.firewall.rules_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

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

com.vmware.nsx.firewall.sections_client module

+
+
+class com.vmware.nsx.firewall.sections_client.Rules(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+CREATEMULTIPLE_OPERATION_AFTER = 'insert_after'
+

Possible value for operation of method Rules.createmultiple().

+
+ +
+
+CREATEMULTIPLE_OPERATION_BEFORE = 'insert_before'
+

Possible value for operation of method Rules.createmultiple().

+
+ +
+
+CREATEMULTIPLE_OPERATION_BOTTOM = 'insert_bottom'
+

Possible value for operation of method Rules.createmultiple().

+
+ +
+
+CREATEMULTIPLE_OPERATION_TOP = 'insert_top'
+

Possible value for operation of method Rules.createmultiple().

+
+ +
+
+CREATE_OPERATION_AFTER = 'insert_after'
+

Possible value for operation of method Rules.create().

+
+ +
+
+CREATE_OPERATION_BEFORE = 'insert_before'
+

Possible value for operation of method Rules.create().

+
+ +
+
+CREATE_OPERATION_BOTTOM = 'insert_bottom'
+

Possible value for operation of method Rules.create().

+
+ +
+
+CREATE_OPERATION_TOP = 'insert_top'
+

Possible value for operation of method Rules.create().

+
+ +
+
+LIST_FILTER_TYPE_FILTER = 'FILTER'
+

Possible value for filterType of method Rules.list().

+
+ +
+ +

Possible value for filterType of method Rules.list().

+
+ +
+
+REVISE_OPERATION_AFTER = 'insert_after'
+

Possible value for operation of method Rules.revise().

+
+ +
+
+REVISE_OPERATION_BEFORE = 'insert_before'
+

Possible value for operation of method Rules.revise().

+
+ +
+
+REVISE_OPERATION_BOTTOM = 'insert_bottom'
+

Possible value for operation of method Rules.revise().

+
+ +
+
+REVISE_OPERATION_TOP = 'insert_top'
+

Possible value for operation of method Rules.revise().

+
+ +
+
+create(section_id, firewall_rule, id=None, operation=None)
+

Adds a new firewall rule in existing firewall section. Adding firewall +rule to a section modifies parent section entity and simultaneous +update (modify) operations on same section are not allowed to prevent +overwriting stale content to firewall section. If a concurrent update +is performed, HTTP response code 409 will be returned to the client +operating on stale data. That client should retrieve the firewall +section again and re-apply its update.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • section_id (str) – (required)
    • +
  • firewall_rule (com.vmware.nsx.model_client.FirewallRule) – (required)
    • +
  • id (str or None) – Identifier of the anchor rule or section. This is a required field +in case operation like ‘insert_before’ and ‘insert_after’. +(optional)
    • +
  • operation (str or None) – Operation (optional, default to insert_top)
    • +
+
Return type:

com.vmware.nsx.model_client.FirewallRule

+
Returns:

com.vmware.nsx.model.FirewallRule

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+createmultiple(section_id, firewall_rule_list, id=None, operation=None)
+

Create multiple firewall rules in existing firewall section bounded by +limit of 1000 firewall rules per section. Adding multiple firewall +rules in a section modifies parent section entity and simultaneous +update (modify) operations on same section are not allowed to prevent +overwriting stale contents to firewall section. If a concurrent update +is performed, HTTP response code 409 will be returned to the client +operating on stale data. That client should retrieve the firewall +section again and re-apply its update.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • section_id (str) – (required)
    • +
  • firewall_rule_list (com.vmware.nsx.model_client.FirewallRuleList) – (required)
    • +
  • id (str or None) – Identifier of the anchor rule or section. This is a required field +in case operation like ‘insert_before’ and ‘insert_after’. +(optional)
    • +
  • operation (str or None) – Operation (optional, default to insert_top)
    • +
+
Return type:

com.vmware.nsx.model_client.FirewallRuleList

+
Returns:

com.vmware.nsx.model.FirewallRuleList

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+delete(section_id, rule_id)
+

Delete existing firewall rule in a firewall section. Deleting firewall +rule in a section modifies parent section and simultaneous update +(modify) operations on same section are not allowed to prevent +overwriting stale contents to firewall section. If a concurrent update +is performed, HTTP response code 409 will be returned to the client +operating on stale data. That client should retrieve the firewall +section again and re-apply its update.

+ +++ + + + + + + + + + + + + + +
Parameters:
    +
  • section_id (str) – (required)
    • +
  • rule_id (str) – (required)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get(section_id, rule_id)
+

Return existing firewall rule information in a firewall section.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • section_id (str) – (required)
    • +
  • rule_id (str) – (required)
    • +
+
Return type:

com.vmware.nsx.model_client.FirewallRule

+
Returns:

com.vmware.nsx.model.FirewallRule

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+list(section_id, applied_tos=None, cursor=None, destinations=None, filter_type=None, included_fields=None, page_size=None, search_invalid_references=None, services=None, sort_ascending=None, sort_by=None, sources=None)
+

Return all firewall rule(s) information for a given firewall section.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • section_id (str) – (required)
    • +
  • applied_tos (str or None) – AppliedTo’s referenced by this section or section’s Distributed +Service Rules . (optional)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • destinations (str or None) – Destinations referenced by this section’s Distributed Service Rules +. (optional)
    • +
  • filter_type (str or None) – Filter type (optional, default to FILTER)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • search_invalid_references (bool or None) – Return invalid references in results. (optional, default to false)
    • +
  • services (str or None) – NSService referenced by this section’s Distributed Service Rules . +(optional)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
  • sources (str or None) – Sources referenced by this section’s Distributed Service Rules . +(optional)
    • +
+
Return type:

com.vmware.nsx.model_client.FirewallRuleListResult

+
Returns:

com.vmware.nsx.model.FirewallRuleListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+revise(section_id, rule_id, firewall_rule, id=None, operation=None)
+

Modifies existing firewall rule along with relative position among +other firewall rules inside a firewall section. Revising firewall rule +in a section modifies parent section entity and simultaneous update +(modify) operations on same section are not allowed to prevent +overwriting stale contents to firewall section. If a concurrent update +is performed, HTTP response code 409 will be returned to the client +operating on stale data. That client should retrieve the firewall +section again and re-apply its update.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • section_id (str) – (required)
    • +
  • rule_id (str) – (required)
    • +
  • firewall_rule (com.vmware.nsx.model_client.FirewallRule) – (required)
    • +
  • id (str or None) – Identifier of the anchor rule or section. This is a required field +in case operation like ‘insert_before’ and ‘insert_after’. +(optional)
    • +
  • operation (str or None) – Operation (optional, default to insert_top)
    • +
+
Return type:

com.vmware.nsx.model_client.FirewallRule

+
Returns:

com.vmware.nsx.model.FirewallRule

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(section_id, rule_id, firewall_rule)
+

Modifies existing firewall rule in a firewall section. Updating +firewall rule in a section modifies parent section entity and +simultaneous update (modify) operations on same section are not allowed +to prevent overwriting stale contents to firewall section. If a +concurrent update is performed, HTTP response code 409 will be returned +to the client operating on stale data. That client should retrieve the +firewall section again and re-apply its update.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.FirewallRule

+
Returns:

com.vmware.nsx.model.FirewallRule

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.firewall.sections_client.State(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(section_id, barrier_id=None, request_id=None)
+

Return realized state information of a firewall section.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • section_id (str) – (required)
    • +
  • barrier_id (long or None) – (optional)
    • +
  • request_id (str or None) – Realization request ID (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.FirewallSectionState

+
Returns:

com.vmware.nsx.model.FirewallSectionState

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.firewall.sections_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+class com.vmware.nsx.firewall.sections_client.Summary(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+GET_SOURCE_CACHED = 'cached'
+

Possible value for source of method Summary.get().

+
+ +
+
+GET_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Summary.get().

+
+ +
+
+get(source=None)
+

List the summary of number of sections and number of rules for each +firewall category (L2DFW, L3DFW).

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:source (str or None) – Data source type. (optional)
Return type:com.vmware.nsx.model_client.FirewallSectionsSummaryList
Returns:com.vmware.nsx.model.FirewallSectionsSummaryList
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/com.vmware.nsx.firewall.sections.html b/nsx/nsx/com.vmware.nsx.firewall.sections.html new file mode 100644 index 00000000..25d98513 --- /dev/null +++ b/nsx/nsx/com.vmware.nsx.firewall.sections.html @@ -0,0 +1,401 @@ + + + + + + + + + + + com.vmware.nsx.firewall.sections package — NSX-T SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

com.vmware.nsx.firewall.sections package

+
+

Submodules

+
+
+

com.vmware.nsx.firewall.sections.rules_client module

+
+
+class com.vmware.nsx.firewall.sections.rules_client.Stats(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+GET_0_SOURCE_CACHED = 'cached'
+

Possible value for source of method Stats.get_0().

+
+ +
+
+GET_0_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Stats.get_0().

+
+ +
+
+GET_SOURCE_CACHED = 'cached'
+

Possible value for source of method Stats.get().

+
+ +
+
+GET_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Stats.get().

+
+ +
+
+get(section_id, source=None)
+

Get aggregated statistics for all rules for a given firewall section. +The API only supports access to cached (source=cached) statistical data +collected offline in the system. Data includes total number of packets, +bytes, sessions counters and popularity index for a firewall rule and +overall session count, max session count and max popularity index for +all firewall rules on transport nodes or edge nodes. Aggregated +statistics like maximum popularity index, maximum session count and +total session count are computed with lower frequency compared to +individual generic rule statistics, hence they may have a computation +delay up to 15 minutes to reflect in response to this API.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • section_id (str) – (required)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.FirewallStatsList

+
Returns:

com.vmware.nsx.model.FirewallStatsList

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get_0(section_id, rule_id, source=None)
+

Get aggregated statistics for a rule for given firewall section. The +API only supports access to cached (source=cached) statistical data +collected offline in the system. Data includes total number of packets, +bytes, sessions counters and popularity index for a firewall rule and +overall session count, max session count and max popularity index for +all firewall rules on transport nodes or edge nodes. Aggregated +statistics like maximum popularity index, maximum session count and +total session count are computed with lower frequency compared to +individual generic rule statistics, hence they may have a computation +delay up to 15 minutes to reflect in response to this API.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • section_id (str) – (required)
    • +
  • rule_id (str) – (required)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.FirewallStats

+
Returns:

com.vmware.nsx.model.FirewallStats

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.firewall.sections.rules_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/com.vmware.nsx.html b/nsx/nsx/com.vmware.nsx.html new file mode 100644 index 00000000..42b2fed6 --- /dev/null +++ b/nsx/nsx/com.vmware.nsx.html @@ -0,0 +1,79840 @@ + + + + + + + + + + + com.vmware.nsx package — NSX-T SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

com.vmware.nsx package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.nsx.aaa_client module

+
+
+class com.vmware.nsx.aaa_client.RegistrationToken(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create()
+

The privileges of the registration token will be the same as the +caller.

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.RegistrationToken
Returns:com.vmware.nsx.model.RegistrationToken
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(token)
+

Delete registration access token

+ +++ + + + + + + + + + + + + + +
Parameters:token (str) – Registration token (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(token)
+

Get registration access token

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:token (str) – Registration token (required)
Return type:com.vmware.nsx.model_client.RegistrationToken
Returns:com.vmware.nsx.model.RegistrationToken
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.aaa_client.RoleBindings(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+LIST_TYPE_LOCAL_USER = 'local_user'
+

Possible value for type of method RoleBindings.list().

+
+ +
+
+LIST_TYPE_PRINCIPAL_IDENTITY = 'principal_identity'
+

Possible value for type of method RoleBindings.list().

+
+ +
+
+LIST_TYPE_REMOTE_GROUP = 'remote_group'
+

Possible value for type of method RoleBindings.list().

+
+ +
+
+LIST_TYPE_REMOTE_USER = 'remote_user'
+

Possible value for type of method RoleBindings.list().

+
+ +
+
+create(role_binding)
+

Assign roles to User or Group

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:role_binding (com.vmware.nsx.model_client.RoleBinding) – (required)
Return type:com.vmware.nsx.model_client.RoleBinding
Returns:com.vmware.nsx.model.RoleBinding
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(binding_id)
+

Delete user/group’s roles assignment

+ +++ + + + + + + + + + + + + + +
Parameters:binding_id (str) – User/Group’s id (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+deletestalebindings()
+

Delete all stale role assignments

+ +++ + + + + + + + + + + + +
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(binding_id)
+

Get user/group’s role information

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:binding_id (str) – User/Group’s id (required)
Return type:com.vmware.nsx.model_client.RoleBinding
Returns:com.vmware.nsx.model.RoleBinding
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, name=None, page_size=None, sort_ascending=None, sort_by=None, type=None)
+

Get all users and groups with their roles

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • name (str or None) – User/Group name (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
  • type (str or None) – Type (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.RoleBindingListResult

+
Returns:

com.vmware.nsx.model.RoleBindingListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(binding_id, role_binding)
+

Update User or Group’s roles

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.RoleBinding

+
Returns:

com.vmware.nsx.model.RoleBinding

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.aaa_client.Roles(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(role)
+

Get role information

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:role (str) – Role Name (required)
Return type:com.vmware.nsx.model_client.RoleWithFeatures
Returns:com.vmware.nsx.model.RoleWithFeatures
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list()
+

Get information about all roles

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.RoleListResult
Returns:com.vmware.nsx.model.RoleListResult
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.aaa_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+class com.vmware.nsx.aaa_client.UserInfo(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Get information about logged-in user. The permissions parameter of the +NsxRole has been deprecated.

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.UserInfo
Returns:com.vmware.nsx.model.UserInfo
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+

com.vmware.nsx.administration_client module

+
+
+class com.vmware.nsx.administration_client.AuditLogs(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(audit_log_request, cursor=None, fields=None, page_size=None)
+

This API is executed on a manager node to display audit logs from all +nodes inside the management plane cluster. An audit log collection will +be triggered if the local master audit log is outdated.

+ +++ + + + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • audit_log_request (com.vmware.nsx.model_client.AuditLogRequest) – (required)
    • +
  • cursor (long or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • fields (str or None) – Fields to include in query results (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 100)
    • +
+
Return type:

com.vmware.nsx.model_client.AuditLogListResult

+
Returns:

com.vmware.nsx.model.AuditLogListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error, Bad Gateway

+
Raise:

com.vmware.vapi.std.errors_client.ConcurrentChange +Conflict

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.administration_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+class com.vmware.nsx.administration_client.SupportBundles(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+collect(support_bundle_request, override_async_response=None)
+

Collect support bundles from registered cluster and fabric nodes.

+ +++ + + + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.SupportBundleResult

+
Returns:

com.vmware.nsx.model.SupportBundleResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error, Bad Gateway

+
Raise:

com.vmware.vapi.std.errors_client.ConcurrentChange +Conflict

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+

com.vmware.nsx.app_discovery_client module

+
+
+class com.vmware.nsx.app_discovery_client.AppProfiles(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(app_profile)
+

Adds a new app profile

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:app_profile (com.vmware.nsx.model_client.AppProfile) – (required)
Return type:com.vmware.nsx.model_client.AppProfile
Returns:com.vmware.nsx.model.AppProfile
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(app_profile_id, force=None)
+

Deletes the specified AppProfile.

+ +++ + + + + + + + + + + + + + +
Parameters:
    +
  • app_profile_id (str) – (required)
    • +
  • force (bool or None) – Force delete the resource even if it is being used somewhere +(optional, default to false)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get(app_profile_id)
+

Returns detail of the app profile

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:app_profile_id (str) – (required)
Return type:com.vmware.nsx.model_client.AppProfile
Returns:com.vmware.nsx.model.AppProfile
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Returns list of app profile IDs created

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.AppProfileListResult

+
Returns:

com.vmware.nsx.model.AppProfileListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(app_profile_id, app_profile)
+

Update AppProfile

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.AppProfile

+
Returns:

com.vmware.nsx.model.AppProfile

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.app_discovery_client.Sessions(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+LIST_STATUS_FAILED = 'FAILED'
+

Possible value for status of method Sessions.list().

+
+ +
+
+LIST_STATUS_FINISHED = 'FINISHED'
+

Possible value for status of method Sessions.list().

+
+ +
+
+LIST_STATUS_RUNNING = 'RUNNING'
+

Possible value for status of method Sessions.list().

+
+ +
+
+LIST_STATUS_STARTING = 'STARTING'
+

Possible value for status of method Sessions.list().

+
+ +
+
+create(start_app_discovery_session_parameters)
+

Starts the discovery of application discovery session

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:start_app_discovery_session_parameters (com.vmware.nsx.model_client.StartAppDiscoverySessionParameters) – (required)
Return type:com.vmware.nsx.model_client.AppDiscoverySession
Returns:com.vmware.nsx.model.AppDiscoverySession
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(session_id)
+

Cancel and delete the application discovery session

+ +++ + + + + + + + + + + + + + +
Parameters:session_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(session_id)
+

Returns the status of the application discovery session and other +details

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:session_id (str) – (required)
Return type:com.vmware.nsx.model_client.AppDiscoverySession
Returns:com.vmware.nsx.model.AppDiscoverySession
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, group_id=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, status=None)
+

Returns the list of the application discovery sessions available

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • group_id (str or None) – NSGroup id, helps user query sessions related to one nsgroup +(optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
  • status (str or None) – Session Status, e.g. get all running sessions (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.AppDiscoverySessionsListResult

+
Returns:

com.vmware.nsx.model.AppDiscoverySessionsListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.app_discovery_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

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

com.vmware.nsx.bridge_clusters_client module

+
+
+class com.vmware.nsx.bridge_clusters_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+GET_SOURCE_CACHED = 'cached'
+

Possible value for source of method Status.get().

+
+ +
+
+GET_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Status.get().

+
+ +
+
+get(cluster_id, source=None)
+

Get the status for the Bridge Cluster of the given cluster id

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cluster_id (str) – (required)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.BridgeClusterStatus

+
Returns:

com.vmware.nsx.model.BridgeClusterStatus

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.bridge_clusters_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

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

com.vmware.nsx.bridge_endpoints_client module

+
+
+class com.vmware.nsx.bridge_endpoints_client.Statistics(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+GET_SOURCE_CACHED = 'cached'
+

Possible value for source of method Statistics.get().

+
+ +
+
+GET_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Statistics.get().

+
+ +
+
+get(endpoint_id, source=None)
+

Get the statistics for the Bridge Endpoint of the given Endpoint id +(endpoint-id)

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • endpoint_id (str) – (required)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.BridgeEndpointStatistics

+
Returns:

com.vmware.nsx.model.BridgeEndpointStatistics

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.bridge_endpoints_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+GET_SOURCE_CACHED = 'cached'
+

Possible value for source of method Status.get().

+
+ +
+
+GET_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Status.get().

+
+ +
+
+get(endpoint_id, source=None)
+

Get the status for the Bridge Endpoint of the given Endpoint id

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • endpoint_id (str) – (required)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.BridgeEndpointStatus

+
Returns:

com.vmware.nsx.model.BridgeEndpointStatus

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.bridge_endpoints_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

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

com.vmware.nsx.cluster_client module

+
+
+class com.vmware.nsx.cluster_client.Backups(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+retrievesshfingerprint(remote_server_fingerprint_request)
+

Get SHA256 fingerprint of ECDSA key of remote server. The caller should +independently verify that the key is trusted.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:remote_server_fingerprint_request (com.vmware.nsx.model_client.RemoteServerFingerprintRequest) – (required)
Return type:com.vmware.nsx.model_client.RemoteServerFingerprint
Returns:com.vmware.nsx.model.RemoteServerFingerprint
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.cluster_client.Node(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+reposync()
+

Attempts to synchronize the repository partition on nsx manager. +Repository partition contains packages required for the install and +upgrade of nsx components.Normally there is no need to call this API +explicitely by the user.

+ +++ + + + + + + + + + + + +
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.cluster_client.Nodes(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+CREATE_ACTION_NODE = 'add_cluster_node'
+

Possible value for action of method Nodes.create().

+
+ +
+
+create(add_cluster_node_spec, action)
+

Adds a new controller node to the NSX cluster.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.ClusterNodeConfig

+
Returns:

com.vmware.nsx.model.ClusterNodeConfig

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+delete(node_id)
+

Removes the specified controller node from the NSX cluster. Before you +can remove a controller node from the cluster, you must shut down the +controller service with the "stop service controller" command.

+ +++ + + + + + + + + + + + + + +
Parameters:node_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(node_id)
+

Returns information about the specified NSX cluster node.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:node_id (str) – (required)
Return type:com.vmware.nsx.model_client.ClusterNodeConfig
Returns:com.vmware.nsx.model.ClusterNodeConfig
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Returns information about all NSX cluster nodes.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.ClusterNodeConfigListResult

+
Returns:

com.vmware.nsx.model.ClusterNodeConfigListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.cluster_client.Restore(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+advance(advance_cluster_restore_request)
+

Advance any currently suspended restore operation. The operation might +have been suspended because (1) the user had suspended it previously, +or (2) the operation is waiting for user input, to be provided as a +part of the POST request body. This operation is only valid when a GET +cluster/restore/status returns a status with value SUSPENDED. +Otherwise, a 409 response is returned.

+ +++ + + + + + + + + + + + + + + + + + + + +
Parameters:advance_cluster_restore_request (com.vmware.nsx.model_client.AdvanceClusterRestoreRequest) – (required)
Return type:com.vmware.nsx.model_client.ClusterRestoreStatus
Returns:com.vmware.nsx.model.ClusterRestoreStatus
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.ConcurrentChange +Conflict
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+cancel()
+

Cancel any currently running restore operation. If there exists a +currently running step, it is allowed to finish. The system is not +rolled back to the pre-restore state. This operation is only valid when +a GET cluster/restore/status returns a status with value RUNNING or +SUSPENDED. Otherwise, a 409 response is returned.

+ +++ + + + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.ClusterRestoreStatus
Returns:com.vmware.nsx.model.ClusterRestoreStatus
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.ConcurrentChange +Conflict
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+retry()
+

Retry any currently in-progress, failed restore operation. Only the +last step of the multi-step restore operation would have failed,and +only that step is retried. This operation is only valid when a GET +cluster/restore/status returns a status with value FAILED. Otherwise, a +409 response is returned.

+ +++ + + + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.ClusterRestoreStatus
Returns:com.vmware.nsx.model.ClusterRestoreStatus
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.ConcurrentChange +Conflict
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+start(initiate_cluster_restore_request)
+

Start the restore of an NSX cluster, from some previously backed-up +configuration. This operation is only valid when a GET +cluster/restore/status returns a status with value NOT_STARTED. +Otherwise, a 409 response is returned.

+ +++ + + + + + + + + + + + + + + + + + + + +
Parameters:initiate_cluster_restore_request (com.vmware.nsx.model_client.InitiateClusterRestoreRequest) – (required)
Return type:com.vmware.nsx.model_client.ClusterRestoreStatus
Returns:com.vmware.nsx.model.ClusterRestoreStatus
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.ConcurrentChange +Conflict
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+suspend()
+

Suspend any currently running restore operation. The restore operation +is made up of a number of steps. When this call is issued, any +currently running step is allowed to finish (successfully or with +errors), and the next step (and therefore the entire restore operation) +is suspended until a subsequent resume or cancel call is issued. This +operation is only valid when a GET cluster/restore/status returns a +status with value RUNNING. Otherwise, a 409 response is returned.

+ +++ + + + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.ClusterRestoreStatus
Returns:com.vmware.nsx.model.ClusterRestoreStatus
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.ConcurrentChange +Conflict
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.cluster_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+GET_SOURCE_CACHED = 'cached'
+

Possible value for source of method Status.get().

+
+ +
+
+GET_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Status.get().

+
+ +
+
+get(source=None)
+

Returns status information for the NSX cluster control role and +management role.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:source (str or None) – Data source type. (optional)
Return type:com.vmware.nsx.model_client.ClusterStatus
Returns:com.vmware.nsx.model.ClusterStatus
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.cluster_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

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

com.vmware.nsx.compute_collection_transport_node_templates_client module

+
+
+class com.vmware.nsx.compute_collection_transport_node_templates_client.State(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+list(template_id, compute_collection_id=None, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Returns detailed transport node states for this compute collection

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • template_id (str) – (required)
    • +
  • compute_collection_id (str or None) – Compute collection id (optional)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.ComputeCollectionTransportNodeTemplateStateList

+
Returns:

com.vmware.nsx.model.ComputeCollectionTransportNodeTemplateStateList

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.compute_collection_transport_node_templates_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

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

com.vmware.nsx.configs_client module

+
+
+class com.vmware.nsx.configs_client.Inventory(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Return inventory configuration

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.InventoryConfig
Returns:com.vmware.nsx.model.InventoryConfig
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.configs_client.Management(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Returns the NSX Management nodes global configuration.

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.ManagementConfig
Returns:com.vmware.nsx.model.ManagementConfig
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+update(management_config)
+

Modifies the NSX Management nodes global configuration.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:management_config (com.vmware.nsx.model_client.ManagementConfig) – (required)
Return type:com.vmware.nsx.model_client.ManagementConfig
Returns:com.vmware.nsx.model.ManagementConfig
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.configs_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

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

com.vmware.nsx.dhcp_client module

+
+
+class com.vmware.nsx.dhcp_client.RelayProfiles(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(dhcp_relay_profile)
+

Creates a dhcp relay profile.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:dhcp_relay_profile (com.vmware.nsx.model_client.DhcpRelayProfile) – (required)
Return type:com.vmware.nsx.model_client.DhcpRelayProfile
Returns:com.vmware.nsx.model.DhcpRelayProfile
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(relay_profile_id)
+

Deletes the specified dhcp relay profile.

+ +++ + + + + + + + + + + + + + +
Parameters:relay_profile_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(relay_profile_id)
+

Returns information about the specified dhcp relay profile.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:relay_profile_id (str) – (required)
Return type:com.vmware.nsx.model_client.DhcpRelayProfile
Returns:com.vmware.nsx.model.DhcpRelayProfile
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Returns information about all dhcp relay profiles.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.DhcpRelayProfileListResult

+
Returns:

com.vmware.nsx.model.DhcpRelayProfileListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(relay_profile_id, dhcp_relay_profile)
+

Modifies the specified dhcp relay profile.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.DhcpRelayProfile

+
Returns:

com.vmware.nsx.model.DhcpRelayProfile

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.dhcp_client.Relays(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(dhcp_relay_service)
+

Creates a dhcp relay service.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:dhcp_relay_service (com.vmware.nsx.model_client.DhcpRelayService) – (required)
Return type:com.vmware.nsx.model_client.DhcpRelayService
Returns:com.vmware.nsx.model.DhcpRelayService
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(relay_id)
+

Deletes the specified dhcp relay service.

+ +++ + + + + + + + + + + + + + +
Parameters:relay_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(relay_id)
+

Returns the dhcp relay service information.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:relay_id (str) – (required)
Return type:com.vmware.nsx.model_client.DhcpRelayService
Returns:com.vmware.nsx.model.DhcpRelayService
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Returns information about all configured dhcp relay services.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.DhcpRelayServiceListResult

+
Returns:

com.vmware.nsx.model.DhcpRelayServiceListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(relay_id, dhcp_relay_service)
+

Modifies the specified dhcp relay service.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.DhcpRelayService

+
Returns:

com.vmware.nsx.model.DhcpRelayService

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.dhcp_client.ServerProfiles(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(dhcp_profile)
+

Create a DHCP server profile

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:dhcp_profile (com.vmware.nsx.model_client.DhcpProfile) – (required)
Return type:com.vmware.nsx.model_client.DhcpProfile
Returns:com.vmware.nsx.model.DhcpProfile
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(profile_id)
+

Delete a DHCP server profile

+ +++ + + + + + + + + + + + + + +
Parameters:profile_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(profile_id)
+

Get a DHCP server profile

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:profile_id (str) – (required)
Return type:com.vmware.nsx.model_client.DhcpProfile
Returns:com.vmware.nsx.model.DhcpProfile
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Get a paginated list of DHCP server profiles

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.DhcpProfileListResult

+
Returns:

com.vmware.nsx.model.DhcpProfileListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(profile_id, dhcp_profile)
+

If both the edge_cluster_member_indexes are changed in a same PUT API, +e.g. change from [a,b] to [x,y], the current dhcp server states will be +lost, which could cause the network crash due to ip conflicts. Hence +the suggestion is to change only one member index in one single update, +e.g. from [a, b] to [a,y].

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.DhcpProfile

+
Returns:

com.vmware.nsx.model.DhcpProfile

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.dhcp_client.Servers(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(logical_dhcp_server)
+

Create a DHCP server

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:logical_dhcp_server (com.vmware.nsx.model_client.LogicalDhcpServer) – (required)
Return type:com.vmware.nsx.model_client.LogicalDhcpServer
Returns:com.vmware.nsx.model.LogicalDhcpServer
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(server_id)
+

Delete a DHCP server

+ +++ + + + + + + + + + + + + + +
Parameters:server_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(server_id)
+

Get a DHCP server

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:server_id (str) – (required)
Return type:com.vmware.nsx.model_client.LogicalDhcpServer
Returns:com.vmware.nsx.model.LogicalDhcpServer
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Get a paginated list of DHCP servers

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.LogicalDhcpServerListResult

+
Returns:

com.vmware.nsx.model.LogicalDhcpServerListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(server_id, logical_dhcp_server)
+

Update a DHCP server

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.LogicalDhcpServer

+
Returns:

com.vmware.nsx.model.LogicalDhcpServer

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.dhcp_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

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

com.vmware.nsx.dns_client module

+
+
+class com.vmware.nsx.dns_client.Forwarders(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+clearcache(forwarder_id)
+

Clear the current cache of the dns forwarder.

+ +++ + + + + + + + + + + + + + +
Parameters:forwarder_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+create(dns_forwarder)
+

Create a dns forwader upon a logical router. There is only one dns +forwarder can be created upon a given logical router.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:dns_forwarder (com.vmware.nsx.model_client.DnsForwarder) – (required)
Return type:com.vmware.nsx.model_client.DnsForwarder
Returns:com.vmware.nsx.model.DnsForwarder
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(forwarder_id)
+

Delete a specific dns forwarder.

+ +++ + + + + + + + + + + + + + +
Parameters:forwarder_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(forwarder_id)
+

Retrieve a dns forwarder.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:forwarder_id (str) – (required)
Return type:com.vmware.nsx.model_client.DnsForwarder
Returns:com.vmware.nsx.model.DnsForwarder
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Get a paginated list of dns forwarders.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.DnsForwarderListResult

+
Returns:

com.vmware.nsx.model.DnsForwarderListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(forwarder_id, dns_forwarder)
+

Update a specific dns forwarder.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.DnsForwarder

+
Returns:

com.vmware.nsx.model.DnsForwarder

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.dns_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

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

com.vmware.nsx.eula_client module

+
+
+class com.vmware.nsx.eula_client.Accept(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create()
+

Accept end user license agreement

+ +++ + + + + + + + + + + + +
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.eula_client.Acceptance(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Return the acceptance status of end user license agreement

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.EULAAcceptance
Returns:com.vmware.nsx.model.EULAAcceptance
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.eula_client.Content(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(cursor=None, format=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Return the content of end user license agreement in the specified +format. By default, it’s pure string without line break

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • format (str or None) – End User License Agreement content output format (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.EULAContent

+
Returns:

com.vmware.nsx.model.EULAContent

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.eula_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

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

com.vmware.nsx.fabric_client module

+
+
+class com.vmware.nsx.fabric_client.ComputeCollectionFabricTemplates(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(compute_collection_fabric_template)
+

Fabric templates are fabric configurations applied at the compute +collection level. This configurations is used to decide what automated +operations should be a run when a host membership changes.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:compute_collection_fabric_template (com.vmware.nsx.model_client.ComputeCollectionFabricTemplate) – (required)
Return type:com.vmware.nsx.model_client.ComputeCollectionFabricTemplate
Returns:com.vmware.nsx.model.ComputeCollectionFabricTemplate
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(fabric_template_id)
+

Deletes compute collection fabric template for the given id

+ +++ + + + + + + + + + + + + + +
Parameters:fabric_template_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(fabric_template_id)
+

Get compute collection fabric template for the given id

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:fabric_template_id (str) – (required)
Return type:com.vmware.nsx.model_client.ComputeCollectionFabricTemplate
Returns:com.vmware.nsx.model.ComputeCollectionFabricTemplate
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(compute_collection_id=None)
+

Returns compute collection fabric templates

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:compute_collection_id (str or None) – Compute collection id (optional)
Return type:com.vmware.nsx.model_client.ComputeCollectionFabricTemplateListResult
Returns:com.vmware.nsx.model.ComputeCollectionFabricTemplateListResult
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+update(fabric_template_id, compute_collection_fabric_template)
+

Updates compute collection fabric template for the given id

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.ComputeCollectionFabricTemplate

+
Returns:

com.vmware.nsx.model.ComputeCollectionFabricTemplate

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.fabric_client.ComputeCollections(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+CREATE_ACTION_NSX = 'remove_nsx'
+

Possible value for action of method ComputeCollections.create().

+
+ +
+
+create(cc_ext_id, action=None)
+

Perform action specific to NSX on the compute-collection

+ +++ + + + + + + + + + + + + + +
Parameters:
    +
  • cc_ext_id (str) – (required)
    • +
  • action (str or None) – Supported actions on compute-collection (optional)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get(cc_ext_id)
+

Returns information about a specific compute collection.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:cc_ext_id (str) – (required)
Return type:com.vmware.nsx.model_client.ComputeCollection
Returns:com.vmware.nsx.model.ComputeCollection
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cm_local_id=None, cursor=None, discovered_node_id=None, display_name=None, external_id=None, included_fields=None, node_id=None, origin_id=None, origin_type=None, owner_id=None, page_size=None, sort_ascending=None, sort_by=None)
+

Returns information about all compute collections.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cm_local_id (str or None) – Local Id of the compute collection in the Compute Manager +(optional)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • discovered_node_id (str or None) – Id of the discovered node which belongs to this Compute Collection +(optional)
    • +
  • display_name (str or None) – Name of the ComputeCollection in source compute manager (optional)
    • +
  • external_id (str or None) – External ID of the ComputeCollection in the source Compute manager, +e.g. mo-ref in VC (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • node_id (str or None) – Id of the fabric node created from a discovered node belonging to +this Compute Collection (optional)
    • +
  • origin_id (str or None) – Id of the compute manager from where this Compute Collection was +discovered (optional)
    • +
  • origin_type (str or None) – ComputeCollection type like VC_Cluster. Here the Compute Manager +type prefix would help in differentiating similar named Compute +Collection types from different Compute Managers (optional)
    • +
  • owner_id (str or None) – Id of the owner of compute collection in the Compute Manager +(optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.ComputeCollectionListResult

+
Returns:

com.vmware.nsx.model.ComputeCollectionListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.fabric_client.ComputeManagers(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(compute_manager)
+

Registers compute manager with NSX. Inventory service will collect data +from the registered compute manager

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:compute_manager (com.vmware.nsx.model_client.ComputeManager) – (required)
Return type:com.vmware.nsx.model_client.ComputeManager
Returns:com.vmware.nsx.model.ComputeManager
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(compute_manager_id)
+

Unregisters a specified compute manager

+ +++ + + + + + + + + + + + + + +
Parameters:compute_manager_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(compute_manager_id)
+

Returns information about a specific compute manager

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:compute_manager_id (str) – (required)
Return type:com.vmware.nsx.model_client.ComputeManager
Returns:com.vmware.nsx.model.ComputeManager
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, origin_type=None, page_size=None, server=None, sort_ascending=None, sort_by=None)
+

Returns information about all compute managers.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • origin_type (str or None) – Compute manager type like vCenter (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • server (str or None) – IP address or hostname of compute manager (optional)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.ComputeManagerListResult

+
Returns:

com.vmware.nsx.model.ComputeManagerListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(compute_manager_id, compute_manager)
+

Updates a specified compute manager

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.ComputeManager

+
Returns:

com.vmware.nsx.model.ComputeManager

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.fabric_client.DiscoveredNodes(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+LIST_HAS_PARENT_FALSE = 'false'
+

Possible value for hasParent of method DiscoveredNodes.list().

+
+ +
+
+LIST_HAS_PARENT_TRUE = 'true'
+

Possible value for hasParent of method DiscoveredNodes.list().

+
+ +
+
+get(node_ext_id)
+

Returns information about a specific discovered node.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:node_ext_id (str) – (required)
Return type:com.vmware.nsx.model_client.DiscoveredNode
Returns:com.vmware.nsx.model.DiscoveredNode
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+hostprep(node_ext_id)
+

Prepares(hostprep) discovered node for NSX. NSX LCP bundles are +installed on this discovered node.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:node_ext_id (str) – (required)
Return type:vmware.vapi.struct.VapiStruct
Returns:com.vmware.nsx.model.Node +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.Node.
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cm_local_id=None, cursor=None, display_name=None, external_id=None, has_parent=None, included_fields=None, ip_address=None, node_id=None, node_type=None, origin_id=None, page_size=None, parent_compute_collection=None, sort_ascending=None, sort_by=None)
+

Returns information about all discovered nodes.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cm_local_id (str or None) – Local Id of the discovered node in the Compute Manager (optional)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • display_name (str or None) – Display name of discovered node (optional)
    • +
  • external_id (str or None) – External id of the discovered node, ex. a mo-ref from VC (optional)
    • +
  • has_parent (str or None) – Discovered node has a parent compute collection or is a standalone +host (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • ip_address (str or None) – IP address of the discovered node (optional)
    • +
  • node_id (str or None) – Id of the fabric node created from the discovered node (optional)
    • +
  • node_type (str or None) – Discovered Node type like HostNode (optional)
    • +
  • origin_id (str or None) – Id of the compute manager from where this node was discovered +(optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • parent_compute_collection (str or None) – External id of the compute collection to which this node belongs +(optional)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.DiscoveredNodeListResult

+
Returns:

com.vmware.nsx.model.DiscoveredNodeListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.fabric_client.Nodes(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+LIST_HYPERVISOR_OS_TYPE_CENTOSKVM = 'CENTOSKVM'
+

Possible value for hypervisorOsType of method Nodes.list().

+
+ +
+
+LIST_HYPERVISOR_OS_TYPE_CENTOSSERVER = 'CENTOSSERVER'
+

Possible value for hypervisorOsType of method Nodes.list().

+
+ +
+
+LIST_HYPERVISOR_OS_TYPE_ESXI = 'ESXI'
+

Possible value for hypervisorOsType of method Nodes.list().

+
+ +
+
+LIST_HYPERVISOR_OS_TYPE_HYPERV = 'HYPERV'
+

Possible value for hypervisorOsType of method Nodes.list().

+
+ +
+
+LIST_HYPERVISOR_OS_TYPE_RHELCONTAINER = 'RHELCONTAINER'
+

Possible value for hypervisorOsType of method Nodes.list().

+
+ +
+
+LIST_HYPERVISOR_OS_TYPE_RHELKVM = 'RHELKVM'
+

Possible value for hypervisorOsType of method Nodes.list().

+
+ +
+
+LIST_HYPERVISOR_OS_TYPE_RHELSERVER = 'RHELSERVER'
+

Possible value for hypervisorOsType of method Nodes.list().

+
+ +
+
+LIST_HYPERVISOR_OS_TYPE_UBUNTUKVM = 'UBUNTUKVM'
+

Possible value for hypervisorOsType of method Nodes.list().

+
+ +
+
+LIST_HYPERVISOR_OS_TYPE_UBUNTUSERVER = 'UBUNTUSERVER'
+

Possible value for hypervisorOsType of method Nodes.list().

+
+ +
+
+LIST_RESOURCE_TYPE_EDGENODE = 'EdgeNode'
+

Possible value for resourceType of method Nodes.list().

+
+ +
+
+LIST_RESOURCE_TYPE_HOSTNODE = 'HostNode'
+

Possible value for resourceType of method Nodes.list().

+
+ +
+
+LIST_RESOURCE_TYPE_PUBLICCLOUDGATEWAYNODE = 'PublicCloudGatewayNode'
+

Possible value for resourceType of method Nodes.list().

+
+ +
+
+PERFORMACTION_ACTION_ENTER_MAINTENANCE_MODE = 'enter_maintenance_mode'
+

Possible value for action of method Nodes.performaction().

+
+ +
+
+PERFORMACTION_ACTION_EXIT_MAINTENANCE_MODE = 'exit_maintenance_mode'
+

Possible value for action of method Nodes.performaction().

+
+ +
+
+create(node)
+

Creates a host node (hypervisor) or edge node (router) in the transport +network. When you run this command for a host, NSX Manager attempts to +install the NSX kernel modules, which are packaged as VIB, RPM, or DEB +files. For the installation to succeed, you must provide the host login +credentials and the host thumbprint. To get the ESXi host thumbprint, +SSH to the host and run the openssl x509 -in /etc/vmware/ssl/rui.crt +-fingerprint -sha256 -noout command. To generate host key thumbprint +using SHA-256 algorithm please follow the steps below. Log into the +host, making sure that the connection is not vulnerable to a man in the +middle attack. Check whether a public key already exists. Host public +key is generally located at ‘/etc/ssh/ssh_host_rsa_key.pub’. If the key +is not present then generate a new key by running the following command +and follow the instructions. ssh-keygen -t rsa Now generate a +SHA256 hash of the key using the following command. Please make sure to +pass the appropriate file name if the public key is stored with a +different file name other than the default ‘id_rsa.pub’. awk ‘{print +$2}’ id_rsa.pub | base64 -d | sha256sum -b | sed ‘s/ .\*$//’ | xxd +-r -p | base64

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:node (vmware.vapi.struct.VapiStruct) – (required) +The parameter must contain all the attributes defined in +com.vmware.nsx.model_client.Node.
Return type:vmware.vapi.struct.VapiStruct
Returns:com.vmware.nsx.model.Node +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.Node.
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+create_0(target_node_id, target_uri)
+

Invoke POST request on target fabric node

+ +++ + + + + + + + + + + + + + + + +
Parameters:
    +
  • target_node_id (str) – Target node UUID (required)
    • +
  • target_uri (str) – URI of API to invoke on target node (required)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.TimedOut +Gateway Timeout

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+delete(node_id, unprepare_host=None)
+

Removes a specified fabric node (host or edge). A fabric node may only +be deleted when it is no longer referenced by a Transport Node. If +unprepare_host option is set to false, the host will be deleted without +uninstalling the NSX components from the host.

+ +++ + + + + + + + + + + + + + +
Parameters:
    +
  • node_id (str) – (required)
    • +
  • unprepare_host (bool or None) – Delete a host and uninstall NSX components (optional, default to +true)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+delete_0(target_node_id, target_uri)
+

Invoke DELETE request on target fabric node

+ +++ + + + + + + + + + + + + + + + +
Parameters:
    +
  • target_node_id (str) – Target node UUID (required)
    • +
  • target_uri (str) – URI of API to invoke on target node (required)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.TimedOut +Gateway Timeout

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get(node_id)
+

Returns information about a specific fabric node (host or edge).

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:node_id (str) – (required)
Return type:vmware.vapi.struct.VapiStruct
Returns:com.vmware.nsx.model.Node +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.Node.
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get_0(target_node_id, target_uri)
+

Invoke GET request on target fabric node

+ +++ + + + + + + + + + + + + + + + +
Parameters:
    +
  • target_node_id (str) – Target node UUID (required)
    • +
  • target_uri (str) – URI of API to invoke on target node (required)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.TimedOut +Gateway Timeout

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+list(cursor=None, discovered_node_id=None, display_name=None, external_id=None, hardware_id=None, hypervisor_os_type=None, included_fields=None, ip_address=None, page_size=None, resource_type=None, sort_ascending=None, sort_by=None)
+

Returns information about all fabric nodes (hosts and edges).

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • discovered_node_id (str or None) – Id of the discovered node which was converted to create this node +(optional)
    • +
  • display_name (str or None) – HostNode display name (optional)
    • +
  • external_id (str or None) – HostNode external id (optional)
    • +
  • hardware_id (str or None) – Hardware Id of the host (optional)
    • +
  • hypervisor_os_type (str or None) – HostNode’s Hypervisor type, for example ESXi, RHEL KVM or UBUNTU +KVM. (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • ip_address (str or None) – Management IP address of the node (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • resource_type (str or None) – Node type from ‘HostNode’, ‘EdgeNode’, ‘PublicCloudGatewayNode’ +(optional)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.NodeListResult

+
Returns:

com.vmware.nsx.model.NodeListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+performaction(node_id, action=None)
+

The supported fabric node actions are enter_maintenance_mode, +exit_maintenance_mode for EdgeNode. This API is deprecated, please call +TransportNode maintenance mode API to update maintenance mode, refer to +"Update transport node maintenance mode".

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • node_id (str) – (required)
    • +
  • action (str or None) – Supported fabric node actions (optional)
    • +
+
Return type:

vmware.vapi.struct.VapiStruct

+
Returns:

com.vmware.nsx.model.Node +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.Node.

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+restartinventorysync(node_id)
+

Restart the inventory sync for the node if it is currently internally +paused. After this action the next inventory sync coming from the node +is processed.

+ +++ + + + + + + + + + + + + + +
Parameters:node_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+update(node_id, node)
+

Modifies attributes of a fabric node (host or edge).

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • node_id (str) – (required)
    • +
  • node (vmware.vapi.struct.VapiStruct) – (required) +The parameter must contain all the attributes defined in +com.vmware.nsx.model_client.Node.
    • +
+
Return type:

vmware.vapi.struct.VapiStruct

+
Returns:

com.vmware.nsx.model.Node +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.Node.

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update_0(target_node_id, target_uri)
+

Invoke PUT request on target fabric node

+ +++ + + + + + + + + + + + + + + + +
Parameters:
    +
  • target_node_id (str) – Target node UUID (required)
    • +
  • target_uri (str) – URI of API to invoke on target node (required)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.TimedOut +Gateway Timeout

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+upgradeinfra(node_id, disable_vm_migration=None)
+

Perform a service deployment upgrade on a host node

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • node_id (str) – (required)
    • +
  • disable_vm_migration (bool or None) – Should VM migration be disabled during upgrade (optional, default +to false)
    • +
+
Return type:

vmware.vapi.struct.VapiStruct

+
Returns:

com.vmware.nsx.model.Node +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.Node.

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.fabric_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+class com.vmware.nsx.fabric_client.Vifs(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+list(cursor=None, host_id=None, included_fields=None, lport_attachment_id=None, owner_vm_id=None, page_size=None, sort_ascending=None, sort_by=None, vm_id=None)
+

Returns information about all VIFs. A virtual network interface +aggregates network interfaces into a logical interface unit that is +indistinuishable from a physical network interface.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • host_id (str or None) – Id of the host where this vif is located. (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • lport_attachment_id (str or None) – LPort Attachment Id of the virtual network interface. (optional)
    • +
  • owner_vm_id (str or None) – External id of the virtual machine. (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
  • vm_id (str or None) – External id of the virtual machine. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.VirtualNetworkInterfaceListResult

+
Returns:

com.vmware.nsx.model.VirtualNetworkInterfaceListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.fabric_client.VirtualMachines(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+list(cursor=None, display_name=None, external_id=None, host_id=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Returns information about all virtual machines.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • display_name (str or None) – Display Name of the virtual machine (optional)
    • +
  • external_id (str or None) – External id of the virtual machine (optional)
    • +
  • host_id (str or None) – Id of the host where this vif is located (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.VirtualMachineListResult

+
Returns:

com.vmware.nsx.model.VirtualMachineListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+updatetags(virtual_machine_tag_update)
+

Update tags applied to the virtual machine. External id of the virtual +machine will be specified in the request body. Request body should +contain all the tags to be applied. To clear all tags, provide an empty +list. User can apply maximum 10 tags on a virtual machine. The +remaining 5 are reserved for system defined tags.

+ +++ + + + + + + + + + + + + + +
Parameters:virtual_machine_tag_update (com.vmware.nsx.model_client.VirtualMachineTagUpdate) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+

com.vmware.nsx.firewall_client module

+
+
+class com.vmware.nsx.firewall_client.Excludelist(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+addmember(resource_reference)
+

Add a new object in the exclude list

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:resource_reference (com.vmware.nsx.model_client.ResourceReference) – (required)
Return type:com.vmware.nsx.model_client.ResourceReference
Returns:com.vmware.nsx.model.ResourceReference
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+checkifexists(object_id)
+

Check if the object a member of the exclude list

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:object_id (str) – identifier of the object (required)
Return type:com.vmware.nsx.model_client.ResourceReference
Returns:com.vmware.nsx.model.ResourceReference
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get()
+

Get list of entities in exclude list

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.ExcludeList
Returns:com.vmware.nsx.model.ExcludeList
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+removemember(object_id)
+

Remove an existing object from the exclude list

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:object_id (str) – identifier of the object (required)
Return type:com.vmware.nsx.model_client.ResourceReference
Returns:com.vmware.nsx.model.ResourceReference
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+update(exclude_list)
+

Modify exclude list

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:exclude_list (com.vmware.nsx.model_client.ExcludeList) – (required)
Return type:com.vmware.nsx.model_client.ExcludeList
Returns:com.vmware.nsx.model.ExcludeList
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.firewall_client.Rules(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(rule_id)
+

Return existing firewall rule information.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:rule_id (str) – (required)
Return type:com.vmware.nsx.model_client.FirewallRule
Returns:com.vmware.nsx.model.FirewallRule
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.firewall_client.Sections(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+CREATEWITHRULES_OPERATION_AFTER = 'insert_after'
+

Possible value for operation of method Sections.createwithrules().

+
+ +
+
+CREATEWITHRULES_OPERATION_BEFORE = 'insert_before'
+

Possible value for operation of method Sections.createwithrules().

+
+ +
+
+CREATEWITHRULES_OPERATION_BOTTOM = 'insert_bottom'
+

Possible value for operation of method Sections.createwithrules().

+
+ +
+
+CREATEWITHRULES_OPERATION_TOP = 'insert_top'
+

Possible value for operation of method Sections.createwithrules().

+
+ +
+
+CREATE_OPERATION_AFTER = 'insert_after'
+

Possible value for operation of method Sections.create().

+
+ +
+
+CREATE_OPERATION_BEFORE = 'insert_before'
+

Possible value for operation of method Sections.create().

+
+ +
+
+CREATE_OPERATION_BOTTOM = 'insert_bottom'
+

Possible value for operation of method Sections.create().

+
+ +
+
+CREATE_OPERATION_TOP = 'insert_top'
+

Possible value for operation of method Sections.create().

+
+ +
+
+LIST_ENFORCED_ON_BRIDGEENDPOINT = 'BRIDGEENDPOINT'
+

Possible value for enforcedOn of method Sections.list().

+
+ +
+
+LIST_ENFORCED_ON_DHCP_SERVICE = 'DHCP_SERVICE'
+

Possible value for enforcedOn of method Sections.list().

+
+ +
+
+LIST_ENFORCED_ON_L2VPN_SESSION = 'L2VPN_SESSION'
+

Possible value for enforcedOn of method Sections.list().

+
+ +
+
+LIST_ENFORCED_ON_LOGICALROUTER = 'LOGICALROUTER'
+

Possible value for enforcedOn of method Sections.list().

+
+ +
+
+LIST_ENFORCED_ON_METADATA_PROXY = 'METADATA_PROXY'
+

Possible value for enforcedOn of method Sections.list().

+
+ +
+
+LIST_ENFORCED_ON_NONE = 'NONE'
+

Possible value for enforcedOn of method Sections.list().

+
+ +
+
+LIST_ENFORCED_ON_VIF = 'VIF'
+

Possible value for enforcedOn of method Sections.list().

+
+ +
+
+LIST_EXCLUDE_APPLIED_TO_TYPE_LOGICALPORT = 'LogicalPort'
+

Possible value for excludeAppliedToType of method Sections.list().

+
+ +
+
+LIST_EXCLUDE_APPLIED_TO_TYPE_LOGICALROUTER = 'LogicalRouter'
+

Possible value for excludeAppliedToType of method Sections.list().

+
+ +
+
+LIST_EXCLUDE_APPLIED_TO_TYPE_LOGICALSWITCH = 'LogicalSwitch'
+

Possible value for excludeAppliedToType of method Sections.list().

+
+ +
+
+LIST_EXCLUDE_APPLIED_TO_TYPE_NSGROUP = 'NSGroup'
+

Possible value for excludeAppliedToType of method Sections.list().

+
+ +
+
+LIST_FILTER_TYPE_FILTER = 'FILTER'
+

Possible value for filterType of method Sections.list().

+
+ +
+ +

Possible value for filterType of method Sections.list().

+
+ +
+
+LIST_INCLUDE_APPLIED_TO_TYPE_LOGICALPORT = 'LogicalPort'
+

Possible value for includeAppliedToType of method Sections.list().

+
+ +
+
+LIST_INCLUDE_APPLIED_TO_TYPE_LOGICALROUTER = 'LogicalRouter'
+

Possible value for includeAppliedToType of method Sections.list().

+
+ +
+
+LIST_INCLUDE_APPLIED_TO_TYPE_LOGICALSWITCH = 'LogicalSwitch'
+

Possible value for includeAppliedToType of method Sections.list().

+
+ +
+
+LIST_INCLUDE_APPLIED_TO_TYPE_NSGROUP = 'NSGroup'
+

Possible value for includeAppliedToType of method Sections.list().

+
+ +
+
+LIST_TYPE_LAYER2 = 'LAYER2'
+

Possible value for type of method Sections.list().

+
+ +
+
+LIST_TYPE_LAYER3 = 'LAYER3'
+

Possible value for type of method Sections.list().

+
+ +
+
+REVISEWITHRULES_OPERATION_AFTER = 'insert_after'
+

Possible value for operation of method Sections.revisewithrules().

+
+ +
+
+REVISEWITHRULES_OPERATION_BEFORE = 'insert_before'
+

Possible value for operation of method Sections.revisewithrules().

+
+ +
+
+REVISEWITHRULES_OPERATION_BOTTOM = 'insert_bottom'
+

Possible value for operation of method Sections.revisewithrules().

+
+ +
+
+REVISEWITHRULES_OPERATION_TOP = 'insert_top'
+

Possible value for operation of method Sections.revisewithrules().

+
+ +
+
+REVISE_OPERATION_AFTER = 'insert_after'
+

Possible value for operation of method Sections.revise().

+
+ +
+
+REVISE_OPERATION_BEFORE = 'insert_before'
+

Possible value for operation of method Sections.revise().

+
+ +
+
+REVISE_OPERATION_BOTTOM = 'insert_bottom'
+

Possible value for operation of method Sections.revise().

+
+ +
+
+REVISE_OPERATION_TOP = 'insert_top'
+

Possible value for operation of method Sections.revise().

+
+ +
+
+create(firewall_section, id=None, operation=None)
+

Creates new empty firewall section in the system.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • firewall_section (com.vmware.nsx.model_client.FirewallSection) – (required)
    • +
  • id (str or None) – Identifier of the anchor rule or section. This is a required field +in case operation like ‘insert_before’ and ‘insert_after’. +(optional)
    • +
  • operation (str or None) – Operation (optional, default to insert_top)
    • +
+
Return type:

com.vmware.nsx.model_client.FirewallSection

+
Returns:

com.vmware.nsx.model.FirewallSection

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+createwithrules(firewall_section_rule_list, id=None, operation=None)
+

Creates a new firewall section with rules. The limit on the number of +rules is defined by maxItems in collection types for FirewallRule +(FirewallRuleXXXList types). When invoked on a section with a large +number of rules, this API is supported only at low rates of invocation +(not more than 4-5 times per minute). The typical latency of this API +with about 1024 rules is about 4-5 seconds. This API should not be +invoked with large payloads at automation speeds. More than 50 rules +with a large number of rule references is not supported. Instead, to +create sections, use: POST /api/v1/firewall/sections To create rules, +use: POST /api/v1/firewall/sections/<section-id>/rules

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • firewall_section_rule_list (com.vmware.nsx.model_client.FirewallSectionRuleList) – (required)
    • +
  • id (str or None) – Identifier of the anchor rule or section. This is a required field +in case operation like ‘insert_before’ and ‘insert_after’. +(optional)
    • +
  • operation (str or None) – Operation (optional, default to insert_top)
    • +
+
Return type:

com.vmware.nsx.model_client.FirewallSectionRuleList

+
Returns:

com.vmware.nsx.model.FirewallSectionRuleList

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+delete(section_id, cascade=None)
+

Removes firewall section from the system. Firewall section with rules +can only be deleted by passing "cascade=true" parameter.

+ +++ + + + + + + + + + + + + + +
Parameters:
    +
  • section_id (str) – (required)
    • +
  • cascade (bool or None) – Flag to cascade delete of this object to all it’s child objects. +(optional, default to false)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get(section_id)
+

Returns information about firewall section for the identifier.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:section_id (str) – (required)
Return type:com.vmware.nsx.model_client.FirewallSection
Returns:com.vmware.nsx.model.FirewallSection
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(applied_tos=None, cursor=None, destinations=None, enforced_on=None, exclude_applied_to_type=None, filter_type=None, include_applied_to_type=None, included_fields=None, locked=None, page_size=None, search_invalid_references=None, search_scope=None, services=None, sort_ascending=None, sort_by=None, sources=None, type=None)
+

List all firewall section in paginated form. A default page size is +limited to 1000 firewall sections. By default list of section is +filtered by LAYER3 type.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • applied_tos (str or None) – AppliedTo’s referenced by this section or section’s Distributed +Service Rules . (optional)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • destinations (str or None) – Destinations referenced by this section’s Distributed Service Rules +. (optional)
    • +
  • enforced_on (str or None) – Type of attachment for logical port; for query only. (optional)
    • +
  • exclude_applied_to_type (str or None) – Resource type valid for use as AppliedTo filter in section API +(optional)
    • +
  • filter_type (str or None) – Filter type (optional, default to FILTER)
    • +
  • include_applied_to_type (str or None) – Resource type valid for use as AppliedTo filter in section API +(optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • locked (bool or None) – Limit results to sections which are locked/unlocked (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • search_invalid_references (bool or None) – Return invalid references in results. (optional, default to false)
    • +
  • search_scope (str or None) – Limit result to sections of a specific enforcement point (optional)
    • +
  • services (str or None) – NSService referenced by this section’s Distributed Service Rules . +(optional)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
  • sources (str or None) – Sources referenced by this section’s Distributed Service Rules . +(optional)
    • +
  • type (str or None) – Section Type (optional, default to LAYER3)
    • +
+
Return type:

com.vmware.nsx.model_client.FirewallSectionListResult

+
Returns:

com.vmware.nsx.model.FirewallSectionListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+listwithrules(section_id)
+

Returns firewall section information with rules for a section +identifier. When invoked on a section with a large number of rules, +this API is supported only at low rates of invocation (not more than +4-5 times per minute). The typical latency of this API with about 1024 +rules is about 4-5 seconds. This API should not be invoked with large +payloads at automation speeds. More than 50 rules with a large number +rule references is not supported. Instead, to read firewall rules, use: +GET /api/v1/firewall/sections/<section-id>/rules with the appropriate +page_size.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:section_id (str) – (required)
Return type:com.vmware.nsx.model_client.FirewallSectionRuleList
Returns:com.vmware.nsx.model.FirewallSectionRuleList
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+lock(section_id, firewall_section_lock)
+

Lock a section

+ +++ + + + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.FirewallSection

+
Returns:

com.vmware.nsx.model.FirewallSection

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
Raise:

com.vmware.vapi.std.errors_client.ResourceBusy +Locked

+
+
+ +
+
+revise(section_id, firewall_section, id=None, operation=None)
+

Modifies an existing firewall section along with its relative position +among other firewall sections in the system. Simultaneous update +(modify) operations on same section are not allowed to prevent +overwriting stale contents to firewall section. If a concurrent update +is performed, HTTP response code 409 will be returned to the client +operating on stale data. That client should retrieve the firewall +section again and re-apply its update.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • section_id (str) – (required)
    • +
  • firewall_section (com.vmware.nsx.model_client.FirewallSection) – (required)
    • +
  • id (str or None) – Identifier of the anchor rule or section. This is a required field +in case operation like ‘insert_before’ and ‘insert_after’. +(optional)
    • +
  • operation (str or None) – Operation (optional, default to insert_top)
    • +
+
Return type:

com.vmware.nsx.model_client.FirewallSection

+
Returns:

com.vmware.nsx.model.FirewallSection

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+revisewithrules(section_id, firewall_section_rule_list, id=None, operation=None)
+

Modifies an existing firewall section along with its relative position +among other firewall sections with rules. When invoked on a large +number of rules, this API is supported only at low rates of invocation +(not more than 2 times per minute). The typical latency of this API +with about 1024 rules is about 15 seconds in a cluster setup. This API +should not be invoked with large payloads at automation speeds. +Instead, to move a section above or below another section, use: POST +/api/v1/firewall/sections/<section-id>?action=revise To modify rules, +use: PUT /api/v1/firewall/sections/<section-id>/rules/<rule-id> +Simultaneous update (modify) operations on same section are not allowed +to prevent overwriting stale contents to firewall section. If a +concurrent update is performed, HTTP response code 409 will be returned +to the client operating on stale data. That client should retrieve the +firewall section again and re-apply its update.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • section_id (str) – (required)
    • +
  • firewall_section_rule_list (com.vmware.nsx.model_client.FirewallSectionRuleList) – (required)
    • +
  • id (str or None) – Identifier of the anchor rule or section. This is a required field +in case operation like ‘insert_before’ and ‘insert_after’. +(optional)
    • +
  • operation (str or None) – Operation (optional, default to insert_top)
    • +
+
Return type:

com.vmware.nsx.model_client.FirewallSectionRuleList

+
Returns:

com.vmware.nsx.model.FirewallSectionRuleList

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+unlock(section_id, firewall_section_lock)
+

Unlock a section

+ +++ + + + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.FirewallSection

+
Returns:

com.vmware.nsx.model.FirewallSection

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
Raise:

com.vmware.vapi.std.errors_client.ResourceBusy +Locked

+
+
+ +
+
+update(section_id, firewall_section)
+

Modifies the specified section, but does not modify the section’s +associated rules. Simultaneous update (modify) operations on same +section are not allowed to prevent overwriting stale contents to +firewall section. If a concurrent update is performed, HTTP response +code 409 will be returned to the client operating on stale data. That +client should retrieve the firewall section again and re-apply its +update.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.FirewallSection

+
Returns:

com.vmware.nsx.model.FirewallSection

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+updatewithrules(section_id, firewall_section_rule_list)
+

Modifies existing firewall section along with its association with +rules. When invoked on a large number of rules, this API is supported +only at low rates of invocation (not more than 2 times per minute). The +typical latency of this API with about 1024 rules is about 15 seconds +in a cluster setup. This API should not be invoked with large payloads +at automation speeds. Instead, to update rule content, use: PUT +/api/v1/firewall/sections/<section-id>/rules/<rule-id> Simultaneous +update (modify) operations on same section are not allowed to prevent +overwriting stale contents to firewall section. If a concurrent update +is performed, HTTP response code 409 will be returned to the client +operating on stale data. That client should retrieve the firewall +section again and re-apply its update.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.FirewallSectionRuleList

+
Returns:

com.vmware.nsx.model.FirewallSectionRuleList

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.firewall_client.Stats(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+RESET_CATEGORY_L3BRIDGEPORT = 'L3BRIDGEPORT'
+

Possible value for category of method Stats.reset().

+
+ +
+
+RESET_CATEGORY_L3DFW = 'L3DFW'
+

Possible value for category of method Stats.reset().

+
+ +
+
+RESET_CATEGORY_L3EDGE = 'L3EDGE'
+

Possible value for category of method Stats.reset().

+
+ +
+
+reset(category)
+

Sets firewall rule statistics counter to zero. This operation is +supported for given category, for example: L3DFW i.e. for all layer3 +firewall (transport nodes only) rules or L3EDGE i.e. for all layer3 +edge firewall (edge nodes only) rules or L3BRIDGEPORT i.e. for all +layer3 bridge port firewall (bridge ports only) rules.

+ +++ + + + + + + + + + + + + + +
Parameters:category (str) – Aggregation Statistic Category (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.firewall_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+disablefirewall(context_type, id)
+

Disable firewall on target resource in dfw context

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • context_type (str) – (required)
    • +
  • id (str) – (required)
    • +
+
Return type:

com.vmware.nsx.model_client.TargetResourceStatus

+
Returns:

com.vmware.nsx.model.TargetResourceStatus

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+enablefirewall(context_type, id)
+

Enable firewall on target resource in dfw context

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • context_type (str) – (required)
    • +
  • id (str) – (required)
    • +
+
Return type:

com.vmware.nsx.model_client.TargetResourceStatus

+
Returns:

com.vmware.nsx.model.TargetResourceStatus

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get(context_type)
+

Get firewall global status for dfw context

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:context_type (str) – (required)
Return type:com.vmware.nsx.model_client.FirewallStatus
Returns:com.vmware.nsx.model.FirewallStatus
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get_0(context_type, id)
+

Get firewall status for target resource in dfw context

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • context_type (str) – (required)
    • +
  • id (str) – (required)
    • +
+
Return type:

com.vmware.nsx.model_client.TargetResourceStatus

+
Returns:

com.vmware.nsx.model.TargetResourceStatus

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+list()
+

List all firewall status for supported contexts

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.FirewallStatusListResult
Returns:com.vmware.nsx.model.FirewallStatusListResult
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+update(context_type, firewall_status)
+

Update global firewall status for dfw context

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.FirewallStatus

+
Returns:

com.vmware.nsx.model.FirewallStatus

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.firewall_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

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

com.vmware.nsx.hpm_client module

+
+
+class com.vmware.nsx.hpm_client.Alarms(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+list(cursor=None, fields=None, page_size=None)
+

This API is executed on a manager node to return current alarms from +all NSX nodes.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (long or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • fields (str or None) – Fields to include in query results (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 100)
    • +
+
Return type:

com.vmware.nsx.model_client.AlarmListResult

+
Returns:

com.vmware.nsx.model.AlarmListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.hpm_client.Features(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+RESETCOLLECTIONFREQUENCY_ACTION_FREQUENCY = 'reset_collection_frequency'
+

Possible value for action of method +Features.resetcollectionfrequency().

+
+ +
+
+get(feature_stack_name)
+

Returns the complete set of client type data collection configuration +records for the specified feature stack.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:feature_stack_name (str) – (required)
Return type:com.vmware.nsx.model_client.FeatureStackCollectionConfiguration
Returns:com.vmware.nsx.model.FeatureStackCollectionConfiguration
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list()
+

List all health performance monitoring feature stacks

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.FeatureStackCollectionConfigurationList
Returns:com.vmware.nsx.model.FeatureStackCollectionConfigurationList
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+resetcollectionfrequency(feature_stack_name, action)
+

Reset the data collection frequency configuration setting to the +default values

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • feature_stack_name (str) – (required)
    • +
  • action (str) – (required)
    • +
+
Return type:

com.vmware.nsx.model_client.FeatureStackCollectionConfiguration

+
Returns:

com.vmware.nsx.model.FeatureStackCollectionConfiguration

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(feature_stack_name, feature_stack_collection_configuration)
+

Apply the data collection configuration for the specified feature +stack.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.FeatureStackCollectionConfiguration

+
Returns:

com.vmware.nsx.model.FeatureStackCollectionConfiguration

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.hpm_client.GlobalConfig(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Read global health performance monitoring configuration

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.GlobalCollectionConfiguration
Returns:com.vmware.nsx.model.GlobalCollectionConfiguration
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+update(global_collection_configuration)
+

Set the global configuration for aggregation service related data +collection

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:global_collection_configuration (com.vmware.nsx.model_client.GlobalCollectionConfiguration) – (required)
Return type:com.vmware.nsx.model_client.GlobalCollectionConfiguration
Returns:com.vmware.nsx.model.GlobalCollectionConfiguration
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.hpm_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

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

com.vmware.nsx.ipfix_client module

+
+
+class com.vmware.nsx.ipfix_client.Collectorconfigs(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(ipfix_collector_config)
+

Create a new IPFIX collector configuration

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:ipfix_collector_config (com.vmware.nsx.model_client.IpfixCollectorConfig) – (required)
Return type:com.vmware.nsx.model_client.IpfixCollectorConfig
Returns:com.vmware.nsx.model.IpfixCollectorConfig
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(collector_config_id)
+

Delete an existing IPFIX collector configuration

+ +++ + + + + + + + + + + + + + +
Parameters:collector_config_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(collector_config_id)
+

Get an existing IPFIX collector configuration

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:collector_config_id (str) – (required)
Return type:com.vmware.nsx.model_client.IpfixCollectorConfig
Returns:com.vmware.nsx.model.IpfixCollectorConfig
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

List IPFIX collector configurations

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.IpfixCollectorConfigListResult

+
Returns:

com.vmware.nsx.model.IpfixCollectorConfigListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(collector_config_id, ipfix_collector_config)
+

Update an existing IPFIX collector configuration

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.IpfixCollectorConfig

+
Returns:

com.vmware.nsx.model.IpfixCollectorConfig

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.ipfix_client.Configs(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+LIST_IPFIX_CONFIG_TYPE_IPFIXDFWCONFIG = 'IpfixDfwConfig'
+

Possible value for ipfixConfigType of method Configs.list().

+
+ +
+
+LIST_IPFIX_CONFIG_TYPE_IPFIXSWITCHCONFIG = 'IpfixSwitchConfig'
+

Possible value for ipfixConfigType of method Configs.list().

+
+ +
+
+create(ipfix_config)
+

Create a new IPFIX configuration

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:ipfix_config (vmware.vapi.struct.VapiStruct) – (required) +The parameter must contain all the attributes defined in +com.vmware.nsx.model_client.IpfixConfig.
Return type:vmware.vapi.struct.VapiStruct
Returns:com.vmware.nsx.model.IpfixConfig +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.IpfixConfig.
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(config_id)
+

Delete an existing IPFIX configuration

+ +++ + + + + + + + + + + + + + +
Parameters:config_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(config_id)
+

Get an existing IPFIX configuration

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:config_id (str) – (required)
Return type:vmware.vapi.struct.VapiStruct
Returns:com.vmware.nsx.model.IpfixConfig +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.IpfixConfig.
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(applied_to=None, cursor=None, included_fields=None, ipfix_config_type=None, page_size=None, sort_ascending=None, sort_by=None)
+

List IPFIX configuration

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • applied_to (str or None) – Applied To (optional)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • ipfix_config_type (str or None) – Supported IPFIX Config Types. (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.IpfixConfigListResult

+
Returns:

com.vmware.nsx.model.IpfixConfigListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(config_id, ipfix_config)
+

Update an existing IPFIX configuration

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • config_id (str) – (required)
    • +
  • ipfix_config (vmware.vapi.struct.VapiStruct) – (required) +The parameter must contain all the attributes defined in +com.vmware.nsx.model_client.IpfixConfig.
    • +
+
Return type:

vmware.vapi.struct.VapiStruct

+
Returns:

com.vmware.nsx.model.IpfixConfig +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.IpfixConfig.

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.ipfix_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

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

com.vmware.nsx.ipfix_obs_points_client module

+
+
+class com.vmware.nsx.ipfix_obs_points_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+class com.vmware.nsx.ipfix_obs_points_client.SwitchGlobal(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+
+++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.IpfixObsPointConfig
Returns:com.vmware.nsx.model.IpfixObsPointConfig
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+update(ipfix_obs_point_config)
+
+++ + + + + + + + + + + + + + + + + + +
Parameters:ipfix_obs_point_config (com.vmware.nsx.model_client.IpfixObsPointConfig) – (required)
Return type:com.vmware.nsx.model_client.IpfixObsPointConfig
Returns:com.vmware.nsx.model.IpfixObsPointConfig
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+

com.vmware.nsx.licenses_client module

+
+
+class com.vmware.nsx.licenses_client.LicensesUsage(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Returns usage report of all registered modules

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.FeatureUsageList
Returns:com.vmware.nsx.model.FeatureUsageList
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.licenses_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

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

com.vmware.nsx.loadbalancer_client module

+
+
+class com.vmware.nsx.loadbalancer_client.ApplicationProfiles(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+LIST_TYPE_LBFASTTCPPROFILE = 'LbFastTcpProfile'
+

Possible value for type of method ApplicationProfiles.list().

+
+ +
+
+LIST_TYPE_LBFASTUDPPROFILE = 'LbFastUdpProfile'
+

Possible value for type of method ApplicationProfiles.list().

+
+ +
+
+LIST_TYPE_LBHTTPPROFILE = 'LbHttpProfile'
+

Possible value for type of method ApplicationProfiles.list().

+
+ +
+
+create(lb_app_profile)
+

Create a load balancer application profile.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:lb_app_profile (vmware.vapi.struct.VapiStruct) – (required) +The parameter must contain all the attributes defined in +com.vmware.nsx.model_client.LbAppProfile.
Return type:vmware.vapi.struct.VapiStruct
Returns:com.vmware.nsx.model.LbAppProfile +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.LbAppProfile.
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(application_profile_id)
+

Delete a load balancer application profile.

+ +++ + + + + + + + + + + + + + +
Parameters:application_profile_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(application_profile_id)
+

Retrieve a load balancer application profile.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:application_profile_id (str) – (required)
Return type:vmware.vapi.struct.VapiStruct
Returns:com.vmware.nsx.model.LbAppProfile +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.LbAppProfile.
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, type=None)
+

Retrieve a paginated list of load balancer application profiles.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
  • type (str or None) – application profile type (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.LbAppProfileListResult

+
Returns:

com.vmware.nsx.model.LbAppProfileListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(application_profile_id, lb_app_profile)
+

Update a load balancer application profile.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • application_profile_id (str) – (required)
    • +
  • lb_app_profile (vmware.vapi.struct.VapiStruct) – (required) +The parameter must contain all the attributes defined in +com.vmware.nsx.model_client.LbAppProfile.
    • +
+
Return type:

vmware.vapi.struct.VapiStruct

+
Returns:

com.vmware.nsx.model.LbAppProfile +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.LbAppProfile.

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.loadbalancer_client.ClientSslProfiles(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(lb_client_ssl_profile)
+

Create a load balancer client-ssl profile.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:lb_client_ssl_profile (com.vmware.nsx.model_client.LbClientSslProfile) – (required)
Return type:com.vmware.nsx.model_client.LbClientSslProfile
Returns:com.vmware.nsx.model.LbClientSslProfile
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(client_ssl_profile_id)
+

Delete a load balancer client-ssl profile.

+ +++ + + + + + + + + + + + + + +
Parameters:client_ssl_profile_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(client_ssl_profile_id)
+

Retrieve a load balancer client-ssl profile.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:client_ssl_profile_id (str) – (required)
Return type:com.vmware.nsx.model_client.LbClientSslProfile
Returns:com.vmware.nsx.model.LbClientSslProfile
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Retrieve a paginated list of load balancer client-ssl profiles.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.LbClientSslProfileListResult

+
Returns:

com.vmware.nsx.model.LbClientSslProfileListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(client_ssl_profile_id, lb_client_ssl_profile)
+

Update a load balancer client-ssl profile.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.LbClientSslProfile

+
Returns:

com.vmware.nsx.model.LbClientSslProfile

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.loadbalancer_client.Monitors(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+LIST_TYPE_LBACTIVEMONITOR = 'LbActiveMonitor'
+

Possible value for type of method Monitors.list().

+
+ +
+
+LIST_TYPE_LBHTTPMONITOR = 'LbHttpMonitor'
+

Possible value for type of method Monitors.list().

+
+ +
+
+LIST_TYPE_LBHTTPSMONITOR = 'LbHttpsMonitor'
+

Possible value for type of method Monitors.list().

+
+ +
+
+LIST_TYPE_LBICMPMONITOR = 'LbIcmpMonitor'
+

Possible value for type of method Monitors.list().

+
+ +
+
+LIST_TYPE_LBPASSIVEMONITOR = 'LbPassiveMonitor'
+

Possible value for type of method Monitors.list().

+
+ +
+
+LIST_TYPE_LBTCPMONITOR = 'LbTcpMonitor'
+

Possible value for type of method Monitors.list().

+
+ +
+
+LIST_TYPE_LBUDPMONITOR = 'LbUdpMonitor'
+

Possible value for type of method Monitors.list().

+
+ +
+
+create(lb_monitor)
+

Create a load balancer monitor.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:lb_monitor (vmware.vapi.struct.VapiStruct) – (required) +The parameter must contain all the attributes defined in +com.vmware.nsx.model_client.LbMonitor.
Return type:vmware.vapi.struct.VapiStruct
Returns:com.vmware.nsx.model.LbMonitor +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.LbMonitor.
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(monitor_id)
+

Delete a load balancer monitor.

+ +++ + + + + + + + + + + + + + +
Parameters:monitor_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(monitor_id)
+

Retrieve a load balancer monitor.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:monitor_id (str) – (required)
Return type:vmware.vapi.struct.VapiStruct
Returns:com.vmware.nsx.model.LbMonitor +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.LbMonitor.
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, type=None)
+

Retrieve a paginated list of load balancer monitors.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
  • type (str or None) – monitor query type (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.LbMonitorListResult

+
Returns:

com.vmware.nsx.model.LbMonitorListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(monitor_id, lb_monitor)
+

Update a load balancer monitor.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • monitor_id (str) – (required)
    • +
  • lb_monitor (vmware.vapi.struct.VapiStruct) – (required) +The parameter must contain all the attributes defined in +com.vmware.nsx.model_client.LbMonitor.
    • +
+
Return type:

vmware.vapi.struct.VapiStruct

+
Returns:

com.vmware.nsx.model.LbMonitor +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.LbMonitor.

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.loadbalancer_client.PersistenceProfiles(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+LIST_TYPE_LBCOOKIEPERSISTENCEPROFILE = 'LbCookiePersistenceProfile'
+

Possible value for type of method PersistenceProfiles.list().

+
+ +
+
+LIST_TYPE_LBSOURCEIPPERSISTENCEPROFILE = 'LbSourceIpPersistenceProfile'
+

Possible value for type of method PersistenceProfiles.list().

+
+ +
+
+create(lb_persistence_profile)
+

Create a load balancer persistence profile.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:lb_persistence_profile (vmware.vapi.struct.VapiStruct) – (required) +The parameter must contain all the attributes defined in +com.vmware.nsx.model_client.LbPersistenceProfile.
Return type:vmware.vapi.struct.VapiStruct
Returns:com.vmware.nsx.model.LbPersistenceProfile +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.LbPersistenceProfile.
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(persistence_profile_id)
+

Delete a load balancer persistence profile.

+ +++ + + + + + + + + + + + + + +
Parameters:persistence_profile_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(persistence_profile_id)
+

Retrieve a load balancer persistence profile.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:persistence_profile_id (str) – (required)
Return type:vmware.vapi.struct.VapiStruct
Returns:com.vmware.nsx.model.LbPersistenceProfile +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.LbPersistenceProfile.
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, type=None)
+

Retrieve a paginated list of load balancer persistence profiles.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
  • type (str or None) – persistence profile type (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.LbPersistenceProfileListResult

+
Returns:

com.vmware.nsx.model.LbPersistenceProfileListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(persistence_profile_id, lb_persistence_profile)
+

Update a load balancer persistence profile.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

vmware.vapi.struct.VapiStruct

+
Returns:

com.vmware.nsx.model.LbPersistenceProfile +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.LbPersistenceProfile.

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.loadbalancer_client.Pools(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+CREATE_0_ACTION_ADD_MEMBERS = 'ADD_MEMBERS'
+

Possible value for action of method Pools.create_0().

+
+ +
+
+CREATE_0_ACTION_REMOVE_MEMBERS = 'REMOVE_MEMBERS'
+

Possible value for action of method Pools.create_0().

+
+ +
+
+CREATE_0_ACTION_UPDATE_MEMBERS = 'UPDATE_MEMBERS'
+

Possible value for action of method Pools.create_0().

+
+ +
+
+create(lb_pool)
+

Create a load balancer pool.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:lb_pool (com.vmware.nsx.model_client.LbPool) – (required)
Return type:com.vmware.nsx.model_client.LbPool
Returns:com.vmware.nsx.model.LbPool
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+create_0(pool_id, pool_member_setting_list, action)
+

For ADD_MEMBERS, pool members will be created and added to load +balancer pool. This action is only valid for static pool members. For +REMOVE_MEMBERS, pool members will be removed from load balancer pool +via IP and port in pool member settings. This action is only valid for +static pool members. For UPDATE_MEMBERS, pool members admin state will +be updated. This action is valid for both static pool members and +dynamic pool members. For dynamic pool members, this update will be +stored in customized_members field in load balancer pool member group.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.LbPool

+
Returns:

com.vmware.nsx.model.LbPool

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+delete(pool_id)
+

Delete a load balancer pool.

+ +++ + + + + + + + + + + + + + +
Parameters:pool_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(pool_id)
+

Retrieve a load balancer pool.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:pool_id (str) – (required)
Return type:com.vmware.nsx.model_client.LbPool
Returns:com.vmware.nsx.model.LbPool
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Retrieve a paginated list of load balancer pools.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.LbPoolListResult

+
Returns:

com.vmware.nsx.model.LbPoolListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(pool_id, lb_pool)
+

Update a load balancer pool.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.LbPool

+
Returns:

com.vmware.nsx.model.LbPool

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.loadbalancer_client.Rules(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(lb_rule)
+

Create a load balancer rule.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:lb_rule (com.vmware.nsx.model_client.LbRule) – (required)
Return type:com.vmware.nsx.model_client.LbRule
Returns:com.vmware.nsx.model.LbRule
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(rule_id)
+

Delete a load balancer rule.

+ +++ + + + + + + + + + + + + + +
Parameters:rule_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(rule_id)
+

Retrieve a load balancer rule.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:rule_id (str) – (required)
Return type:com.vmware.nsx.model_client.LbRule
Returns:com.vmware.nsx.model.LbRule
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Retrieve a paginated list of load balancer rules.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.LbRuleListResult

+
Returns:

com.vmware.nsx.model.LbRuleListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(rule_id, lb_rule)
+

Update a load balancer rule.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.LbRule

+
Returns:

com.vmware.nsx.model.LbRule

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.loadbalancer_client.ServerSslProfiles(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(lb_server_ssl_profile)
+

Create a load balancer server-ssl profile.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:lb_server_ssl_profile (com.vmware.nsx.model_client.LbServerSslProfile) – (required)
Return type:com.vmware.nsx.model_client.LbServerSslProfile
Returns:com.vmware.nsx.model.LbServerSslProfile
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(server_ssl_profile_id)
+

Delete a load balancer server-ssl profile.

+ +++ + + + + + + + + + + + + + +
Parameters:server_ssl_profile_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(server_ssl_profile_id)
+

Retrieve a load balancer server-ssl profile.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:server_ssl_profile_id (str) – (required)
Return type:com.vmware.nsx.model_client.LbServerSslProfile
Returns:com.vmware.nsx.model.LbServerSslProfile
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Retrieve a paginated list of load balancer server-ssl profiles.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.LbServerSslProfileListResult

+
Returns:

com.vmware.nsx.model.LbServerSslProfileListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(server_ssl_profile_id, lb_server_ssl_profile)
+

Update a load balancer server-ssl profile.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.LbServerSslProfile

+
Returns:

com.vmware.nsx.model.LbServerSslProfile

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.loadbalancer_client.Services(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(lb_service)
+

Create a load balancer service.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:lb_service (com.vmware.nsx.model_client.LbService) – (required)
Return type:com.vmware.nsx.model_client.LbService
Returns:com.vmware.nsx.model.LbService
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(service_id)
+

Delete a load balancer service.

+ +++ + + + + + + + + + + + + + +
Parameters:service_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(service_id)
+

Retrieve a load balancer service.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:service_id (str) – (required)
Return type:com.vmware.nsx.model_client.LbService
Returns:com.vmware.nsx.model.LbService
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, logical_router_id=None, page_size=None, sort_ascending=None, sort_by=None)
+

Retrieve a paginated list of load balancer services. When +logical_router_id is specified in request parameters, the associated +load balancer services which are related to the given logical router +returned.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • logical_router_id (str or None) – Logical router identifier (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.LbServiceListResult

+
Returns:

com.vmware.nsx.model.LbServiceListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(service_id, lb_service)
+

Update a load balancer service.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.LbService

+
Returns:

com.vmware.nsx.model.LbService

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.loadbalancer_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+class com.vmware.nsx.loadbalancer_client.TcpProfiles(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(lb_tcp_profile)
+

Create a load balancer TCP profile.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:lb_tcp_profile (com.vmware.nsx.model_client.LbTcpProfile) – (required)
Return type:com.vmware.nsx.model_client.LbTcpProfile
Returns:com.vmware.nsx.model.LbTcpProfile
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(tcp_profile_id)
+

Delete a load balancer TCP profile.

+ +++ + + + + + + + + + + + + + +
Parameters:tcp_profile_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(tcp_profile_id)
+

Retrieve a load balancer TCP profile.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:tcp_profile_id (str) – (required)
Return type:com.vmware.nsx.model_client.LbTcpProfile
Returns:com.vmware.nsx.model.LbTcpProfile
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Retrieve a paginated list of load balancer TCP profiles.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.LbTcpProfileListResult

+
Returns:

com.vmware.nsx.model.LbTcpProfileListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(tcp_profile_id, lb_tcp_profile)
+

Update a load balancer TCP profile.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.LbTcpProfile

+
Returns:

com.vmware.nsx.model.LbTcpProfile

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.loadbalancer_client.VirtualServers(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(lb_virtual_server)
+

Create a load balancer virtual server.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:lb_virtual_server (com.vmware.nsx.model_client.LbVirtualServer) – (required)
Return type:com.vmware.nsx.model_client.LbVirtualServer
Returns:com.vmware.nsx.model.LbVirtualServer
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+createwithrules(lb_virtual_server_with_rule)
+

It is used to create virtual servers, the associated rules and bind the +rules to the virtual server. To add new rules, make sure the rules +which have no identifier specified, the new rules are automatically +generated and associated to the virtual server. If the virtual server +need to consume some existed rules without change, those rules should +not be specified in this array, otherwise, the rules are updated.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:lb_virtual_server_with_rule (com.vmware.nsx.model_client.LbVirtualServerWithRule) – (required)
Return type:com.vmware.nsx.model_client.LbVirtualServerWithRule
Returns:com.vmware.nsx.model.LbVirtualServerWithRule
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(virtual_server_id, delete_associated_rules=None)
+

Delete a load balancer virtual server.

+ +++ + + + + + + + + + + + + + +
Parameters:
    +
  • virtual_server_id (str) – (required)
    • +
  • delete_associated_rules (bool or None) – Delete associated rules (optional, default to false)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get(virtual_server_id)
+

Retrieve a load balancer virtual server.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:virtual_server_id (str) – (required)
Return type:com.vmware.nsx.model_client.LbVirtualServer
Returns:com.vmware.nsx.model.LbVirtualServer
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Retrieve a paginated list of load balancer virtual servers.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.LbVirtualServerListResult

+
Returns:

com.vmware.nsx.model.LbVirtualServerListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(virtual_server_id, lb_virtual_server)
+

Update a load balancer virtual server.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.LbVirtualServer

+
Returns:

com.vmware.nsx.model.LbVirtualServer

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+updatewithrules(virtual_server_id, lb_virtual_server_with_rule)
+

It is used to update virtual servers, the associated rules and update +the binding of virtual server and rules. To add new rules, make sure +the rules which have no identifier specified, the new rules are +automatically generated and associated to the virtual server. To delete +old rules, the rules should not be configured in new action, the UUID +of deleted rules should be also removed from rule_ids. To update rules, +the rules should be specified with new change and configured with +identifier. If there are some rules which are not modified, those rule +should not be specified in the rules list, the UUID list of rules +should be specified in rule_ids of LbVirtualServer.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.LbVirtualServerWithRule

+
Returns:

com.vmware.nsx.model.LbVirtualServerWithRule

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+

com.vmware.nsx.logical_ports_client module

+
+
+class com.vmware.nsx.logical_ports_client.ForwardingPath(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(lport_id, peer_port_id)
+

Get networking entities between two logical ports with VIF attachment

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • lport_id (str) – ID of source port (required)
    • +
  • peer_port_id (str) – ID of peer port (required)
    • +
+
Return type:

com.vmware.nsx.model_client.PortConnectionEntities

+
Returns:

com.vmware.nsx.model.PortConnectionEntities

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.logical_ports_client.MacTable(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+LIST_SOURCE_CACHED = 'cached'
+

Possible value for source of method MacTable.list().

+
+ +
+
+LIST_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method MacTable.list().

+
+ +
+
+list(lport_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, source=None, transport_node_id=None)
+

Returns MAC table of a specified logical port. If the target transport +node id is not provided, the NSX manager will ask the controller for +the transport node where the logical port is located. The query +parameter "source=cached" is not supported.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • lport_id (str) – (required)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
  • source (str or None) – Data source type. (optional)
    • +
  • transport_node_id (str or None) – TransportNode Id (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.LogicalPortMacAddressListResult

+
Returns:

com.vmware.nsx.model.LogicalPortMacAddressListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.logical_ports_client.State(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(lport_id)
+

Returns transport node id for a specified logical port. Also returns +information about all address bindings of the specified logical port. +This includes address bindings discovered via various snooping methods +like ARP snooping, DHCP snooping etc. and addressing bindings that are +realized based on user configuration.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:lport_id (str) – (required)
Return type:com.vmware.nsx.model_client.LogicalPortState
Returns:com.vmware.nsx.model.LogicalPortState
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.logical_ports_client.Statistics(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+GET_SOURCE_CACHED = 'cached'
+

Possible value for source of method Statistics.get().

+
+ +
+
+GET_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Statistics.get().

+
+ +
+
+get(lport_id, source=None)
+

Returns statistics of a specified logical port. If the logical port is +attached to a logical router port, query parameter +"source=realtime" is not supported.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • lport_id (str) – (required)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.LogicalPortStatistics

+
Returns:

com.vmware.nsx.model.LogicalPortStatistics

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.logical_ports_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+GETALL_ATTACHMENT_TYPE_BRIDGEENDPOINT = 'BRIDGEENDPOINT'
+

Possible value for attachmentType of method Status.getall().

+
+ +
+
+GETALL_ATTACHMENT_TYPE_DHCP_SERVICE = 'DHCP_SERVICE'
+

Possible value for attachmentType of method Status.getall().

+
+ +
+
+GETALL_ATTACHMENT_TYPE_L2VPN_SESSION = 'L2VPN_SESSION'
+

Possible value for attachmentType of method Status.getall().

+
+ +
+
+GETALL_ATTACHMENT_TYPE_LOGICALROUTER = 'LOGICALROUTER'
+

Possible value for attachmentType of method Status.getall().

+
+ +
+
+GETALL_ATTACHMENT_TYPE_METADATA_PROXY = 'METADATA_PROXY'
+

Possible value for attachmentType of method Status.getall().

+
+ +
+
+GETALL_ATTACHMENT_TYPE_NONE = 'NONE'
+

Possible value for attachmentType of method Status.getall().

+
+ +
+
+GETALL_ATTACHMENT_TYPE_VIF = 'VIF'
+

Possible value for attachmentType of method Status.getall().

+
+ +
+
+GETALL_SOURCE_CACHED = 'cached'
+

Possible value for source of method Status.getall().

+
+ +
+
+GETALL_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Status.getall().

+
+ +
+
+GET_SOURCE_CACHED = 'cached'
+

Possible value for source of method Status.get().

+
+ +
+
+GET_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Status.get().

+
+ +
+
+get(lport_id, source=None)
+

Returns operational status of a specified logical port.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • lport_id (str) – (required)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.LogicalPortOperationalStatus

+
Returns:

com.vmware.nsx.model.LogicalPortOperationalStatus

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+getall(attachment_id=None, attachment_type=None, bridge_cluster_id=None, container_ports_only=None, cursor=None, diagnostic=None, included_fields=None, logical_switch_id=None, page_size=None, parent_vif_id=None, sort_ascending=None, sort_by=None, source=None, switching_profile_id=None, transport_node_id=None, transport_zone_id=None)
+

Returns operational status of all logical ports. The query parameter +"source=realtime" is not supported.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • attachment_id (str or None) – Logical Port attachment Id (optional)
    • +
  • attachment_type (str or None) – Type of attachment for logical port; for query only. (optional)
    • +
  • bridge_cluster_id (str or None) – Bridge Cluster identifier (optional)
    • +
  • container_ports_only (bool or None) – Only container VIF logical ports will be returned if true +(optional, default to false)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • diagnostic (bool or None) – Flag to enable showing of transit logical port. (optional, default +to false)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • logical_switch_id (str or None) – Logical Switch identifier (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • parent_vif_id (str or None) – ID of the VIF of type PARENT (optional)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
  • source (str or None) – Data source type. (optional)
    • +
  • switching_profile_id (str or None) – Network Profile identifier (optional)
    • +
  • transport_node_id (str or None) – Transport node identifier (optional)
    • +
  • transport_zone_id (str or None) – Transport zone identifier (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.LogicalPortStatusSummary

+
Returns:

com.vmware.nsx.model.LogicalPortStatusSummary

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.logical_ports_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

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

com.vmware.nsx.logical_router_ports_client module

+
+
+class com.vmware.nsx.logical_router_ports_client.ArpTable(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+LIST_SOURCE_CACHED = 'cached'
+

Possible value for source of method ArpTable.list().

+
+ +
+
+LIST_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method ArpTable.list().

+
+ +
+
+list(logical_router_port_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, source=None, transport_node_id=None)
+
+++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • logical_router_port_id (str) – (required)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
  • source (str or None) – Data source type. (optional)
    • +
  • transport_node_id (str or None) – TransportNode Id (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.LogicalRouterPortArpTable

+
Returns:

com.vmware.nsx.model.LogicalRouterPortArpTable

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.logical_router_ports_client.Statistics(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+GET_SOURCE_CACHED = 'cached'
+

Possible value for source of method Statistics.get().

+
+ +
+
+GET_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Statistics.get().

+
+ +
+
+get(logical_router_port_id, source=None, transport_node_id=None)
+
+++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • logical_router_port_id (str) – (required)
    • +
  • source (str or None) – Data source type. (optional)
    • +
  • transport_node_id (str or None) – TransportNode Id (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.LogicalRouterPortStatistics

+
Returns:

com.vmware.nsx.model.LogicalRouterPortStatistics

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.logical_router_ports_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

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

com.vmware.nsx.logical_routers_client module

+
+
+class com.vmware.nsx.logical_routers_client.Routing(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(logical_router_id)
+

Returns the routing configuration for a specified logical router.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:logical_router_id (str) – (required)
Return type:com.vmware.nsx.model_client.RoutingConfig
Returns:com.vmware.nsx.model.RoutingConfig
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+update(logical_router_id, routing_config)
+

Modifies the routing configuration for a specified logical router.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.RoutingConfig

+
Returns:

com.vmware.nsx.model.RoutingConfig

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.logical_routers_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+GET_SOURCE_CACHED = 'cached'
+

Possible value for source of method Status.get().

+
+ +
+
+GET_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Status.get().

+
+ +
+
+get(logical_router_id, source=None)
+

Returns status for the Logical Router of the given id.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • logical_router_id (str) – (required)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.LogicalRouterStatus

+
Returns:

com.vmware.nsx.model.LogicalRouterStatus

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.logical_routers_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

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

com.vmware.nsx.logical_switches_client module

+
+
+class com.vmware.nsx.logical_switches_client.MacTable(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+LIST_SOURCE_CACHED = 'cached'
+

Possible value for source of method MacTable.list().

+
+ +
+
+LIST_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method MacTable.list().

+
+ +
+
+list(lswitch_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, source=None, transport_node_id=None)
+

Returns MAC table of a specified logical switch from the given +transport node if a transport node id is given in the query parameter +from the Central Controller Plane. The query parameter +"source=cached" is not supported.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • lswitch_id (str) – (required)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
  • source (str or None) – Data source type. (optional)
    • +
  • transport_node_id (str or None) – TransportNode Id (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.MacAddressListResult

+
Returns:

com.vmware.nsx.model.MacAddressListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.logical_switches_client.State(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+LIST_STATUS_IN_PROGRESS = 'IN_PROGRESS'
+

Possible value for status of method State.list().

+
+ +
+
+LIST_STATUS_PARTIAL_SUCCESS = 'PARTIAL_SUCCESS'
+

Possible value for status of method State.list().

+
+ +
+
+LIST_STATUS_PENDING = 'PENDING'
+

Possible value for status of method State.list().

+
+ +
+
+LIST_STATUS_SUCCESS = 'SUCCESS'
+

Possible value for status of method State.list().

+
+ +
+
+get(lswitch_id)
+

Returns current state of the logical switch configuration and details +of only out-of-sync transport nodes.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:lswitch_id (str) – (required)
Return type:com.vmware.nsx.model_client.LogicalSwitchState
Returns:com.vmware.nsx.model.LogicalSwitchState
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(status=None)
+

Returns a list of logical switches states that have realized state as +provided as query parameter.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:status (str or None) – Realized state of logical switches (optional)
Return type:com.vmware.nsx.model_client.LogicalSwitchStateListResult
Returns:com.vmware.nsx.model.LogicalSwitchStateListResult
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.logical_switches_client.Statistics(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+GET_SOURCE_CACHED = 'cached'
+

Possible value for source of method Statistics.get().

+
+ +
+
+GET_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Statistics.get().

+
+ +
+
+get(lswitch_id, source=None)
+

Returns statistics of a specified logical switch. The query parameter +"source=realtime" is not supported.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • lswitch_id (str) – (required)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.LogicalSwitchStatistics

+
Returns:

com.vmware.nsx.model.LogicalSwitchStatistics

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.logical_switches_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+GET_SOURCE_CACHED = 'cached'
+

Possible value for source of method Status.get().

+
+ +
+
+GET_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Status.get().

+
+ +
+
+GET_TRANSPORT_TYPE_OVERLAY = 'OVERLAY'
+

Possible value for transportType of method Status.get().

+
+ +
+
+GET_TRANSPORT_TYPE_VLAN = 'VLAN'
+

Possible value for transportType of method Status.get().

+
+ +
+
+get(cursor=None, diagnostic=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, source=None, switching_profile_id=None, transport_type=None, transport_zone_id=None, uplink_teaming_policy_name=None, vlan=None, vni=None)
+

Returns Operational status of all logical switches. The query parameter +"source=realtime" is not supported.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • diagnostic (bool or None) – Flag to enable showing of transit logical switch. (optional, +default to false)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
  • source (str or None) – Data source type. (optional)
    • +
  • switching_profile_id (str or None) – Switching Profile identifier (optional)
    • +
  • transport_type (str or None) – Mode of transport supported in the transport zone for this logical +switch (optional)
    • +
  • transport_zone_id (str or None) – Transport zone identifier (optional)
    • +
  • uplink_teaming_policy_name (str or None) – The logical switch’s uplink teaming policy name (optional)
    • +
  • vlan (long or None) – Virtual Local Area Network Identifier (optional)
    • +
  • vni (long or None) – VNI of the OVERLAY LogicalSwitch(es) to return. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.LogicalSwitchStatusSummary

+
Returns:

com.vmware.nsx.model.LogicalSwitchStatusSummary

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.logical_switches_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+class com.vmware.nsx.logical_switches_client.Summary(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(lswitch_id)
+

Returns the number of ports assigned to a logical switch.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:lswitch_id (str) – (required)
Return type:com.vmware.nsx.model_client.LogicalSwitchStatus
Returns:com.vmware.nsx.model.LogicalSwitchStatus
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.logical_switches_client.VtepTable(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+LIST_SOURCE_CACHED = 'cached'
+

Possible value for source of method VtepTable.list().

+
+ +
+
+LIST_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method VtepTable.list().

+
+ +
+
+list(lswitch_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, source=None, transport_node_id=None)
+

Returns the virtual tunnel endpoint table of a specified logical switch +from the given transport node if a transport node id is given in the +query parameter, from the Central Controller Plane. The query parameter +"source=cached" is not supported.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • lswitch_id (str) – (required)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
  • source (str or None) – Data source type. (optional)
    • +
  • transport_node_id (str or None) – TransportNode Id (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.VtepListResult

+
Returns:

com.vmware.nsx.model.VtepListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+

com.vmware.nsx.mac_sets_client module

+
+
+class com.vmware.nsx.mac_sets_client.Members(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(mac_set_id, m_ac_address_element)
+

Add an individual MAC address to a MACSet

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.MACAddressElement

+
Returns:

com.vmware.nsx.model.MACAddressElement

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+delete(mac_set_id, mac_address)
+

Remove an individual MAC address from a MACSet

+ +++ + + + + + + + + + + + + + +
Parameters:
    +
  • mac_set_id (str) – MACSet Id (required)
    • +
  • mac_address (str) – MAC address to be removed (required)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+list(mac_set_id)
+

List all MAC addresses in a MACSet

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:mac_set_id (str) – MAC Set Id (required)
Return type:com.vmware.nsx.model_client.MACAddressElementListResult
Returns:com.vmware.nsx.model.MACAddressElementListResult
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.mac_sets_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

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

com.vmware.nsx.md_proxies_client module

+
+
+class com.vmware.nsx.md_proxies_client.Statistics(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+GET_SOURCE_CACHED = 'cached'
+

Possible value for source of method Statistics.get().

+
+ +
+
+GET_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Statistics.get().

+
+ +
+
+get(proxy_id, logical_switch_id=None, source=None)
+

Returns the statistics of the given metatada proxy. If no logical +switch is provided, all staticstics of all the logical switches the +proxy was attached will be returned.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • proxy_id (str) – (required)
    • +
  • logical_switch_id (str or None) – The uuid of logical switch (optional)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.MetadataProxyStatistics

+
Returns:

com.vmware.nsx.model.MetadataProxyStatistics

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.md_proxies_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(proxy_id, logical_switch_id)
+

Returns the status of the given metadata proxy and attached logical +switch.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • proxy_id (str) – (required)
    • +
  • logical_switch_id (str) – (required)
    • +
+
Return type:

com.vmware.nsx.model_client.MetadataProxyStatus

+
Returns:

com.vmware.nsx.model.MetadataProxyStatus

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.md_proxies_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

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

com.vmware.nsx.migration_client module

+
+
+class com.vmware.nsx.migration_client.Bundles(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(migration_bundle_fetch_request)
+

Fetch migration bundle from given url

+ +++ + + + + + + + + + + + + + + + + + + + +
Parameters:migration_bundle_fetch_request (com.vmware.nsx.model_client.MigrationBundleFetchRequest) – (required)
Return type:com.vmware.nsx.model_client.MigrationBundleId
Returns:com.vmware.nsx.model.MigrationBundleId
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
Raise:com.vmware.vapi.std.errors_client.Unauthenticated +Unauthorized
+
+ +
+
+get(bundle_id)
+

Get uploaded migration bundle information

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:bundle_id (str) – (required)
Return type:com.vmware.nsx.model_client.MigrationBundleInfo
Returns:com.vmware.nsx.model.MigrationBundleInfo
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.migration_client.FeedbackRequests(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

NSX-V feedback details

+ +++ + + + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.MigrationFeedbackRequestListResult

+
Returns:

com.vmware.nsx.model.MigrationFeedbackRequestListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
Raise:

com.vmware.vapi.std.errors_client.Unauthenticated +Unauthorized

+
+
+ +
+ +
+
+class com.vmware.nsx.migration_client.FeedbackResponse(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+update(migration_feedback_response_list)
+

Migration feedback response

+ +++ + + + + + + + + + + + + + + + +
Parameters:migration_feedback_response_list (com.vmware.nsx.model_client.MigrationFeedbackResponseList) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
Raise:com.vmware.vapi.std.errors_client.Unauthenticated +Unauthorized
+
+ +
+ +
+
+class com.vmware.nsx.migration_client.MigrationUnitGroups(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+addmigrationunits(group_id, migration_unit_list)
+

Add migration units to specified migration unit group

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.MigrationUnitList

+
Returns:

com.vmware.nsx.model.MigrationUnitList

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+create(migration_unit_group)
+

Create a group

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:migration_unit_group (com.vmware.nsx.model_client.MigrationUnitGroup) – (required)
Return type:com.vmware.nsx.model_client.MigrationUnitGroup
Returns:com.vmware.nsx.model.MigrationUnitGroup
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(group_id)
+

Delete the migration unit group

+ +++ + + + + + + + + + + + + + +
Parameters:group_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(group_id, summary=None)
+

Return migration unit group information

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • group_id (str) – (required)
    • +
  • summary (bool or None) – Flag indicating whether to return the summary (optional, default to +false)
    • +
+
Return type:

com.vmware.nsx.model_client.MigrationUnitGroup

+
Returns:

com.vmware.nsx.model.MigrationUnitGroup

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+list(component_type=None, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, summary=None, sync=None)
+

Return information of all migration unit groups

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • component_type (str or None) – Component type based on which migration unit groups to be filtered +(optional)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
  • summary (bool or None) – Flag indicating whether to return summary (optional, default to +false)
    • +
  • sync (bool or None) – Synchronize before returning migration unit groups (optional, +default to false)
    • +
+
Return type:

com.vmware.nsx.model_client.MigrationUnitGroupListResult

+
Returns:

com.vmware.nsx.model.MigrationUnitGroupListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+reorder(group_id, reorder_migration_request)
+

Reorder migration unit group

+ +++ + + + + + + + + + + + + + +
Parameters: +
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(group_id, migration_unit_group)
+

Update the migration unit group

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.MigrationUnitGroup

+
Returns:

com.vmware.nsx.model.MigrationUnitGroup

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.migration_client.MigrationUnitGroupsStatus(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+getall(component_type=None, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Get migration status for migration unit groups

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • component_type (str or None) – Component type based on which migration unit groups to be filtered +(optional)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.MigrationUnitGroupStatusListResult

+
Returns:

com.vmware.nsx.model.MigrationUnitGroupStatusListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.migration_client.MigrationUnits(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(migration_unit_id)
+

Get a specific migration unit

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:migration_unit_id (str) – (required)
Return type:com.vmware.nsx.model_client.MigrationUnit
Returns:com.vmware.nsx.model.MigrationUnit
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(component_type=None, current_version=None, cursor=None, group_id=None, has_warnings=None, included_fields=None, metadata=None, migration_unit_type=None, page_size=None, sort_ascending=None, sort_by=None)
+

Get migration units

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • component_type (str or None) – Component type based on which migration units to be filtered +(optional)
    • +
  • current_version (str or None) – Current version of migration unit based on which migration units to +be filtered (optional)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • group_id (str or None) – UUID of group based on which migration units to be filtered +(optional)
    • +
  • has_warnings (bool or None) – Flag to indicate whether to return only migration units with +warnings (optional, default to false)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • metadata (str or None) – Metadata about migration unit to filter on (optional)
    • +
  • migration_unit_type (str or None) – Migration unit type based on which migration units to be filtered +(optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.MigrationUnitListResult

+
Returns:

com.vmware.nsx.model.MigrationUnitListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.migration_client.MigrationUnitsStats(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, sync=None)
+

Get migration units stats

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
  • sync (bool or None) – Synchronize before returning migration unit stats (optional, +default to false)
    • +
+
Return type:

com.vmware.nsx.model_client.MigrationUnitTypeStatsList

+
Returns:

com.vmware.nsx.model.MigrationUnitTypeStatsList

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.migration_client.Nodes(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+list(component_type=None, component_version=None, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Get list of nodes across all types

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • component_type (str or None) – Component type based on which nodes will be filtered (optional)
    • +
  • component_version (str or None) – Component version based on which nodes will be filtered (optional)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.NodeInfoListResult

+
Returns:

com.vmware.nsx.model.NodeInfoListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.migration_client.NodesSummary(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Get summary of nodes

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeSummaryList
Returns:com.vmware.nsx.model.NodeSummaryList
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.migration_client.Plan(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+continue_(skip=None)
+

Continue migration

+ +++ + + + + + + + + + + + + + + + +
Parameters:skip (bool or None) – Skip to migration of next component. (optional, default to false)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.ConcurrentChange +Conflict
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+pause()
+

Pause migration

+ +++ + + + + + + + + + + + + + +
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.ConcurrentChange +Conflict
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+reset(component_type)
+

Reset the migration plan to default plan. User has an option to change +the default plan. But if after making changes, user wants to go back to +the default plan, this is the way to do so.

+ +++ + + + + + + + + + + + + + +
Parameters:component_type (str) – Component type (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+rollback()
+

Rollbabck migration

+ +++ + + + + + + + + + + + +
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+start()
+

Start migration

+ +++ + + + + + + + + + + + +
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.migration_client.Setup(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

NSX-V setup details

+ +++ + + + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.MigrationSetupInfo
Returns:com.vmware.nsx.model.MigrationSetupInfo
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
Raise:com.vmware.vapi.std.errors_client.Unauthenticated +Unauthorized
+
+ +
+
+update(migration_setup_info)
+

NSX-V setup details

+ +++ + + + + + + + + + + + + + + + + + + + +
Parameters:migration_setup_info (com.vmware.nsx.model_client.MigrationSetupInfo) – (required)
Return type:com.vmware.nsx.model_client.MigrationSetupInfo
Returns:com.vmware.nsx.model.MigrationSetupInfo
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
Raise:com.vmware.vapi.std.errors_client.Unauthenticated +Unauthorized
+
+ +
+ +
+
+class com.vmware.nsx.migration_client.StatusSummary(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(component_type=None)
+

Get migration status summary

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:component_type (str or None) – Component type based on which migration units to be filtered +(optional)
Return type:com.vmware.nsx.model_client.MigrationStatus
Returns:com.vmware.nsx.model.MigrationStatus
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.migration_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+class com.vmware.nsx.migration_client.Summary(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Get migration summary

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.MigrationSummary
Returns:com.vmware.nsx.model.MigrationSummary
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+

com.vmware.nsx.model_client module

+
+
+class com.vmware.nsx.model_client.ALGTypeNSService(alg=None, destination_ports=None, source_ports=None, resource_type='ALGTypeNSService')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

An NSService element that represents an ALG protocol

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+ALG_FTP = 'FTP'
+
+ +
+
+ALG_MS_RPC_TCP = 'MS_RPC_TCP'
+
+ +
+
+ALG_MS_RPC_UDP = 'MS_RPC_UDP'
+
+ +
+
+ALG_NBDG_BROADCAST = 'NBDG_BROADCAST'
+
+ +
+
+ALG_NBNS_BROADCAST = 'NBNS_BROADCAST'
+
+ +
+
+ALG_ORACLE_TNS = 'ORACLE_TNS'
+
+ +
+
+ALG_SUN_RPC_TCP = 'SUN_RPC_TCP'
+
+ +
+
+ALG_SUN_RPC_UDP = 'SUN_RPC_UDP'
+
+ +
+
+ALG_TFTP = 'TFTP'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.AcceptableComponentVersion(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, acceptable_versions=None, component_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • acceptable_versions (list of str) – List of component versions
    • +
  • component_type (str) –

    Possible values are:

    + +
    +
    Node type
    +
    • +
+
+
+
+COMPONENT_TYPE_CCP = 'CCP'
+
+ +
+
+COMPONENT_TYPE_EDGE = 'EDGE'
+
+ +
+
+COMPONENT_TYPE_HOST = 'HOST'
+
+ +
+
+COMPONENT_TYPE_MP = 'MP'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.AcceptableComponentVersionList(results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:results (list of AcceptableComponentVersion) – Acceptable version whitelist for different components
+
+ +
+
+class com.vmware.nsx.model_client.ActionableResource(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, ip_address=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Resources managed during restore process

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • ip_address (str or None) – A resource reference on which actions can be performed format: ip
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ActionableResourceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of ActionableResource) – List results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.AddClusterNodeSpec(controller_role_config=None, display_name=None, external_id=None, mgr_role_config=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • controller_role_config (AddControllerNodeSpec or None) –
    • +
  • display_name (str or None) – Display name for the node
    • +
  • external_id (str or None) – External identifier of the node
    • +
  • mgr_role_config (AddManagementNodeSpec or None) –
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.AddClusterNodeVMInfo(clustering_config=None, deployment_requests=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Contains a list of cluster node VM deployment requests and optionally a +clustering configuration.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • clustering_config (vmware.vapi.struct.VapiStruct or None) – Configuration for automatically joining the cluster nodes to the +cluster after they are deployed. It is required if any of the +deployment nodes has CONTROLLER role. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +ClusteringConfig. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in ClusteringConfig.
    • +
  • deployment_requests (list of ClusterNodeVMDeploymentRequest) – Cluster node VM deployment requests to be deployed by the Manager.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.AddControllerNodeSpec(clustering_params=None, control_plane_server_certificate=None, host_msg_client_info=None, mpa_msg_client_info=None, node_id=None, type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • clustering_params (ClusteringInfo or None) – The details of the controller node required for cluster +initialization or joining to an existing cluster. If this property +is set, the node will be added to an existing cluster or used to +create a new cluster. Otherwise no clustering operation/s will be +performed.
    • +
  • control_plane_server_certificate (str or None) – Deprecated. Do not supply a value for this property.
    • +
  • host_msg_client_info (MsgClientInfo) –
    • +
  • mpa_msg_client_info (MsgClientInfo) –
    • +
  • node_id (str or None) – Only use this if an id for the node already exists with MP. If not +specified, then the node_id will be set to a random id.
    • +
  • type (str) –

    Possible values are:

    + +
    +
    must be set to AddControllerNodeSpec
    +
    • +
+
+
+
+TYPE_ADDCONTROLLERNODESPEC = 'AddControllerNodeSpec'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.AddManagementNodeSpec(cert_thumbprint=None, mpa_msg_client_info=None, password=None, remote_address=None, type=None, user_name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • cert_thumbprint (str or None) – The certificate thumbprint of the remote node.
    • +
  • mpa_msg_client_info (MsgClientInfo or None) –
    • +
  • password (str or None) – The password to be used to authenticate with the remote node.
    • +
  • remote_address (str) – The host address of the remote node to which to send this join +request. format: ip
    • +
  • type (str) –

    Possible values are:

    + +
    +
    must be set to AddManagementNodeSpec
    +
    • +
  • user_name (str) – The username to be used to authenticate with the remote node.
    • +
+
+
+
+TYPE_ADDMANAGEMENTNODESPEC = 'AddManagementNodeSpec'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.AddressBindingEntry(binding=None, binding_timestamp=None, source=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

An address binding entry is a combination of the IP-MAC-VLAN binding for a +logical port. The address bindings can be obtained via various methods like +ARP snooping, DHCP snooping etc. or by user configuration.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+SOURCE_ARP_SNOOPING = 'ARP_SNOOPING'
+
+ +
+
+SOURCE_DHCP_SNOOPING = 'DHCP_SNOOPING'
+
+ +
+
+SOURCE_INVALID = 'INVALID'
+
+ +
+
+SOURCE_UNKNOWN = 'UNKNOWN'
+
+ +
+
+SOURCE_USER_DEFINED = 'USER_DEFINED'
+
+ +
+
+SOURCE_VM_TOOLS = 'VM_TOOLS'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.AdvanceClusterRestoreInput(id=None, resources=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • id (str or None) – Unique id of an instruction (as returned by the GET /restore/status +call) for which input is to be provided +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resources (list of SelectableResourceReference) – List of resources for which the instruction is applicable.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.AdvanceClusterRestoreRequest(data=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:data (list of AdvanceClusterRestoreInput) – List of instructions and their associated data
+
+ +
+
+class com.vmware.nsx.model_client.AdvertiseRule(action=None, description=None, display_name=None, networks=None, rule_filter=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • action (str or None) –

    Possible values are:

    + +

    ALLOW action enables the advertisment and DENY action disables the +advertisement of a filtered routes to the connected TIER0 router.

    +
    • +
  • description (str or None) – Description
    • +
  • display_name (str or None) – Display name
    • +
  • networks (list of str) – network(CIDR) to be routed format: ipv4-cidr-block
    • +
  • rule_filter (AdvertisementRuleFilter or None) – Rule filter for the advertise rule
    • +
+
+
+
+ACTION_ALLOW = 'ALLOW'
+
+ +
+
+ACTION_DENY = 'DENY'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.AdvertiseRuleList(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, logical_router_id=None, rules=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • logical_router_id (str or None) – Logical router id +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • rules (list of AdvertiseRule or None) – List of advertisement rules
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.AdvertisedNetwork(advertised_route_type=None, is_advertised=None, network=None, resource=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • advertised_route_type (str or None) – Advertise network route type on TIER0 LR +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • is_advertised (bool or None) – Flag to denote advertisement status of network to TIER0 LR. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • network (str or None) – Advertised network address. format: ipv4 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource (ResourceReference or None) – Resource which has registered network.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.AdvertisedNetworksListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of AdvertisedNetwork or None) – List of networks which advertised to TIER0 from TIER1 LR +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.AdvertisementConfig(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, advertise_lb_snat_ip=None, advertise_lb_vip=None, advertise_nat_routes=None, advertise_nsx_connected_routes=None, advertise_static_routes=None, enabled=None, logical_router_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • advertise_lb_snat_ip (bool or None) – Flag to advertise all lb SNAT ips
    • +
  • advertise_lb_vip (bool or None) – Flag to advertise lb vip
    • +
  • advertise_nat_routes (bool or None) – Flag to advertise all routes of nat
    • +
  • advertise_nsx_connected_routes (bool or None) – Flag to advertise all connected routes
    • +
  • advertise_static_routes (bool or None) – Flag to advertise all static routes
    • +
  • enabled (bool or None) – Flag to enable this configuration
    • +
  • logical_router_id (str or None) – Logical router id +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.AdvertisementRuleFilter(match_route_types=None, prefix_operator=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

To filter the routes advertised by the TIER1 LR to TIER0 LR. Filtering will +be based on the type of route and the prefix operator configured.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+MATCH_ROUTE_TYPES_ANY = 'ANY'
+
+ +
+
+MATCH_ROUTE_TYPES_NSX_CONNECTED = 'NSX_CONNECTED'
+
+ +
+
+MATCH_ROUTE_TYPES_STATIC = 'STATIC'
+
+ +
+
+MATCH_ROUTE_TYPES_T1_LB_SNAT = 'T1_LB_SNAT'
+
+ +
+
+MATCH_ROUTE_TYPES_T1_LB_VIP = 'T1_LB_VIP'
+
+ +
+
+MATCH_ROUTE_TYPES_T1_NAT = 'T1_NAT'
+
+ +
+
+PREFIX_OPERATOR_EQ = 'EQ'
+
+ +
+
+PREFIX_OPERATOR_GE = 'GE'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.AggregateDataResponse(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Final data aggregation response. The results array holds the primary and +the related objects

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of AggregateResponse) – Array containing the primary and the related object details
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.AggregateRequest(included_fields=None, alias=None, filters=None, resource_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Common request parameters for the primary/related types

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result
    • +
  • alias (str or None) – Alias for the response
    • +
  • filters (list of FilterRequest or None) – An array of filter conditions
    • +
  • resource_type (str) – Resource type name
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.AggregateResponse(primary=None, related=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Response for the primary/related types

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • primary (vmware.vapi.struct.VapiStruct) – Requested properties of the primary object
    • +
  • related (list of RelatedData) – Requested properties of the related objects
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.AggregatedDataCounter(rx_bytes=None, rx_packets=None, tx_bytes=None, tx_packets=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+ +
+
+class com.vmware.nsx.model_client.AggregatedDataCounterEx(rx_bytes=None, rx_packets=None, tx_bytes=None, tx_packets=None, dropped_by_security_packets=None, mac_learning=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+ +
+
+class com.vmware.nsx.model_client.AggregatedLogicalRouterPortCounters(last_update_timestamp=None, rx=None, tx=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has +never updated the data. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • rx (LogicalRouterPortCounters or None) –
    • +
  • tx (LogicalRouterPortCounters or None) –
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.Alarm(id=None, severity=None, source_comp=None, source_comp_id=None, source_subcomp=None, sources=None, state=None, timestamp=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Alarm in NSX that needs users’ attention

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • id (str or None) – Unique identifier for an NSX Alarm +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • severity (str or None) –

    Possible values are:

    + +
    +
    Severity of an Alarm
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • source_comp (str or None) – Alarm source component like nsx-manager, nsx-edge etc +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • source_comp_id (str or None) – Unique identifier(like UUID) for the node sending the Alarm +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • source_subcomp (str or None) – Alarm source sub component like nsx-mpa etc +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sources (list of AlarmSource or None) – Sources emitting this alarm +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • state (str) –

    Possible values are:

    + +
    +
    Alarm state
    +
    • +
  • timestamp (long or None) – Date and time in UTC of the Alarm format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+
+SEVERITY_CRITICAL = 'CRITICAL'
+
+ +
+
+SEVERITY_MAJOR = 'MAJOR'
+
+ +
+
+SEVERITY_MINOR = 'MINOR'
+
+ +
+
+SEVERITY_UNKNOWN = 'UNKNOWN'
+
+ +
+
+STATE_ACKNOWLEDGED = 'ACKNOWLEDGED'
+
+ +
+
+STATE_ACTIVE = 'ACTIVE'
+
+ +
+
+STATE_RESOLVED = 'RESOLVED'
+
+ +
+
+STATE_UNKNOWN = 'UNKNOWN'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.AlarmListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Alarm collection results

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of Alarm) – Alarm results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.AlarmSource(id=None, ip_address=None, ip_address_type=None, local_ip=None, mount=None, peer_ip=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Source of the Alarm

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • id (str or None) – Identifier of the Alarm source entity for e.g. Vpn session id, Vpn +tunnel id etc. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • ip_address (str or None) – Ip address +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • ip_address_type (str or None) –

    Possible values are:

    + +
    +
    Ip address type v4, v6 etc.
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • local_ip (str or None) – VPN session/tunnel etc. local Ip(v4 or v6) address +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • mount (str or None) – Filesystem mount name +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • peer_ip (str or None) – VPN session/tunnel etc. peer Ip(v4 or v6) address +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+
+IP_ADDRESS_TYPE_IPV4 = 'IPV4'
+
+ +
+
+IP_ADDRESS_TYPE_IPV6 = 'IPV6'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.AllClusterGroupStatus(cluster_id=None, groups=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

A list of the statuses of all the groups in the cluster.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • cluster_id (str or None) – UUID of the cluster +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • groups (list of ClusterGroupStatus or None) – Array of groups and their statuses +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.AllocationIpAddress(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, allocation_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Allocation parameters for the IP address (e.g. specific IP address) can be +specified. Tags, display_name and description attributes are not supported +in this release.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • allocation_id (str or None) – Address that is allocated from pool format: ip +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.AllocationIpAddressListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of AllocationIpAddress) – Pool allocation list results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ApiError(details=None, error_code=None, error_data=None, error_message=None, module_name=None, related_errors=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Detailed information about an API Error

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • details (str or None) – Further details about the error
    • +
  • error_code (long or None) – A numeric error code format: int64
    • +
  • error_data (vmware.vapi.struct.VapiStruct or None) – Additional data about the error
    • +
  • error_message (str or None) – A description of the error
    • +
  • module_name (str or None) – The module name where the error occurred
    • +
  • related_errors (list of RelatedApiError or None) – Other errors related to this error
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.AppDiscoveryAppProfileResultSummary(app_profile_id=None, display_name=None, installed_apps_count=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Contains the application discovery result summary of the App Profile

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • app_profile_id (str or None) – ID of the App Profile
    • +
  • display_name (str or None) – Name of the App Profile
    • +
  • installed_apps_count (long or None) – Number of apps installed that belongs to this App Profile format: +int64
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.AppDiscoverySession(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, end_timestamp=None, failed_reason=None, reclassification=None, start_timestamp=None, status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Contains the details of an application discovery session

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • end_timestamp (long or None) – End time of the session expressed in milliseconds since epoch +format: int64
    • +
  • failed_reason (str or None) – The reason for the session status failure. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • reclassification (str or None) – This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • start_timestamp (long or None) – Start time of the session expressed in milliseconds since epoch +format: int64
    • +
  • status (str or None) –

    Possible values are:

    + +
    +
    The status of the session
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
+
+
+
+RECLASSIFICATION_NOT_REQUIRED = 'NOT_REQUIRED'
+
+ +
+
+RECLASSIFICATION_REQUIRED = 'REQUIRED'
+
+ +
+
+STATUS_FAILED = 'FAILED'
+
+ +
+
+STATUS_FINISHED = 'FINISHED'
+
+ +
+
+STATUS_RUNNING = 'RUNNING'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.AppDiscoverySessionResultSummary(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, end_timestamp=None, failed_reason=None, reclassification=None, start_timestamp=None, status=None, app_profile_summary_list=None, app_profiles=None, ns_groups=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Contains the summary of the results of an application discovery session

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • end_timestamp (long or None) – End time of the session expressed in milliseconds since epoch +format: int64
    • +
  • failed_reason (str or None) – The reason for the session status failure. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • reclassification (str or None) – This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • start_timestamp (long or None) – Start time of the session expressed in milliseconds since epoch +format: int64
    • +
  • status (str or None) –

    Possible values are:

    + +
    +
    The status of the session
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • app_profile_summary_list (list of AppDiscoveryAppProfileResultSummary or None) – List of App Profiles summary discovered in this session
    • +
  • app_profiles (list of AppProfileMetaInfo or None) – List of app profiles targeted to be classified for this session
    • +
  • ns_groups (list of NSGroupMetaInfo or None) – List of NSGroups provided for discovery for this session
    • +
+
+
+
+RECLASSIFICATION_NOT_REQUIRED = 'NOT_REQUIRED'
+
+ +
+
+RECLASSIFICATION_REQUIRED = 'REQUIRED'
+
+ +
+
+STATUS_FAILED = 'FAILED'
+
+ +
+
+STATUS_FINISHED = 'FINISHED'
+
+ +
+
+STATUS_RUNNING = 'RUNNING'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.AppDiscoverySessionsListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Application discovery sessions list

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of AppDiscoverySession) – AppProfile Sessions results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.AppDiscoveryVmInfo(links=None, schema=None, self_=None, os_properties=None, os_type=None, vm_external_id=None, vm_name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

AppDiscoveryVmInfo details

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • os_properties (list of str or None) – OS properties of the VM
    • +
  • os_type (str or None) –

    Possible values are:

    + +
    +
    OS type of the VM
    +
    • +
  • vm_external_id (str or None) – External Id of the VM
    • +
  • vm_name (str or None) – Name of the VM
    • +
+
+
+
+OS_TYPE_INVALID = 'INVALID'
+
+ +
+
+OS_TYPE_LINUX = 'LINUX'
+
+ +
+
+OS_TYPE_WINDOWS = 'WINDOWS'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.AppDiscoveryVmInfoListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

AppDiscoveryVmInfo list

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of AppDiscoveryVmInfo) – list of AppDiscoveryVmInfos
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.AppInfo(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, manufacturer=None, name=None, os_type=None, version=None, vm_ids=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

AppInfo details

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • manufacturer (str or None) – Manufacturer of the app
    • +
  • name (str or None) – Name of the app
    • +
  • os_type (str or None) –

    Possible values are:

    + +
    +
    OS type of VM the App belongs to
    +
    • +
  • version (str or None) – Version of the app
    • +
  • vm_ids (list of str or None) – Ids of the VMs in which this app is installed
    • +
+
+
+
+OS_TYPE_INVALID = 'INVALID'
+
+ +
+
+OS_TYPE_LINUX = 'LINUX'
+
+ +
+
+OS_TYPE_WINDOWS = 'WINDOWS'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.AppInfoHostVmCsvRecord(display_name=None, host_vms=None, id=None, manufacturer=None, os_type=None, version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • display_name (str or None) – Name of the app +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • host_vms (str or None) – vm ids that this application belongs to +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • id (str or None) – Id of the app +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • manufacturer (str or None) – Manufacturer of the app +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • os_type (str or None) –

    Possible values are:

    + +
    +
    OS type of the VM
    +
    • +
  • version (str or None) – Version of the app +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+
+OS_TYPE_INVALID = 'INVALID'
+
+ +
+
+OS_TYPE_LINUX = 'LINUX'
+
+ +
+
+OS_TYPE_WINDOWS = 'WINDOWS'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.AppInfoHostVmListInCsvFormat(file_name=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • file_name (str or None) – File name set by HTTP server if API returns CSV result as a file.
    • +
  • results (list of AppInfoHostVmCsvRecord or None) – List of appplications discovered during an application discovery +session
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.AppInfoListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

AppInfo Sessions list results

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of AppInfo) – Application details corresponding to the App Profile
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.AppProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, app_profile_category=None, app_profile_criteria=None, default_app_profile=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

AppProfile details

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • app_profile_category (str or None) – Category of the app profile, value could be any string that +describes the profile
    • +
  • app_profile_criteria (list of str) – Criteria of the app profile, value could be any string or +"\*" (match any string)
    • +
  • default_app_profile (bool or None) – True if this App Profile is a default profile (automatically +created by the system)
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.AppProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

App Profile ID list

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of AppProfile) – AppProfile IDs
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.AppProfileMemberAppsCsvRecord(app_profile_category=None, app_profile_criteria=None, description=None, display_name=None, member_apps=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • app_profile_category (str or None) – Category of the app profile, value could be any string that +describes the profile +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • app_profile_criteria (str or None) – Criteria of the app profile, value could be any string or +"\*" (match any string) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of the app profile +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • display_name (str or None) – Name of the app profile +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • member_apps (str or None) – Applications that are member of this app profile +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.AppProfileMemberAppsListInCsvFormat(file_name=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • file_name (str or None) – File name set by HTTP server if API returns CSV result as a file.
    • +
  • results (list of AppProfileMemberAppsCsvRecord or None) – List of app profiles for an application discovery session
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.AppProfileMetaInfo(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, app_profile_category=None, app_profile_id=None, app_profile_name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Contains the metadata of an App Profile

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • app_profile_category (str or None) – Categories of the app profile
    • +
  • app_profile_id (str or None) – ID of the App Profile
    • +
  • app_profile_name (str or None) – Name of the App Profile
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ApplianceManagementTaskListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Appliance management task query results

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of ApplianceManagementTaskProperties) – Task property results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ApplianceManagementTaskProperties(links=None, schema=None, self_=None, async_response_available=None, cancelable=None, description=None, details=None, end_time=None, id=None, message=None, progress=None, request_method=None, request_uri=None, start_time=None, status=None, user=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Appliance management task properties

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • async_response_available (bool or None) – True if response for asynchronous request is available +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • cancelable (bool or None) – True if this task can be canceled +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of the task +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • details (vmware.vapi.struct.VapiStruct or None) – Details about the task if known +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • end_time (long or None) – The end time of the task in epoch milliseconds format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • id (str or None) – Identifier for this task +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • message (str or None) – A message describing the disposition of the task +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • progress (long or None) – Task progress if known, from 0 to 100 format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • request_method (str or None) – HTTP request method +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • request_uri (str or None) – URI of the method invocation that spawned this task +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • start_time (long or None) – The start time of the task in epoch milliseconds format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • status (str or None) –

    Possible values are:

    + +
    +
    Current status of the task
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • user (str or None) – Name of the user who created this task +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+
+STATUS_CANCELED = 'canceled'
+
+ +
+
+STATUS_CANCELING = 'canceling'
+
+ +
+
+STATUS_ERROR = 'error'
+
+ +
+
+STATUS_KILLED = 'killed'
+
+ +
+
+STATUS_RUNNING = 'running'
+
+ +
+
+STATUS_SUCCESS = 'success'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.AppliedTos(logical_ports=None, logical_switches=None, nsgroups=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Entity lists where the profile will be enabled on.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+ +
+
+class com.vmware.nsx.model_client.AssignedByDhcp(resource_type='AssignedByDhcp')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This type can be specified in ip assignment spec of host switch if DHCP +based IP assignment is desired for host switch virtual tunnel endpoints.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:resource_type (str) –

Possible values are:

+ +
+
+ +
+
+class com.vmware.nsx.model_client.AssociationListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of ResourceReference) – Paged Collection of ResourceReference
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.AttachmentContext(allocate_addresses=None, resource_type='AttachmentContext')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+ALLOCATE_ADDRESSES_BOTH = 'Both'
+
+ +
+
+ALLOCATE_ADDRESSES_IPPOOL = 'IpPool'
+
+ +
+
+ALLOCATE_ADDRESSES_MACPOOL = 'MacPool'
+
+ +
+
+ALLOCATE_ADDRESSES_NONE = 'None'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.Attribute(attribute_type=None, display_name=None, key=None, value=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Attribute specific to a partner. There attributes are passed on to the +partner appliance and is opaque to the NSX Manager. The Attributes used by +the partner applicance.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+ATTRIBUTE_TYPE_IP_ADDRESS = 'IP_ADDRESS'
+
+ +
+
+ATTRIBUTE_TYPE_LONG = 'LONG'
+
+ +
+
+ATTRIBUTE_TYPE_PASSWORD = 'PASSWORD'
+
+ +
+
+ATTRIBUTE_TYPE_PORT = 'PORT'
+
+ +
+
+ATTRIBUTE_TYPE_STRING = 'STRING'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.AuditLog(appname=None, facility=None, full_log=None, hostname=None, message=None, msgid=None, priority=None, procid=None, struct_data=None, timestamp=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Audit log in RFC5424 format

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • appname (str) – Application name field of the log
    • +
  • facility (long) – Facility field of the log format: int64
    • +
  • full_log (str) – Full log with both header and message
    • +
  • hostname (str) – Hostname field of the log
    • +
  • message (str) – Message field of the log
    • +
  • msgid (str) – Message ID field of the log
    • +
  • priority (long) – Priority field of the log format: int64
    • +
  • procid (long) – Process ID field of the log format: int64
    • +
  • struct_data (StructuredData) – Structured data field of the log
    • +
  • timestamp (str) – Date and time in UTC of the log
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.AuditLogListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, last_full_sync_timestamp=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Audit log collection results

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_full_sync_timestamp (str) – Timestamp of the last full audit log collection
    • +
  • results (list of AuditLog) – Audit log results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.AuditLogRequest(log_age_limit=None, log_filter=None, log_filter_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+LOG_FILTER_TYPE_REGEX = 'REGEX'
+
+ +
+
+LOG_FILTER_TYPE_TEXT = 'TEXT'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.AuthenticationPolicyProperties(links=None, schema=None, self_=None, api_failed_auth_lockout_period=None, api_failed_auth_reset_period=None, api_max_auth_failures=None, cli_failed_auth_lockout_period=None, cli_max_auth_failures=None, minimum_password_length=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Configuration of authentication policies for the NSX node

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • api_failed_auth_lockout_period (long or None) – Once a lockout occurs, the account remains locked out of the API +for this time period. Only applies to NSX Manager nodes. Ignored on +other node types. format: int64
    • +
  • api_failed_auth_reset_period (long or None) – In order to trigger an account lockout, all authentication failures +must occur in this time window. If the reset period expires, the +failed login count is reset to zero. Only applies to NSX Manager +nodes. Ignored on other node types. format: int64
    • +
  • api_max_auth_failures (long or None) – Only applies to NSX Manager nodes. Ignored on other node types. +format: int64
    • +
  • cli_failed_auth_lockout_period (long or None) – Once a lockout occurs, the account remains locked out of the CLI +for this time period. While the lockout period is in effect, +additional authentication attempts restart the lockout period, even +if a valid password is specified. format: int64
    • +
  • cli_max_auth_failures (long or None) – Number of authentication failures that trigger CLI lockout format: +int64
    • +
  • minimum_password_length (long or None) – Minimum number of characters required in account passwords format: +int64
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.AuthenticationScheme(scheme_name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:scheme_name (str) – Authentication scheme name
+
+ +
+
+class com.vmware.nsx.model_client.BFDDiagnosticCount(administratively_down_count=None, concatenated_path_down_count=None, control_detection_time_expired_count=None, echo_function_failed_count=None, forwarding_plane_reset_count=None, neighbor_signaled_session_down_count=None, no_diagnostic_count=None, path_down_count=None, reverse_concatenated_path_down_count=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • administratively_down_count (long or None) – Number of tunnels with administratively down diagnostic message +format: int64
    • +
  • concatenated_path_down_count (long or None) – Number of tunnels with concatenated path down diagnostic message +format: int64
    • +
  • control_detection_time_expired_count (long or None) – Number of tunnels with control detection time expired diagnostic +message format: int64
    • +
  • echo_function_failed_count (long or None) – Number of tunnels with echo function failed diagnostic message +format: int64
    • +
  • forwarding_plane_reset_count (long or None) – Number of tunnels with forwarding plane reset diagnostic message +format: int64
    • +
  • neighbor_signaled_session_down_count (long or None) – Number of tunnels neighbor signaled session down format: int64
    • +
  • no_diagnostic_count (long or None) – Number of tunnels with no diagnostic format: int64
    • +
  • path_down_count (long or None) – Number of tunnels with path down diagnostic message format: int64
    • +
  • reverse_concatenated_path_down_count (long or None) – Number of tunnels with reverse concatenated path down diagnostic +message format: int64
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.BFDProperties(active=None, diagnostic=None, forwarding=None, remote_diagnostic=None, remote_state=None, state=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

BFD information

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • active (bool or None) – True if tunnel is active in a gateway HA setup +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • diagnostic (str or None) – A short message indicating what the BFD session thinks is wrong in +case of a problem +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • forwarding (bool or None) – True if the BFD session believes this interface may be used to +forward traffic +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • remote_diagnostic (str or None) – A short message indicating what the remote interface’s BFD session +thinks is wrong in case of a problem +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • remote_state (str or None) –

    Possible values are:

    + +
    +
    State of the remote interface’s BFD session
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • state (str or None) –

    Possible values are:

    + +
    +
    State of the BFD session
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
+
+
+
+REMOTE_STATE_ADMIN_DOWN = 'ADMIN_DOWN'
+
+ +
+
+REMOTE_STATE_DOWN = 'DOWN'
+
+ +
+
+REMOTE_STATE_INIT = 'INIT'
+
+ +
+
+REMOTE_STATE_UNKNOWN_STATE = 'UNKNOWN_STATE'
+
+ +
+
+REMOTE_STATE_UP = 'UP'
+
+ +
+
+STATE_ADMIN_DOWN = 'ADMIN_DOWN'
+
+ +
+
+STATE_DOWN = 'DOWN'
+
+ +
+
+STATE_INIT = 'INIT'
+
+ +
+
+STATE_UNKNOWN_STATE = 'UNKNOWN_STATE'
+
+ +
+
+STATE_UP = 'UP'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.BFDStatusCount(bfd_admin_down_count=None, bfd_down_count=None, bfd_init_count=None, bfd_up_count=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • bfd_admin_down_count (long or None) – Number of tunnels in BFD admin down state format: int32
    • +
  • bfd_down_count (long or None) – Number of tunnels in BFD down state format: int32
    • +
  • bfd_init_count (long or None) – Number of tunnels in BFD init state format: int32
    • +
  • bfd_up_count (long or None) – Number of tunnels in BFD up state format: int32
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.BGPCommunityList(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, communities=None, community_type=None, logical_router_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • communities (list of str) – Array of BGP communities
    • +
  • community_type (str or None) –

    Possible values are:

    + +

    Specifies the BGP community type. Currently, only +NormalBGPCommunity is supported.

    +
    • +
  • logical_router_id (str or None) – Logical router id +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+
+COMMUNITY_TYPE_NORMALBGPCOMMUNITY = 'NormalBGPCommunity'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.BGPCommunityListListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of BGPCommunityList or None) – Paginated list of bgp community lists
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.BackupConfiguration(backup_enabled=None, backup_schedule=None, inventory_summary_interval=None, passphrase=None, remote_file_server=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Configuration for taking manual/automated backup

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • backup_enabled (bool or None) – true if automated backup is enabled
    • +
  • backup_schedule (vmware.vapi.struct.VapiStruct or None) – Set when backups should be taken - on a weekly schedule or at +regular intervals. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +BackupSchedule. When methods return a value of this class +as a return value, the attribute will contain all the attributes +defined in BackupSchedule.
    • +
  • inventory_summary_interval (long or None) – The minimum number of seconds between each upload of the inventory +summary to backup server. format: int64
    • +
  • passphrase (str or None) – Passphrase used to encrypt backup files.
    • +
  • remote_file_server (RemoteFileServer) – The server to which backups will be sent.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.BackupOperationHistory(cluster_backup_statuses=None, inventory_backup_statuses=None, node_backup_statuses=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Past backup operation details

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • cluster_backup_statuses (list of BackupOperationStatus or None) – Statuses of previous cluser backups
    • +
  • inventory_backup_statuses (list of BackupOperationStatus or None) – Statuses of previous inventory backups
    • +
  • node_backup_statuses (list of BackupOperationStatus or None) – Statuses of previous node backups
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.BackupOperationStatus(backup_id=None, end_time=None, error_code=None, error_message=None, start_time=None, success=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Backup operation status

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+ERROR_CODE_AUTHENTICATION_FAILURE = 'BACKUP_AUTHENTICATION_FAILURE'
+
+ +
+
+ERROR_CODE_BAD_FINGERPRINT = 'BACKUP_BAD_FINGERPRINT'
+
+ +
+
+ERROR_CODE_GENERIC_ERROR = 'BACKUP_GENERIC_ERROR'
+
+ +
+
+ERROR_CODE_NOT_RUN_ON_MASTER = 'BACKUP_NOT_RUN_ON_MASTER'
+
+ +
+
+ERROR_CODE_PERMISSION_ERROR = 'BACKUP_PERMISSION_ERROR'
+
+ +
+
+ERROR_CODE_SERVER_UNREACHABLE = 'BACKUP_SERVER_UNREACHABLE'
+
+ +
+
+ERROR_CODE_TIMEOUT = 'BACKUP_TIMEOUT'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.BackupSchedule(resource_type='BackupSchedule')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Abstract base type for Weekly or Interval Backup Schedule

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:resource_type (str) –

Possible values are:

+ +
+
Schedule type
+
+
+
+RESOURCE_TYPE_INTERVALBACKUPSCHEDULE = 'IntervalBackupSchedule'
+
+ +
+
+RESOURCE_TYPE_WEEKLYBACKUPSCHEDULE = 'WeeklyBackupSchedule'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.BaseHostSwitchProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='BaseHostSwitchProfile', tags=None, required_capabilities=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • required_capabilities (list of str or None) –
    • +
+
+
+
+RESOURCE_TYPE_EXTRACONFIGHOSTSWITCHPROFILE = 'ExtraConfigHostSwitchProfile'
+
+ +
+
+RESOURCE_TYPE_LLDPHOSTSWITCHPROFILE = 'LldpHostSwitchProfile'
+
+ +
+
+RESOURCE_TYPE_NIOCPROFILE = 'NiocProfile'
+
+ +
+
+RESOURCE_TYPE_UPLINKHOSTSWITCHPROFILE = 'UplinkHostSwitchProfile'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.BaseNodeAggregateInfo(display_name=None, id=None, node_interface_properties=None, node_interface_statistics=None, node_status=None, node_status_properties=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • node_interface_properties (list of NodeInterfaceProperties or None) – Array of Node interface statistic properties +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • node_interface_statistics (list of NodeInterfaceStatisticsProperties or None) – Array of Node network interface statistic properties +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • node_status (ClusterNodeStatus or None) –
    • +
  • node_status_properties (list of NodeStatusProperties or None) – Time series of the node’s system properties
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.BaseServiceInstance(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='BaseServiceInstance', tags=None, on_failure_policy=None, service_id=None, transport_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The deployment of a registered service. service instance is instantiation +of service.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +

    ServiceInstance is used when NSX handles the lifecyle of appliance. +Deployment and appliance related all the information is necessary. +ByodServiceInstance is a custom instance to be used when NSX is not +handling the lifecycles of appliance/s. User will manage their own +appliance (BYOD) to connect with NSX. VirtualServiceInstance is a a +custom instance to be used when NSX is not handling the lifecycle +of an appliance and when the user is not bringing their own +appliance.

    +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • on_failure_policy (str or None) –

    Possible values are:

    + +

    Failure policy of the service instance - if it has to be different +from the service. By default the service instance inherits the +FailurePolicy of the service it belongs to.

    +
    • +
  • service_id (str or None) – The Service to which the service instance is associated. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • transport_type (str) –

    Possible values are:

    + +

    Transport to be used by this service instance for deploying the +Service-VM.

    +
    • +
+
+
+
+ON_FAILURE_POLICY_ALLOW = 'ALLOW'
+
+ +
+
+ON_FAILURE_POLICY_BLOCK = 'BLOCK'
+
+ +
+
+RESOURCE_TYPE_BYODSERVICEINSTANCE = 'ByodServiceInstance'
+
+ +
+
+RESOURCE_TYPE_SERVICEINSTANCE = 'ServiceInstance'
+
+ +
+
+RESOURCE_TYPE_VIRTUALSERVICEINSTANCE = 'VirtualServiceInstance'
+
+ +
+
+TRANSPORT_TYPE_L2_BRIDGE = 'L2_BRIDGE'
+
+ +
+
+TRANSPORT_TYPE_L3_ROUTED = 'L3_ROUTED'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.BaseSwitchingProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='BaseSwitchingProfile', tags=None, required_capabilities=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • required_capabilities (list of str or None) –
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.BasicAuthenticationScheme(scheme_name=None, password=None, username=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • scheme_name (str) –

    Possible values are:

    + +
    +
    Authentication scheme name
    +
    • +
  • password (str or None) – Password to authenticate with
    • +
  • username (str) – User name to authenticate with
    • +
+
+
+
+SCHEME_NAME_BASIC = 'basic'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.BatchRequest(continue_on_error=None, requests=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

A set of operations to be performed in a single batch

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • continue_on_error (bool or None) – Flag to decide if we will continue processing subsequent requests +in case of current error for atomic = false.
    • +
  • requests (list of BatchRequestItem or None) –
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.BatchRequestItem(body=None, method=None, uri=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

A single request within a batch of operations

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+METHOD_DELETE = 'DELETE'
+
+ +
+
+METHOD_GET = 'GET'
+
+ +
+
+METHOD_PATCH = 'PATCH'
+
+ +
+
+METHOD_POST = 'POST'
+
+ +
+
+METHOD_PUT = 'PUT'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.BatchResponse(has_errors=None, results=None, rolled_back=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The reponse to a batch operation

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • has_errors (bool or None) – Indicates if any of the APIs failed
    • +
  • results (list of BatchResponseItem) – Bulk list results
    • +
  • rolled_back (bool or None) – Optional flag indicating that all items were rolled back even if +succeeded initially
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.BatchResponseItem(body=None, code=None, headers=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

A single respose in a list of batched responses

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • body (vmware.vapi.struct.VapiStruct or None) – object returned by api
    • +
  • code (long) – http status code format: int64
    • +
  • headers (vmware.vapi.struct.VapiStruct or None) – The headers returned by the API call
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.BfdConfig(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, declare_dead_multiple=None, enabled=None, logical_router_id=None, receive_interval=None, transmit_interval=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

BFD configuration for LogicalRouter

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • declare_dead_multiple (long or None) – Number of times a packet is missed before BFD declares the neighbor +down. format: int64
    • +
  • enabled (bool or None) – Flag to enable BFD for this LogicalRouter
    • +
  • logical_router_id (str or None) – Logical router id +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • receive_interval (long or None) – the time interval (in milliseconds) between heartbeat packets for +BFD when receiving heartbeats. format: int64
    • +
  • transmit_interval (long or None) – the time interval (in milliseconds) between heartbeat packets for +BFD when sending heartbeats. format: int64
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.BfdConfigParameters(declare_dead_multiple=None, receive_interval=None, transmit_interval=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

BFD configuration for the given Peer.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • declare_dead_multiple (long or None) – Number of times a packet is missed before BFD declares the neighbor +down. format: int64
    • +
  • receive_interval (long or None) – the time interval (in milliseconds) between heartbeat packets for +BFD when receiving heartbeats. format: int64
    • +
  • transmit_interval (long or None) – the time interval (in milliseconds) between heartbeat packets for +BFD when sending heartbeats. format: int64
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.BfdHealthMonitoringProfile(enabled=None, probe_interval=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='BfdHealthMonitoringProfile', tags=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Profile for BFD health monitoring

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • enabled (bool) – Whether the heartbeat is enabled. A POST or PUT request with +"enabled" false (with no probe intervals) will set (POST) +or reset (PUT) the probe_interval to their default value.
    • +
  • probe_interval (long or None) – The time interval (in millisec) between probe packets for tunnels +between transport nodes. format: int64
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.BgpConfig(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, as_num=None, as_number=None, ecmp=None, enabled=None, graceful_restart=None, logical_router_id=None, route_aggregation=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • as_num (str or None) – 4 Byte ASN in ASPLAIN/ASDOT Format
    • +
  • as_number (long or None) – This is a deprecated property, Please use ‘as_num’ instead. format: +int64
    • +
  • ecmp (bool or None) – Flag to enable ECMP
    • +
  • enabled (bool or None) – Flag to enable this configuration
    • +
  • graceful_restart (bool or None) – Flag to enable graceful restart
    • +
  • logical_router_id (str or None) – Logical router id +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • route_aggregation (list of BgpRouteAggregation or None) – List of routes to be aggregated
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.BgpNeighbor(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, address_families=None, bfd_config=None, enable_bfd=None, enabled=None, filter_in_ipprefixlist_id=None, filter_in_routemap_id=None, filter_out_ipprefixlist_id=None, filter_out_routemap_id=None, hold_down_timer=None, keep_alive_timer=None, logical_router_id=None, maximum_hop_limit=None, neighbor_address=None, password=None, remote_as=None, remote_as_num=None, source_address=None, source_addresses=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • address_families (list of BgpNeighborAddressFamily or None) – User can enable the neighbor for the specific address families and +also define filters per address family. When the neighbor is +created, it is default enabled for IPV4_UNICAST address family for +backward compatibility reasons. User can change that if required, +by defining the address family configuration.
    • +
  • bfd_config (BfdConfigParameters or None) – By specifying these paramaters BFD config for this given peer can +be overriden | (the globally configured values will not apply for +this peer)
    • +
  • enable_bfd (bool or None) – Flag to enable BFD for this BGP Neighbor. Enable this if the +neighbor supports BFD as this will lead to faster convergence.
    • +
  • enabled (bool or None) – Flag to enable this BGP Neighbor
    • +
  • filter_in_ipprefixlist_id (str or None) – This is a deprecated property, Please use ‘address_family’ instead.
    • +
  • filter_in_routemap_id (str or None) – This is a deprecated property, Please use ‘address_family’ instead.
    • +
  • filter_out_ipprefixlist_id (str or None) – This is a deprecated property, Please use ‘address_family’ instead.
    • +
  • filter_out_routemap_id (str or None) – This is a deprecated property, Please use ‘address_family’ instead.
    • +
  • hold_down_timer (long or None) – Wait period (seconds) before declaring peer dead format: int64
    • +
  • keep_alive_timer (long or None) – Frequency (seconds) with which keep alive messages are sent to +peers format: int64
    • +
  • logical_router_id (str or None) – Logical router id +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • maximum_hop_limit (long or None) – This value is set on TTL(time to live) of BGP header. When router +receives the BGP packet, it decrements the TTL. The default value +of TTL is one when BPG request is initiated.So in the case of a BGP +peer multiple hops away and and value of TTL is one, then next +router in the path will decrement the TTL to 0, realize it cant +forward the packet and will drop it. If the hop count value to +reach neighbor is equal to or less than the maximum_hop_limit value +then intermediate router decrements the TTL count by one and +forwards the request to BGP neighour. If the hop count value is +greater than the maximum_hop_limit value then intermediate router +discards the request when TTL becomes 0. format: int32
    • +
  • neighbor_address (str) – Neighbor IP Address format: ipv4
    • +
  • password (str or None) – User can create (POST) the neighbor with or without the password. +The view (GET) on the neighbor, would never reveal if the password +is set or not. The password can be set later using edit neighbor +workFlow (PUT) On the edit neighbor (PUT), if the user does not +specify the password property, the older value is retained. Maximum +length of this field is 20 characters.
    • +
  • remote_as (long or None) – This is a deprecated property, Please use ‘remote_as_num’ instead. +format: int64
    • +
  • remote_as_num (str or None) – 4 Byte ASN of the neighbor in ASPLAIN/ASDOT Format
    • +
  • source_address (str or None) – Deprecated - do not provide a value for this field. Use +source_addresses instead. format: ipv4
    • +
  • source_addresses (list of str or None) – BGP neighborship will be formed from all these source addresses to +this neighbour. format: ipv4
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.BgpNeighborAddressFamily(enabled=None, in_filter_ipprefixlist_id=None, in_filter_routemap_id=None, out_filter_ipprefixlist_id=None, out_filter_routemap_id=None, type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • enabled (bool or None) – Enable this address family
    • +
  • in_filter_ipprefixlist_id (str or None) – Id of the IPPrefix List to be used for IN direction filter
    • +
  • in_filter_routemap_id (str or None) – Id of the RouteMap to be used for IN direction filter
    • +
  • out_filter_ipprefixlist_id (str or None) – Id of the IPPrefixList to be used for OUT direction filter
    • +
  • out_filter_routemap_id (str or None) – Id of the RouteMap to be used for OUT direction filter
    • +
  • type (str) –

    Possible values are:

    + +
    +
    Address family type
    +
    • +
+
+
+
+TYPE_IPV4_UNICAST = 'IPV4_UNICAST'
+
+ +
+
+TYPE_VPNV4_UNICAST = 'VPNV4_UNICAST'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.BgpNeighborListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of BgpNeighbor) – Paginated list of bgp neighbors
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.BgpNeighborStatus(announced_capabilities=None, connection_drop_count=None, connection_state=None, established_connection_count=None, graceful_restart=None, hold_time=None, keep_alive_interval=None, local_port=None, lr_component_id=None, messages_received=None, messages_sent=None, negotiated_capability=None, neighbor_address=None, neighbor_router_id=None, remote_as_number=None, remote_port=None, source_address=None, time_since_established=None, total_in_prefix_count=None, total_out_prefix_count=None, transport_node=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • announced_capabilities (list of str or None) – BGP capabilities sent to BGP neighbor. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • connection_drop_count (long or None) – Count of connection drop format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • connection_state (str or None) –

    Possible values are:

    + +
    +
    Current state of the BGP session.
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • established_connection_count (long or None) – Count of connections established format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • graceful_restart (bool or None) – Indicate current state of graceful restart where graceful_restart = +true indicate graceful restart is enabled and graceful_restart = +false indicate graceful restart is disabled. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • hold_time (long or None) – Time in ms to wait for HELLO from BGP peer. If a HELLO packet is +not seen from BGP Peer withing hold_time then BGP neighbor will be +marked as down. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • keep_alive_interval (long or None) – Time in ms to wait for HELLO packet from BGP peer format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • local_port (long or None) – TCP port number of Local BGP connection format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • lr_component_id (str or None) – Logical router component(Service Router/Distributed Router) id +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • messages_received (long or None) – Count of messages received from the neighbor format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • messages_sent (long or None) – Count of messages sent to the neighbor format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • negotiated_capability (list of str or None) – BGP capabilities negotiated with BGP neighbor. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • neighbor_address (str or None) – The IP of the BGP neighbor format: ip +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • neighbor_router_id (str or None) – Router ID of the BGP neighbor. format: ip +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • remote_as_number (str or None) – AS number of the BGP neighbor +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • remote_port (long or None) – TCP port number of remote BGP Connection format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • source_address (str or None) – The Ip address of logical port format: ip +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • time_since_established (long or None) – Time(in milliseconds) since connection was established. format: +int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • total_in_prefix_count (long or None) – Count of in prefixes format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • total_out_prefix_count (long or None) – Count of out prefixes format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • transport_node (ResourceReference or None) – Transport node id and name
    • +
+
+
+
+CONNECTION_STATE_ACTIVE = 'ACTIVE'
+
+ +
+
+CONNECTION_STATE_CONNECT = 'CONNECT'
+
+ +
+
+CONNECTION_STATE_ESTABLISHED = 'ESTABLISHED'
+
+ +
+
+CONNECTION_STATE_IDLE = 'IDLE'
+
+ +
+
+CONNECTION_STATE_INVALID = 'INVALID'
+
+ +
+
+CONNECTION_STATE_OPEN_CONFIRM = 'OPEN_CONFIRM'
+
+ +
+
+CONNECTION_STATE_OPEN_SENT = 'OPEN_SENT'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.BgpNeighborsStatusListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, last_update_timestamp=None, logical_router_id=None, logical_router_name=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_update_timestamp (long or None) – Timestamp when the data was last updated, unset if data source has +never updated the data. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • logical_router_id (str or None) – Logical router id +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • logical_router_name (str or None) – Name of the logical router +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of BgpNeighborStatus or None) – Status of BGP neighbors of the logical router +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.BgpRouteAggregation(prefix=None, summary_only=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • prefix (str) – cidr of the aggregate address format: ipv4-cidr-block
    • +
  • summary_only (bool or None) – Flag to send only summarized route
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.BinaryPacketData(frame_size=None, resource_type=None, routed=None, transport_type=None, payload=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+RESOURCE_TYPE_BINARYPACKETDATA = 'BinaryPacketData'
+
+ +
+
+RESOURCE_TYPE_FIELDSPACKETDATA = 'FieldsPacketData'
+
+ +
+
+TRANSPORT_TYPE_BROADCAST = 'BROADCAST'
+
+ +
+
+TRANSPORT_TYPE_MULTICAST = 'MULTICAST'
+
+ +
+
+TRANSPORT_TYPE_UNICAST = 'UNICAST'
+
+ +
+
+TRANSPORT_TYPE_UNKNOWN = 'UNKNOWN'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.BpduFilter(enabled=None, white_list=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

BPDU filter configuration

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • enabled (bool) – Indicates whether BPDU filter is enabled
    • +
  • white_list (list of str or None) – Pre-defined list of allowed MAC addresses to be excluded from BPDU +filtering
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.BridgeCluster(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, bridge_nodes=None, cluster_profile_bindings=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Bridge Cluster

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • bridge_nodes (list of BridgeClusterNode) – Nodes used in bridging
    • +
  • cluster_profile_bindings (list of ClusterProfileTypeIdEntry or None) – Bridge cluster profile bindings
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.BridgeClusterListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Bridge cluster queries result

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of BridgeCluster or None) – BridgeCluster Results +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.BridgeClusterNode(ha_mac=None, transport_node_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Bridge transport node

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • ha_mac (str or None) – MAC address used for HA protocol +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • transport_node_id (str) – UUID of the transport node
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.BridgeClusterStatus(cluster_id=None, health=None, last_update_timestamp=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • cluster_id (str or None) – The id of the cluster +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • health (str or None) –

    Possible values are:

    + +
    +
    The health status of the cluster
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has +never updated the data. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+
+HEALTH_DEGRADED = 'DEGRADED'
+
+ +
+
+HEALTH_DOWN = 'DOWN'
+
+ +
+
+HEALTH_UNKNOWN = 'UNKNOWN'
+
+ +
+
+HEALTH_UP = 'UP'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.BridgeEndpoint(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, bridge_cluster_id=None, bridge_endpoint_profile_id=None, ha_enable=None, vlan=None, vlan_transport_zone_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

A bridge endpoint can be created on a bridge cluster or on an edge cluster. +Few of the properties of this class will not be used depending on the type +of bridge endpoint being created. When creating a bridge endpoint on a +bridge cluster, following propeties will be used: vlan, bridge_cluster_id +and ha_enable. Similarly, for creating a bridge endpoint on an edge cluster +following properties will be used: vlan, bridge_endpoint_profile_id and +vlan_transport_zone_id.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • bridge_cluster_id (str or None) – This field will not be used if an edge cluster is being used for +the bridge endpoint
    • +
  • bridge_endpoint_profile_id (str or None) – This field will not be used if a bridge cluster is being used for +the bridge endpoint
    • +
  • ha_enable (bool or None) – This field will not be used if an edge cluster is being used for +the bridge endpoint
    • +
  • vlan (long) – Virtual Local Area Network Identifier format: int64
    • +
  • vlan_transport_zone_id (str or None) – This field will not be used if a bridge cluster is being used for +the bridge endpoint
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.BridgeEndpointListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Bridge Endpoint queries result

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of BridgeEndpoint or None) – BridgeEndpoint Results +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.BridgeEndpointProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, edge_cluster_id=None, edge_cluster_member_indexes=None, failover_mode=None, high_availability_mode=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Bridge Endpoint Profile

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • edge_cluster_id (str) – UUID of the edge cluster for this bridge endpoint
    • +
  • edge_cluster_member_indexes (list of long or None) – First index will be used as the preferred member format: int32
    • +
  • failover_mode (str or None) –

    Possible values are:

    + +
    +
    Faileover mode can be preemmptive or non-preemptive
    +
    • +
  • high_availability_mode (str or None) –

    Possible values are:

    + +
    +
    High avaialability mode can be active-active or active-standby
    +
    • +
+
+
+
+FAILOVER_MODE_NON_PREEMPTIVE = 'NON_PREEMPTIVE'
+
+ +
+
+FAILOVER_MODE_PREEMPTIVE = 'PREEMPTIVE'
+
+ +
+
+HIGH_AVAILABILITY_MODE_STANDBY = 'ACTIVE_STANDBY'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.BridgeEndpointProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Bridge Endpoint Profile queries result

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of BridgeEndpointProfile or None) – BridgeEndpointProfile Results +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.BridgeEndpointStatistics(rx_bytes=None, rx_packets=None, tx_bytes=None, tx_packets=None, endpoint_id=None, last_update_timestamp=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • rx_bytes (DataCounter or None) –
    • +
  • rx_packets (DataCounter or None) –
    • +
  • tx_bytes (DataCounter or None) –
    • +
  • tx_packets (DataCounter or None) –
    • +
  • endpoint_id (str or None) – The id of the bridge endpoint +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has +never updated the data. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.BridgeEndpointStatus(active_nodes=None, endpoint_id=None, last_update_timestamp=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • active_nodes (list of str or None) – The Ids of the transport nodes which actively serve the endpoint. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • endpoint_id (str or None) – The id of the bridge endpoint +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has +never updated the data. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.BridgeHighAvailabilityClusterProfile(bfd_probe_interval=None, enable=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='BridgeHighAvailabilityClusterProfile', tags=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Profile for BFD HA cluster setting

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • bfd_probe_interval (long or None) – the time interval (in millisec) between probe packets for heartbeat +purpose format: int64
    • +
  • enable (bool or None) – whether the heartbeat is enabled
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ByodServiceInstance(deployment_mode=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ByodServiceInstance', tags=None, on_failure_policy=None, service_id=None, transport_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

ByodServiceInstance is a custom instance to be used when NSX is not +handling the lifecycles of appliance/s. User will manage their own +appliance (BYOD) to connect with NSX.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • deployment_mode (str) –

    Possible values are:

    + +

    Deployment mode specifies where the partner appliance will be +deployed in HA or non-HA i.e standalone mode.

    +
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +

    ServiceInstance is used when NSX handles the lifecyle of appliance. +Deployment and appliance related all the information is necessary. +ByodServiceInstance is a custom instance to be used when NSX is not +handling the lifecycles of appliance/s. User will manage their own +appliance (BYOD) to connect with NSX. VirtualServiceInstance is a a +custom instance to be used when NSX is not handling the lifecycle +of an appliance and when the user is not bringing their own +appliance.

    +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • on_failure_policy (str or None) –

    Possible values are:

    + +

    Failure policy of the service instance - if it has to be different +from the service. By default the service instance inherits the +FailurePolicy of the service it belongs to.

    +
    • +
  • service_id (str or None) – The Service to which the service instance is associated. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • transport_type (str) –

    Possible values are:

    + +

    Transport to be used by this service instance for deploying the +Service-VM.

    +
    • +
+
+
+
+DEPLOYMENT_MODE_ACTIVE_STANDBY = 'ACTIVE_STANDBY'
+
+ +
+
+DEPLOYMENT_MODE_STAND_ALONE = 'STAND_ALONE'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.CCPUpgradeStatus(can_skip=None, component_type=None, details=None, percent_complete=None, status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Status of CCP upgrade

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • can_skip (bool or None) – Can the upgrade of the remaining units in this component be skipped +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • component_type (str or None) – Component type for the upgrade status +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • details (str or None) – Details about the upgrade status +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • percent_complete (float or None) – Indicator of upgrade progress in percentage +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • status (str or None) –

    Possible values are:

    + +
    +
    Upgrade status of component
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
+
+
+
+STATUS_FAILED = 'FAILED'
+
+ +
+
+STATUS_IN_PROGRESS = 'IN_PROGRESS'
+
+ +
+
+STATUS_NOT_STARTED = 'NOT_STARTED'
+
+ +
+
+STATUS_PAUSED = 'PAUSED'
+
+ +
+
+STATUS_SUCCESS = 'SUCCESS'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.CapacityUsage(links=None, schema=None, self_=None, capacity_type=None, usage_count=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

usage of each capacity type ex. vm, cpu

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • capacity_type (str or None) – type of the capacity field +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • usage_count (long or None) – count of number of items of capacity_type format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.Certificate(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, details=None, pem_encoded=None, used_by=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • details (list of X509Certificate or None) – list of X509Certificates +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • pem_encoded (str) – pem encoded certificate data
    • +
  • used_by (list of NodeIdServicesMap or None) – list of node IDs with services, that are using this certificate +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.CertificateList(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Certificate queries result

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of Certificate or None) – Certificate list +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.CipherSuite(enabled=None, name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

HTTP cipher suite

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • enabled (bool) – Enable status for this cipher suite
    • +
  • name (str) – Name of the TLS cipher suite
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ClasslessStaticRoute(network=None, next_hop=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • network (str) – destination in cidr format: address-or-block-or-range
    • +
  • next_hop (str) – router format: ip
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ClientSslProfileBinding(certificate_chain_depth=None, client_auth=None, client_auth_ca_ids=None, client_auth_crl_ids=None, default_certificate_id=None, sni_certificate_ids=None, ssl_profile_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • certificate_chain_depth (long or None) – authentication depth is used to set the verification depth in the +client certificates chain. format: int64
    • +
  • client_auth (str or None) –

    Possible values are:

    + +
    +
    client authentication mode
    +
    • +
  • client_auth_ca_ids (list of str or None) – If client auth type is REQUIRED, client certificate must be signed +by one of the trusted Certificate Authorities (CAs), also referred +to as root CAs, whose self signed certificates are specified.
    • +
  • client_auth_crl_ids (list of str or None) – A Certificate Revocation List (CRL) can be specified in the +client-side SSL profile binding to disallow compromised client +certificates.
    • +
  • default_certificate_id (str) – A default certificate should be specified which will be used if the +server does not host multiple hostnames on the same IP address or +if the client does not support SNI extension.
    • +
  • sni_certificate_ids (list of str or None) – Client-side SSL profile binding allows multiple certificates, for +different hostnames, to be bound to the same virtual server.
    • +
  • ssl_profile_id (str or None) – Client SSL profile defines reusable, application-independent client +side SSL properties.
    • +
+
+
+
+CLIENT_AUTH_IGNORE = 'IGNORE'
+
+ +
+
+CLIENT_AUTH_REQUIRED = 'REQUIRED'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.ClientTypeCollectionConfiguration(client_type=None, data_type_configurations=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

HPM client data collection configuration

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+CLIENT_TYPE_CONTROL_PLANE = 'CONTROL_PLANE'
+
+ +
+
+CLIENT_TYPE_CONTROL_PLANE_PLATFORM = 'CONTROL_PLANE_PLATFORM'
+
+ +
+
+CLIENT_TYPE_EDGE = 'EDGE'
+
+ +
+
+CLIENT_TYPE_HYPERVISOR = 'HYPERVISOR'
+
+ +
+
+CLIENT_TYPE_MANAGEMENT_PLANE = 'MANAGEMENT_PLANE'
+
+ +
+
+CLIENT_TYPE_MANAGEMENT_PLANE_PLATFORM = 'MANAGEMENT_PLANE_PLATFORM'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.ClusterBackupInfo(ip_address=None, node_id=None, timestamp=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Cluster backup details

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • ip_address (str or None) – IP address of the node from which the backup was taken format: ip +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • node_id (str or None) – ID of the node from which the backup was taken +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • timestamp (long or None) – timestamp of the cluster backup file format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ClusterBackupInfoListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of ClusterBackupInfo or None) – List of timestamps of backed-up cluster files +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ClusterConfig(links=None, schema=None, self_=None, revision=None, cluster_id=None, control_cluster_changes_allowed=None, mgmt_cluster_changes_allowed=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • cluster_id (str or None) – Unique identifier of this cluster +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • control_cluster_changes_allowed (bool) – True if control cluster nodes may be added or removed
    • +
  • mgmt_cluster_changes_allowed (bool) – True if management cluster nodes may be added or removed
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ClusterGroupMemberStatus(member_name=None, member_status=None, member_uuid=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This type contains the attributes and status of a group member.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • member_name (str or None) – Name of the group member format: ip +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • member_status (str or None) –

    Possible values are:

    + +
    +
    Status of the group member
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • member_uuid (str or None) – UUID of the group member +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+
+MEMBER_STATUS_DOWN = 'DOWN'
+
+ +
+
+MEMBER_STATUS_UNKNOWN = 'UNKNOWN'
+
+ +
+
+MEMBER_STATUS_UP = 'UP'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.ClusterGroupServiceLeader(leader_uuid=None, lease_version=None, service_name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Each cluster node entity provides multiple services. When working in a +group, each service can elect a cluster node entity to be the leader of the +service. Leader election helps in coordination of the service. The leader +holds a renewable lease on the leadership for a fixed period of time. The +lease version is incremented every time the leadership lease is renewed. +This type contains the attributes of a leader.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • leader_uuid (str or None) – Member UUID of the leader +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • lease_version (long or None) – Number of times the lease has been renewed format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • service_name (str or None) – Name of the service +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ClusterGroupStatus(group_id=None, group_status=None, group_type=None, leaders=None, members=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This type contains the attributes and status of a group.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+GROUP_STATUS_DEGRADED = 'DEGRADED'
+
+ +
+
+GROUP_STATUS_STABLE = 'STABLE'
+
+ +
+
+GROUP_STATUS_UNAVAILABLE = 'UNAVAILABLE'
+
+ +
+
+GROUP_STATUS_UNSTABLE = 'UNSTABLE'
+
+ +
+
+GROUP_TYPE_CONTROLLER = 'CONTROLLER'
+
+ +
+
+GROUP_TYPE_HTTP = 'HTTP'
+
+ +
+
+GROUP_TYPE_MANAGER = 'MANAGER'
+
+ +
+
+GROUP_TYPE_POLICY = 'POLICY'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.ClusterInitializationNodeInfo(disk_store_id=None, host_address=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The type provides the information of a non-running cluster node required +for the initialization of a management cluster. The administrator needs to +start this node for management cluster to initialize properly (or +decommission it explicitly).

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • disk_store_id (str or None) – The (internal) disk-store ID of the member +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • host_address (str or None) – The IP address (or domain name) of the cluster node +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ClusterNodeConfig(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, appliance_mgmt_listen_addr=None, controller_role=None, external_id=None, manager_role=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • appliance_mgmt_listen_addr (str or None) – The IP and port for the appliance management API service on this +node +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • controller_role (ControllerClusterRoleConfig or None) –
    • +
  • external_id (str or None) – Internal identifier provided by the node +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • manager_role (ManagementClusterRoleConfig or None) –
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ClusterNodeConfigListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of ClusterNodeConfig) – Cluster node configuration results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ClusterNodeStatus(control_cluster_status=None, mgmt_cluster_status=None, system_status=None, version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • control_cluster_status (ControlClusterNodeStatus or None) – Clustering status for control plane functions on this node
    • +
  • mgmt_cluster_status (ManagementClusterNodeStatus or None) – Clustering status for management plane functions on this node
    • +
  • system_status (NodeStatusProperties or None) – Node status properties
    • +
  • version (str or None) – Software version running on node +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ClusterNodeVMDeploymentConfig(placement_type='ClusterNodeVMDeploymentConfig')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Contains info used to configure the VM on deployment

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:placement_type (str) –

Possible values are:

+ +

Specifies the config for the platform through which to deploy the +VM

+
+
+
+PLACEMENT_TYPE_VSPHERECLUSTERNODEVMDEPLOYMENTCONFIG = 'VsphereClusterNodeVMDeploymentConfig'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.ClusterNodeVMDeploymentRequest(deployment_config=None, form_factor=None, roles=None, user_settings=None, vm_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Contains the deployment information for a cluster node VM soon to be +deployed or already deployed by the Manager

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+FORM_FACTOR_LARGE = 'LARGE'
+
+ +
+
+FORM_FACTOR_MEDIUM = 'MEDIUM'
+
+ +
+
+FORM_FACTOR_MEDIUM_LARGE = 'MEDIUM_LARGE'
+
+ +
+
+FORM_FACTOR_SMALL = 'SMALL'
+
+ +
+
+ROLES_CONTROLLER = 'CONTROLLER'
+
+ +
+
+ROLES_MANAGER = 'MANAGER'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.ClusterNodeVMDeploymentRequestList(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

List of ClusterNodeVMDeploymentRequests

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of ClusterNodeVMDeploymentRequest) – Array of existing ClusterNodeVMDeploymentRequests
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ClusterNodeVMDeploymentStatusReport(failure_code=None, failure_message=None, status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Contains up-to-date information relating to an auto-deployed VM, including +its status and (potentially) an error message.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+STATUS_UNKNOWN_STATE = 'UNKNOWN_STATE'
+
+ +
+
+STATUS_VM_CLUSTERING_FAILED = 'VM_CLUSTERING_FAILED'
+
+ +
+
+STATUS_VM_CLUSTERING_IN_PROGRESS = 'VM_CLUSTERING_IN_PROGRESS'
+
+ +
+
+STATUS_VM_CLUSTERING_SUCCESSFUL = 'VM_CLUSTERING_SUCCESSFUL'
+
+ +
+
+STATUS_VM_DECLUSTER_FAILED = 'VM_DECLUSTER_FAILED'
+
+ +
+
+STATUS_VM_DECLUSTER_IN_PROGRESS = 'VM_DECLUSTER_IN_PROGRESS'
+
+ +
+
+STATUS_VM_DECLUSTER_SUCCESSFUL = 'VM_DECLUSTER_SUCCESSFUL'
+
+ +
+
+STATUS_VM_DEPLOYMENT_FAILED = 'VM_DEPLOYMENT_FAILED'
+
+ +
+
+STATUS_VM_DEPLOYMENT_IN_PROGRESS = 'VM_DEPLOYMENT_IN_PROGRESS'
+
+ +
+
+STATUS_VM_DEPLOYMENT_QUEUED = 'VM_DEPLOYMENT_QUEUED'
+
+ +
+
+STATUS_VM_ONLINE_FAILED = 'VM_ONLINE_FAILED'
+
+ +
+
+STATUS_VM_POWER_OFF_FAILED = 'VM_POWER_OFF_FAILED'
+
+ +
+
+STATUS_VM_POWER_OFF_IN_PROGRESS = 'VM_POWER_OFF_IN_PROGRESS'
+
+ +
+
+STATUS_VM_POWER_ON_FAILED = 'VM_POWER_ON_FAILED'
+
+ +
+
+STATUS_VM_POWER_ON_IN_PROGRESS = 'VM_POWER_ON_IN_PROGRESS'
+
+ +
+
+STATUS_VM_UNDEPLOY_FAILED = 'VM_UNDEPLOY_FAILED'
+
+ +
+
+STATUS_VM_UNDEPLOY_IN_PROGRESS = 'VM_UNDEPLOY_IN_PROGRESS'
+
+ +
+
+STATUS_VM_UNDEPLOY_SUCCESSFUL = 'VM_UNDEPLOY_SUCCESSFUL'
+
+ +
+
+STATUS_VM_WAITING_TO_CLUSTER = 'VM_WAITING_TO_CLUSTER'
+
+ +
+
+STATUS_VM_WAITING_TO_COME_ONLINE = 'VM_WAITING_TO_COME_ONLINE'
+
+ +
+
+STATUS_WAITING_TO_REGISTER_VM = 'WAITING_TO_REGISTER_VM'
+
+ +
+
+STATUS_WAITING_TO_UNDEPLOY_VM = 'WAITING_TO_UNDEPLOY_VM'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.ClusterProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ClusterProfile', tags=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
+
+
+
+RESOURCE_TYPE_BRIDGEHIGHAVAILABILITYCLUSTERPROFILE = 'BridgeHighAvailabilityClusterProfile'
+
+ +
+
+RESOURCE_TYPE_EDGEHIGHAVAILABILITYPROFILE = 'EdgeHighAvailabilityProfile'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.ClusterProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Cluster Profile queries result

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of vmware.vapi.struct.VapiStruct or None) – Cluster Profile Results +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +ClusterProfile. When methods return a value of this class +as a return value, the attribute will contain all the attributes +defined in ClusterProfile. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ClusterProfileTypeIdEntry(profile_id=None, resource_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+RESOURCE_TYPE_BRIDGEHIGHAVAILABILITYCLUSTERPROFILE = 'BridgeHighAvailabilityClusterProfile'
+
+ +
+
+RESOURCE_TYPE_EDGEHIGHAVAILABILITYPROFILE = 'EdgeHighAvailabilityProfile'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.ClusterRestoreStatus(backup_timestamp=None, endpoints=None, id=None, instructions=None, restore_end_time=None, restore_start_time=None, status=None, step=None, total_steps=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Cluster restore status

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • backup_timestamp (long or None) – Timestamp when backup was initiated in epoch millisecond format: +int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • endpoints (list of ResourceLink or None) – The list of allowed endpoints, based on the current state of the +restore process +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • id (str or None) – Unique id for backup request +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • instructions (list of InstructionInfo or None) – Instructions for users to reconcile Restore operations +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • restore_end_time (long or None) – Timestamp when restore was completed in epoch millisecond format: +int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • restore_start_time (long or None) – Timestamp when restore was started in epoch millisecond format: +int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • status (GlobalRestoreStatus or None) –
    • +
  • step (RestoreStep or None) –
    • +
  • total_steps (long or None) – Total number of steps in the entire restore process format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ClusterRoleConfig(type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:type (str or None) –

Possible values are:

+ +
+
Type of this role configuration
+

This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

+
+
+
+TYPE_CONTROLLERCLUSTERROLECONFIG = 'ControllerClusterRoleConfig'
+
+ +
+
+TYPE_MANAGEMENTCLUSTERROLECONFIG = 'ManagementClusterRoleConfig'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.ClusterStatus(cluster_id=None, control_cluster_status=None, mgmt_cluster_status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • cluster_id (str or None) – Unique identifier of this cluster +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • control_cluster_status (ControllerClusterStatus or None) – The current status of the control cluster
    • +
  • mgmt_cluster_status (ManagementClusterStatus or None) – The current status of the management cluster
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ClusteringConfig(clustering_type='ClusteringConfig')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Configuration for automatically joining a cluster node to the cluster after +it is deployed. ClusteringConfig is required if any of the deployment nodes +has CONTROLLER role.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:clustering_type (str) –

Possible values are:

+ +
+
Specifies the type of clustering config to be used.
+
+
+
+CLUSTERING_TYPE_CONTROLCLUSTERINGCONFIG = 'ControlClusteringConfig'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.ClusteringInfo(join_to_existing_cluster=None, shared_secret=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Clustering parameters for the controller cluster

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • join_to_existing_cluster (bool) – Property to indicate if the node must join an existing cluster.
    • +
  • shared_secret (str or None) – Shared secret of the cluster.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ClustersAggregateInfo(cluster_status=None, controller_cluster=None, management_cluster=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+ +
+
+class com.vmware.nsx.model_client.ColumnItem(column_identifier=None, drilldown_id=None, field=None, hidden=None, label=None, navigation=None, render_configuration=None, sort_ascending=None, sort_key=None, tooltip=None, type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Represents a column of the Grid

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • column_identifier (str or None) – Identifies the column and used for fetching content upon an user +click or drilldown. If column identifier is not provided, the +column’s data will not participate in searches and drilldowns.
    • +
  • drilldown_id (str or None) – Id of drilldown widget, if any. Id should be a valid id of an +existing widget.
    • +
  • field (str) – Field from which values of the column will be derived.
    • +
  • hidden (bool or None) – If set to true, hides the column
    • +
  • label (Label) – Label of the column.
    • +
  • navigation (str or None) – Hyperlink of the specified UI page that provides details. If +drilldown_id is provided, then navigation cannot be used.
    • +
  • render_configuration (list of RenderConfiguration or None) – Render configuration to be applied, if any.
    • +
  • sort_ascending (bool or None) – If true, the value of the column are sorted in ascending order. +Otherwise, in descending order.
    • +
  • sort_key (str or None) – Sorting on column is based on the sort_key. sort_key represents the +field in the output data on which sort is requested.
    • +
  • tooltip (list of Tooltip or None) – Multi-line text to be shown on tooltip while hovering over a cell +in the grid.
    • +
  • type (str) –

    Possible values are:

    + +
    +
    Data type of the field.
    +
    • +
+
+
+
+TYPE_DATE = 'Date'
+
+ +
+
+TYPE_NUMBER = 'Number'
+
+ +
+
+TYPE_STRING = 'String'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.CommunityMatchExpression(expression=None, operator=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Community match expression

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • expression (list of CommunityMatchOperation) – Array of community match operations
    • +
  • operator (str or None) –

    Possible values are:

    + +

    Operator for evaluating community match expressions. AND logical +AND operator +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
+
+
+
+OPERATOR_AND = 'AND'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.CommunityMatchOperation(community_list_id=None, match_operator=None, regular_expression=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Community match operation

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+MATCH_OPERATOR_ALL = 'MATCH_ALL'
+
+ +
+
+MATCH_OPERATOR_ANY = 'MATCH_ANY'
+
+ +
+
+MATCH_OPERATOR_EXACT = 'MATCH_EXACT'
+
+ +
+
+MATCH_OPERATOR_NONE = 'MATCH_NONE'
+
+ +
+
+MATCH_OPERATOR_REGEX = 'MATCH_REGEX'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.ComponentMigrationStatus(can_skip=None, component_type=None, details=None, percent_complete=None, status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • can_skip (bool or None) – Can the migration of the remaining units in this component be +skipped +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • component_type (str or None) – Component type for the migration status +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • details (str or None) – Details about the migration status +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • percent_complete (float or None) – Indicator of migration progress in percentage +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • status (str or None) –

    Possible values are:

    + +
    +
    Migration status of component
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
+
+
+
+STATUS_FAILED = 'FAILED'
+
+ +
+
+STATUS_IN_PROGRESS = 'IN_PROGRESS'
+
+ +
+
+STATUS_NOT_STARTED = 'NOT_STARTED'
+
+ +
+
+STATUS_PAUSED = 'PAUSED'
+
+ +
+
+STATUS_SUCCESS = 'SUCCESS'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.ComponentTargetVersion(component_type=None, target_version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • component_type (str or None) –
    • +
  • target_version (str or None) –
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ComponentUpgradeStatus(can_skip=None, component_type=None, details=None, percent_complete=None, status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • can_skip (bool or None) – Can the upgrade of the remaining units in this component be skipped +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • component_type (str or None) – Component type for the upgrade status +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • details (str or None) – Details about the upgrade status +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • percent_complete (float or None) – Indicator of upgrade progress in percentage +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • status (str or None) –

    Possible values are:

    + +
    +
    Upgrade status of component
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
+
+
+
+STATUS_FAILED = 'FAILED'
+
+ +
+
+STATUS_IN_PROGRESS = 'IN_PROGRESS'
+
+ +
+
+STATUS_NOT_STARTED = 'NOT_STARTED'
+
+ +
+
+STATUS_PAUSED = 'PAUSED'
+
+ +
+
+STATUS_SUCCESS = 'SUCCESS'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.ComputeCollection(links=None, schema=None, self_=None, last_sync_time=None, description=None, display_name=None, resource_type=None, tags=None, cm_local_id=None, external_id=None, origin_id=None, origin_properties=None, origin_type=None, owner_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • last_sync_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • cm_local_id (str or None) – Local Id of the compute collection in the Compute Manager +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • external_id (str or None) – External ID of the ComputeCollection in the source Compute manager, +e.g. mo-ref in VC +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • origin_id (str or None) – Id of the compute manager from where this Compute Collection was +discovered +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • origin_properties (list of KeyValuePair or None) – Key-Value map of additional specific properties of compute +collection in the Compute Manager +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • origin_type (str or None) – ComputeCollection type like VC_Cluster. Here the Compute Manager +type prefix would help in differentiating similar named Compute +Collection types from different Compute Managers +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • owner_id (str or None) – Id of the owner of compute collection in the Compute Manager +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ComputeCollectionFabricTemplate(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, auto_install_nsx=None, compute_collection_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Compute collection fabric template

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • auto_install_nsx (bool) – Indicates whether NSX components should be automcatically +installed. When ‘true’ NSX components will be automatically +installed on the new host added to compute collection.
    • +
  • compute_collection_id (str) – Associated compute collection id
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ComputeCollectionFabricTemplateListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

List of compute collection fabric template

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of ComputeCollectionFabricTemplate or None) – List of compute collection fabric template +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ComputeCollectionListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Compute Collection list result

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of ComputeCollection) – Compute Collection list results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ComputeCollectionNetworkInterfacesListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

List of network interfaces for all discovered nodes in compute collection

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of DiscoveredNodeNetworkInterfaces) – List of discovered node with network interfaces
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ComputeCollectionTransportNodeTemplate(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, compute_collection_ids=None, host_switch_spec=None, network_migration_spec_ids=None, transport_zone_endpoints=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Compute collection transport node template

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • compute_collection_ids (list of str) – Associated compute collection ids
    • +
  • host_switch_spec (vmware.vapi.struct.VapiStruct or None) – Property ‘host_switch_spec’ can be used to create either standard +host switch or preconfigured host switch. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +HostSwitchSpec. When methods return a value of this class +as a return value, the attribute will contain all the attributes +defined in HostSwitchSpec.
    • +
  • network_migration_spec_ids (list of NetworkMigrationSpecTypeIdEntry or None) – Property ‘network_migration_spec_ids’ should only be used for +compute collections which are clusters in VMware vCenter. Currently +only HostProfileNetworkMigrationSpec type is supported. This +specification will only apply to Stateless ESX hosts which are +under this vCenter cluster.
    • +
  • transport_zone_endpoints (list of TransportZoneEndPoint or None) – Transport zone endpoints
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ComputeCollectionTransportNodeTemplateState(compute_collection_id=None, template_states=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Transport node state per compute collection

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • compute_collection_id (str or None) – Associated compute collection id +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • template_states (list of TransportNodeTemplateState or None) – Transport node template states in compute collection +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ComputeCollectionTransportNodeTemplateStateList(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Transport node creation state list

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of ComputeCollectionTransportNodeTemplateState or None) – State list per compute collection +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ComputeManager(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, credential=None, origin_properties=None, origin_type=None, server=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • credential (vmware.vapi.struct.VapiStruct or None) – Login credentials for the compute manager +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +LoginCredential. When methods return a value of this class +as a return value, the attribute will contain all the attributes +defined in LoginCredential.
    • +
  • origin_properties (list of KeyValuePair or None) – Key-Value map of additional specific properties of compute manager +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • origin_type (str) – Compute manager type like vCenter
    • +
  • server (str) – IP address or hostname of compute manager format: hostname-or-ip
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ComputeManagerListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

List of compute managers

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of ComputeManager) – List of compute managers
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ComputeManagerStatus(connection_errors=None, connection_status=None, connection_status_details=None, last_sync_time=None, registration_errors=None, registration_status=None, version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Runtime status information of the compute manager

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • connection_errors (list of ErrorInfo or None) – Errors when connecting with compute manager +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • connection_status (str or None) –

    Possible values are:

    + +
    +
    Status of connection with the compute manager
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • connection_status_details (str or None) – Details about connection status +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_sync_time (long or None) – Timestamp of the last successful update of Inventory, in epoch +milliseconds. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • registration_errors (list of ErrorInfo or None) – Errors when registering with compute manager +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • registration_status (str or None) –

    Possible values are:

    + +
    +
    Registration status of compute manager
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • version (str or None) – Version of the compute manager +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+
+CONNECTION_STATUS_CONNECTING = 'CONNECTING'
+
+ +
+
+CONNECTION_STATUS_DOWN = 'DOWN'
+
+ +
+
+CONNECTION_STATUS_UP = 'UP'
+
+ +
+
+REGISTRATION_STATUS_REGISTERED = 'REGISTERED'
+
+ +
+
+REGISTRATION_STATUS_REGISTERING = 'REGISTERING'
+
+ +
+
+REGISTRATION_STATUS_UNREGISTERED = 'UNREGISTERED'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.ConditionalForwarderZone(source_ip=None, upstream_servers=None, domain_names=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • source_ip (str or None) – The source ip used by the fowarder of the zone. If no source ip +specified, the ip address of listener of the dns forwarder will be +used. format: ipv4
    • +
  • upstream_servers (list of str) – Ip address of the upstream dns servers the dns forwarder accesses. +format: ipv4
    • +
  • domain_names (list of str) – A forwarder domain name should be a valid FQDN. If reverse lookup +is needed for this zone, reverse lookup domain name like +X.in-addr.arpa can be defined. Here the X represents a subnet.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ConfigurationState(details=None, failure_code=None, failure_message=None, state=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Describes status of configuration of an entity

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+STATE_FAILED = 'failed'
+
+ +
+
+STATE_IN_PROGRESS = 'in_progress'
+
+ +
+
+STATE_ORPHANED = 'orphaned'
+
+ +
+
+STATE_PARTIAL_SUCCESS = 'partial_success'
+
+ +
+
+STATE_PENDING = 'pending'
+
+ +
+
+STATE_SUCCESS = 'success'
+
+ +
+
+STATE_UNKNOWN = 'unknown'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.ConfigurationStateElement(failure_code=None, failure_message=None, state=None, sub_system_address=None, sub_system_id=None, sub_system_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Describes status of configuration of an entity

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • failure_code (long or None) – Error code format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • failure_message (str or None) – Error message in case of failure +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • state (str or None) –

    Possible values are:

    + +
    +
    State of configuration on this sub system
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • sub_system_address (str or None) – URI of backing resource on sub system +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sub_system_id (str or None) – Identifier of backing resource on sub system +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sub_system_type (str or None) – Type of backing resource on sub system +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+
+STATE_FAILED = 'failed'
+
+ +
+
+STATE_IN_PROGRESS = 'in_progress'
+
+ +
+
+STATE_PARTIAL_SUCCESS = 'partial_success'
+
+ +
+
+STATE_SUCCESS = 'success'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.ContainerConfiguration(labels=None, navigation=None, span=None, widgets=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ContainerConfiguration', tags=None, datasources=None, drilldown_id=None, footer=None, is_drilldown=None, shared=None, weight=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Represents a container to group widgets that belong to a common category or +have a common purpose.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • labels (list of Label or None) – Labels for the container.
    • +
  • navigation (str or None) – Hyperlink of the specified UI page that provides details.
    • +
  • span (long or None) – Represents the horizontal span of the container. format: int32
    • +
  • widgets (list of WidgetItem or None) – If not specified, creates an empty container.
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str) – Title of the widget.
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +

    Supported visualization types are LabelValueConfiguration, +DonutConfiguration, GridConfiguration, StatsConfiguration, +MultiWidgetConfiguration and ContainerConfiguration.

    +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • datasources (list of Datasource or None) – The ‘datasources’ represent the sources from which data will be +fetched. Currently, only NSX-API is supported as a ‘default’ +datasource. An example of specifying ‘default’ datasource along +with the urls to fetch data from is given at ‘example_request’ +section of ‘CreateWidgetConfiguration’ API.
    • +
  • drilldown_id (str or None) – Id of drilldown widget, if any. Id should be a valid id of an +existing widget. A widget is considered as drilldown widget when it +is associated with any other widget and provides more detailed +information about any data item from the parent widget.
    • +
  • footer (Footer or None) –
    • +
  • is_drilldown (bool or None) – Set to true if this widget should be used as a drilldown.
    • +
  • shared (bool or None) – Please use the property ‘shared’ of View instead of this. The +widgets of a shared view are visible to other users.
    • +
  • weight (long or None) – Specify relavite weight in WidgetItem for placement in a view. +Please see WidgetItem for details. format: int32
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ControlClusterNodeStatus(control_cluster_status=None, mgmt_connection_status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+CONTROL_CLUSTER_STATUS_CONNECTED = 'CONNECTED'
+
+ +
+
+CONTROL_CLUSTER_STATUS_DISCONNECTED = 'DISCONNECTED'
+
+ +
+
+CONTROL_CLUSTER_STATUS_UNKNOWN = 'UNKNOWN'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.ControlClusteringConfig(join_to_existing_cluster=None, shared_secret=None, clustering_type='ControlClusteringConfig')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Config for joining cluster nodes VMs to a control cluster

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • join_to_existing_cluster (bool or None) – Specifies whether or not the cluster node VM should try to join to +the existing control cluster or initialize a new one. Only required +in uncertainty case, i.e. when there are manually- deployed +controllers that are registered but not connected to the cluster +and no auto-deployed controllers are part of the cluster.
    • +
  • shared_secret (str or None) – Shared secret to be used when joining the cluster node VM to a +control cluster or for initializing a new cluster with the VM. Must +contain at least 4 unique characters and be at least 6 characters +long.
    • +
  • clustering_type (str) –

    Possible values are:

    + +
    +
    Specifies the type of clustering config to be used.
    +
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ControlConnStatus(control_node_ip=None, failure_status=None, status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+FAILURE_STATUS_CONNECTION_REFUSED = 'CONNECTION_REFUSED'
+
+ +
+
+FAILURE_STATUS_CONTROLLER_REJECTED_HOST_CERT = 'CONTROLLER_REJECTED_HOST_CERT'
+
+ +
+
+FAILURE_STATUS_HOST_REJECTED_CONTROLLER_CERT = 'HOST_REJECTED_CONTROLLER_CERT'
+
+ +
+
+FAILURE_STATUS_INCOMPLETE_CONTROLLER_CERT = 'INCOMPLETE_CONTROLLER_CERT'
+
+ +
+
+FAILURE_STATUS_INCOMPLETE_HOST_CERT = 'INCOMPLETE_HOST_CERT'
+
+ +
+
+FAILURE_STATUS_KEEP_ALIVE_TIMEOUT = 'KEEP_ALIVE_TIMEOUT'
+
+ +
+
+FAILURE_STATUS_OTHER_ERROR = 'OTHER_ERROR'
+
+ +
+
+FAILURE_STATUS_OTHER_SSL_ERROR = 'OTHER_SSL_ERROR'
+
+ +
+
+STATUS_DOWN = 'DOWN'
+
+ +
+
+STATUS_UP = 'UP'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.ControllerClusterRoleConfig(type=None, control_cluster_listen_addr=None, control_plane_listen_addr=None, host_msg_client_info=None, mpa_msg_client_info=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+TYPE_CONTROLLERCLUSTERROLECONFIG = 'ControllerClusterRoleConfig'
+
+ +
+
+TYPE_MANAGEMENTCLUSTERROLECONFIG = 'ManagementClusterRoleConfig'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.ControllerClusterStatus(status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:status (str or None) –

Possible values are:

+ +
+
The current status of the controller cluster
+

This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

+
+
+
+STATUS_STABLE = 'STABLE'
+
+ +
+
+STATUS_UNKNOWN = 'UNKNOWN'
+
+ +
+
+STATUS_UNSTABLE = 'UNSTABLE'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.ControllerNodeAggregateInfo(display_name=None, id=None, node_interface_properties=None, node_interface_statistics=None, node_status=None, node_status_properties=None, role_config=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • node_interface_properties (list of NodeInterfaceProperties or None) – Array of Node interface statistic properties +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • node_interface_statistics (list of NodeInterfaceStatisticsProperties or None) – Array of Node network interface statistic properties +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • node_status (ClusterNodeStatus or None) –
    • +
  • node_status_properties (list of NodeStatusProperties or None) – Time series of the node’s system properties
    • +
  • role_config (ControllerClusterRoleConfig or None) –
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.CopyFromRemoteFileProperties(port=None, server=None, uri=None, protocol=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • port (long or None) – Server port format: int64
    • +
  • server (str) – Remote server hostname or IP address
    • +
  • uri (str) – URI of file to copy
    • +
  • protocol (vmware.vapi.struct.VapiStruct) – Protocol to use to copy file +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +Protocol. When methods return a value of this class as a +return value, the attribute will contain all the attributes defined +in Protocol.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.CopyRemoteFileProperties(port=None, server=None, uri=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • port (long or None) – Server port format: int64
    • +
  • server (str) – Remote server hostname or IP address
    • +
  • uri (str) – URI of file to copy
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.CopyToRemoteFileProperties(port=None, server=None, uri=None, protocol=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • port (long or None) – Server port format: int64
    • +
  • server (str) – Remote server hostname or IP address
    • +
  • uri (str) – URI of file to copy
    • +
  • protocol (vmware.vapi.struct.VapiStruct) – Only scp and sftp may be used. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +Protocol. When methods return a value of this class as a +return value, the attribute will contain all the attributes defined +in Protocol.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.CpuCoreConfigForEnhancedNetworkingStackSwitch(num_lcores=None, numa_node_index=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Non Uniform Memory Access (NUMA) nodes and Logical cpu cores (Lcores) per +NUMA node configuration for Enhanced Networking Stack enabled HostSwitch.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • num_lcores (long) – Number of Logical cpu cores (Lcores) to be placed on a specified +NUMA node format: int32
    • +
  • numa_node_index (long) – Unique index of the Non Uniform Memory Access (NUMA) node format: +int32
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.CreateRemoteDirectoryProperties(port=None, server=None, uri=None, protocol=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • port (long or None) – Server port format: int64
    • +
  • server (str) – Remote server hostname or IP address
    • +
  • uri (str) – URI of file to copy
    • +
  • protocol (SftpProtocol) – Protocol to use to copy file
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.Crl(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, details=None, pem_encoded=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • details (X509Crl or None) – details of the X509Crl object
    • +
  • pem_encoded (str) – pem encoded crl data
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.CrlList(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Crl queries result

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of Crl or None) – CRL list +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.CrlObjectData(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, pem_encoded=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • pem_encoded (str) – pem encoded crl data
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.CryptoAlgorithm(key_size=None, name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • key_size (list of long or None) – supported key sizes for the algorithm format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • name (str or None) – crypto algorithm name +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.Csr(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, algorithm=None, key_size=None, pem_encoded=None, subject=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • algorithm (str) –

    Possible values are:

    + +

    Cryptographic algorithm(asymmetric ) used by the public key for +data encryption

    +
    • +
  • key_size (long) – size measured in bits of the public key used in a cryptographic +algorithm format: int64
    • +
  • pem_encoded (str or None) – pem encoded certificate data +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • subject (Principal) – the certificate owner’s information (CN, O, OU, C, ST, L)
    • +
+
+
+
+ALGORITHM_DSA = 'DSA'
+
+ +
+
+ALGORITHM_RSA = 'RSA'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.CsrList(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Csr queries result

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of Csr) – CSR list
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.CsvListResult(file_name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Base type for CSV result.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:file_name (str or None) – File name set by HTTP server if API returns CSV result as a file.
+
+ +
+
+class com.vmware.nsx.model_client.CsvRecord
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Base type for CSV records.

+
+

Tip

+

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

+
+
+ +
+
+class com.vmware.nsx.model_client.CurrentBackupOperationStatus(backup_id=None, current_step=None, current_step_message=None, end_time=None, operation_type=None, start_time=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Current backup operation status

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+CURRENT_STEP_CLUSTER_BACKUP = 'BACKUP_CREATING_CLUSTER_BACKUP'
+
+ +
+
+CURRENT_STEP_NODE_BACKUP = 'BACKUP_CREATING_NODE_BACKUP'
+
+ +
+
+OPERATION_TYPE_BACKUP = 'BACKUP'
+
+ +
+
+OPERATION_TYPE_NONE = 'NONE'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.CurrentRealizationStateBarrier(current_barrier_number=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The current global barrier number of the realized state

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:current_barrier_number (long or None) – Gives the current global barrier number for NSX format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
+
+ +
+
+class com.vmware.nsx.model_client.DSInsertParameters(id=None, operation=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Parameters to tell where rule/section need to be added. All the params take +rule/section Id.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+OPERATION_AFTER = 'insert_after'
+
+ +
+
+OPERATION_BEFORE = 'insert_before'
+
+ +
+
+OPERATION_BOTTOM = 'insert_bottom'
+
+ +
+
+OPERATION_TOP = 'insert_top'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.DSRule(links=None, schema=None, self_=None, revision=None, owner=None, description=None, display_name=None, id=None, resource_type=None, action=None, applied_tos=None, destinations=None, destinations_excluded=None, direction=None, disabled=None, ip_protocol=None, is_default=None, logged=None, notes=None, rule_tag=None, services=None, sources=None, sources_excluded=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • owner (OwnerResourceLink or None) – Owner of this resource
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Identifier of the resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • action (str) –

    Possible values are:

    + +

    Action enforced on the packets which matches the distributed +service rule. Currently DS Layer supports below actions. ALLOW - +Forward any packet when a rule with this action gets a match (Used +by Firewall). DROP - Drop any packet when a rule with this action +gets a match. Packets won’t go further(Used by Firewall). REJECT - +Terminate TCP connection by sending TCP reset for a packet when a +rule with this action gets a match (Used by Firewall). REDIRECT - +Redirect any packet to a partner appliance when a rule with this +action gets a match (Used by Service Insertion). DO_NOT_REDIRECT - +Do not redirect any packet to a partner appliance when a rule with +this action gets a match (Used by Service Insertion).

    +
    • +
  • applied_tos (list of ResourceReference or None) – List of object where rule will be enforced. The section level field +overrides this one. Null will be treated as any.
    • +
  • destinations (list of ResourceReference or None) – List of the destinations. Null will be treated as any.
    • +
  • destinations_excluded (bool or None) – Negation of the destination.
    • +
  • direction (str or None) –

    Possible values are:

    + +

    Rule direction in case of stateless distributed service rules. This +will only considered if section level parameter is set to +stateless. Default to IN_OUT if not specified.

    +
    • +
  • disabled (bool or None) – Flag to disable rule. Disabled will only be persisted but never +provisioned/realized.
    • +
  • ip_protocol (str or None) –

    Possible values are:

    + +
    +
    Type of IP packet that should be matched while enforcing the rule.
    +
    • +
  • is_default (bool or None) – Flag to indicate whether rule is default. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • logged (bool or None) – Flag to enable packet logging. Default is disabled.
    • +
  • notes (str or None) – User notes specific to the rule.
    • +
  • rule_tag (str or None) – User level field which will be printed in CLI and packet logs.
    • +
  • services (list of DSService or None) – List of the services. Null will be treated as any.
    • +
  • sources (list of ResourceReference or None) – List of sources. Null will be treated as any.
    • +
  • sources_excluded (bool or None) – Negation of the source.
    • +
+
+
+
+ACTION_ALLOW = 'ALLOW'
+
+ +
+
+ACTION_DO_NOT_REDIRECT = 'DO_NOT_REDIRECT'
+
+ +
+
+ACTION_DROP = 'DROP'
+
+ +
+
+ACTION_REDIRECT = 'REDIRECT'
+
+ +
+
+ACTION_REJECT = 'REJECT'
+
+ +
+
+DIRECTION_IN = 'IN'
+
+ +
+
+DIRECTION_IN_OUT = 'IN_OUT'
+
+ +
+
+DIRECTION_OUT = 'OUT'
+
+ +
+
+IP_PROTOCOL_IPV4 = 'IPV4'
+
+ +
+
+IP_PROTOCOL_IPV4_IPV6 = 'IPV4_IPV6'
+
+ +
+
+IP_PROTOCOL_IPV6 = 'IPV6'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.DSRuleState(details=None, failure_code=None, failure_message=None, state=None, revision_desired=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • details (list of ConfigurationStateElement or None) – Array of configuration state of various sub systems +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • failure_code (long or None) – Error code format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • failure_message (str or None) – Error message in case of failure +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • state (str or None) –

    Possible values are:

    + +
    +
    Gives details of state of desired configuration
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • revision_desired (long or None) – revision number of the desired state format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+
+STATE_FAILED = 'failed'
+
+ +
+
+STATE_IN_PROGRESS = 'in_progress'
+
+ +
+
+STATE_ORPHANED = 'orphaned'
+
+ +
+
+STATE_PARTIAL_SUCCESS = 'partial_success'
+
+ +
+
+STATE_PENDING = 'pending'
+
+ +
+
+STATE_SUCCESS = 'success'
+
+ +
+
+STATE_UNKNOWN = 'unknown'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.DSSection(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, applied_tos=None, is_default=None, rule_count=None, section_type=None, stateful=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • applied_tos (list of ResourceReference or None) – List of objects where the rules in this section will be enforced. +This will take precedence over rule level appliedTo.
    • +
  • is_default (bool or None) – It is a boolean flag which reflects whether a distributed service +section is default section or not. Each Layer 3 and Layer 2 section +will have at least and at most one default section. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • rule_count (long or None) – Number of rules in this section. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • section_type (str) –

    Possible values are:

    + +

    Type of the rules which a section can contain. Only homogeneous +sections are supported.

    +
    • +
  • stateful (bool) – Stateful or Stateless nature of distributed service section is +enforced on all rules inside the section. Layer3 sections can be +stateful or stateless. Layer2 sections can only be stateless.
    • +
+
+
+
+SECTION_TYPE_L3REDIRECT = 'L3REDIRECT'
+
+ +
+
+SECTION_TYPE_LAYER2 = 'LAYER2'
+
+ +
+
+SECTION_TYPE_LAYER3 = 'LAYER3'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.DSSectionListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of DSSection or None) – List of the distributed service sections. The list has to be +homogenous. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DSSectionQueryParameters(cascade=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Section query parameters

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:cascade (bool or None) – Flag to cascade delete of this object to all it’s child objects.
+
+ +
+
+class com.vmware.nsx.model_client.DSSectionState(details=None, failure_code=None, failure_message=None, state=None, revision_desired=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • details (list of ConfigurationStateElement or None) – Array of configuration state of various sub systems +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • failure_code (long or None) – Error code format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • failure_message (str or None) – Error message in case of failure +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • state (str or None) –

    Possible values are:

    + +
    +
    Gives details of state of desired configuration
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • revision_desired (long or None) – revision number of the desired state format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+
+STATE_FAILED = 'failed'
+
+ +
+
+STATE_IN_PROGRESS = 'in_progress'
+
+ +
+
+STATE_ORPHANED = 'orphaned'
+
+ +
+
+STATE_PARTIAL_SUCCESS = 'partial_success'
+
+ +
+
+STATE_PENDING = 'pending'
+
+ +
+
+STATE_SUCCESS = 'success'
+
+ +
+
+STATE_UNKNOWN = 'unknown'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.DSService(is_valid=None, target_display_name=None, target_id=None, target_type=None, service=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • is_valid (bool or None) – Will be set to false if the referenced NSX resource has been +deleted. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • target_display_name (str or None) – Display name of the NSX resource. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • target_id (str or None) – Identifier of the NSX resource.
    • +
  • target_type (str or None) – Type of the NSX resource.
    • +
  • service (vmware.vapi.struct.VapiStruct or None) – Distributed Service API accepts raw protocol and ports as part of +NS service element in Distributed Service Rule that describes +traffic corresponding to an NSService. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +NSServiceElement. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in NSServiceElement.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DailyTelemetrySchedule(hour_of_day=None, minutes=None, frequency_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • hour_of_day (long) – Hour at which data will be collected. Specify a value between 0 +through 23. format: int64
    • +
  • minutes (long or None) – Minute at which data will be collected. Specify a value between 0 +through 59. format: int64
    • +
  • frequency_type (str) – Specify one of DailyTelemetrySchedule, WeeklyTelemetrySchedule, or +MonthlyTelemetrySchedule.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DataCounter(dropped=None, multicast_broadcast=None, total=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • dropped (long or None) – The dropped packets or bytes format: int64
    • +
  • multicast_broadcast (long or None) – The multicast and broadcast packets or bytes format: int64
    • +
  • total (long) – The total packets or bytes format: int64
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DataTypeCollectionConfiguration(collection_frequency=None, data_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Data type collection configuration

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+DATA_TYPE_STATISTICS = 'STATISTICS'
+
+ +
+
+DATA_TYPE_STATUS = 'STATUS'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.Datasource(display_name=None, urls=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

An instance of a datasource configuration.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • display_name (str) – Name of a datasource instance.
    • +
  • urls (list of UrlAlias) – Array of urls relative to the datasource configuration. For +example, api/v1/fabric/nodes is a relative url of nsx-manager +instance.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DeploymentConfig(placement_type='DeploymentConfig')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:placement_type (str) –

Possible values are:

+ +
+
+
+PLACEMENT_TYPE_VSPHEREDEPLOYMENTCONFIG = 'VsphereDeploymentConfig'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.DeploymentSpec(fabric_module_version=None, versioned_deployment_specs=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Deployment spec is a specific version of fabric module

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • fabric_module_version (str) – version of fabric module
    • +
  • versioned_deployment_specs (list of VersionedDeploymentSpec) – List of Versioned deployment specs
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DeploymentTemplate(attributes=None, name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Deployment Template holds the attributes specific to partner for which the +service is created. These attributes are opaque to NSX.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • attributes (list of Attribute or None) – List of attributes specific to a partner for which the service is +created. There attributes are passed on to the partner appliance +and is opaque to the NSX Manager.
    • +
  • name (str or None) – Deployment Template name.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DestinationFilteringConfiguration(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, customer_id=None, enabled=None, provider_url=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

It is used to configure the reputation and category provider. It can also +be used to enable or disable the destination filtering feature by setting +the enable property.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • customer_id (str) – The unique ID assigned to a customer.
    • +
  • enabled (bool or None) – Flag to enable or disable the feature.
    • +
  • provider_url (str) – URL of the provider which provides the reputation and category +databases.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DestinationNsxApiEndpoint(destination_nsx_ip=None, destination_nsx_password=None, destination_nsx_port=None, destination_nsx_username=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Details about the destination NSX manager for the migration

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • destination_nsx_ip (str) – IP address or host name of the destination NSX manager to which the +config will be migrated. format: hostname-or-ip
    • +
  • destination_nsx_password (str or None) – Valid password for connecting to the destination NSX manager.
    • +
  • destination_nsx_port (long or None) – Destination NSX manager port that will be used to apply details. +format: int32
    • +
  • destination_nsx_username (str) – Valid username for connecting to the destination NSX manager.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DhcpFilter(client_block_enabled=None, server_block_enabled=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

DHCP filtering configuration

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • client_block_enabled (bool) – Indicates whether DHCP client blocking is enabled
    • +
  • server_block_enabled (bool) – Indicates whether DHCP server blocking is enabled
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DhcpHeader(op_code=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:op_code (str or None) –

Possible values are:

+ +

This is used to specify the general type of message. A client +sending request to a server uses an op code of BOOTREQUEST, while a +server replying uses an op code of BOOTREPLY.

+
+
+
+OP_CODE_BOOTREPLY = 'BOOTREPLY'
+
+ +
+
+OP_CODE_BOOTREQUEST = 'BOOTREQUEST'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.DhcpIpPool(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, gateway_ip=None, lease_time=None, options=None, allocation_ranges=None, error_threshold=None, warning_threshold=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • gateway_ip (str or None) – gateway ip format: ip
    • +
  • lease_time (long or None) – lease time, in seconds, [60-(2^32-1)], default 86400 format: int64
    • +
  • options (DhcpOptions or None) – If an option is defined at server level and not configred at +ip-pool/static-binding level, the option will be inherited to +ip-pool/static-binding. If both define a same-code option, the +option defined at ip-pool/static-binding level take precedence over +that defined at server level.
    • +
  • allocation_ranges (list of IpPoolRange) – ip-ranges
    • +
  • error_threshold (long or None) – error threshold, valid [80-100], default 100 format: int64
    • +
  • warning_threshold (long or None) – warning threshold, valid [50-80], default 80 format: int64
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DhcpIpPoolListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of DhcpIpPool) – paginated list of dhcp ip pools
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DhcpIpPoolUsage(allocated_number=None, allocated_percentage=None, dhcp_ip_pool_id=None, pool_size=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • allocated_number (long) – allocated number. COULD BE INACCURATE, REFERENCE ONLY. format: +int64
    • +
  • allocated_percentage (long) – allocated percentage. COULD BE INACCURATE, REFERENCE ONLY. format: +int64
    • +
  • dhcp_ip_pool_id (str) – uuid of dhcp ip pool
    • +
  • pool_size (long) – pool size format: int64
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DhcpLeasePerIP(expire_time=None, ip_address=None, lease_time=None, mac_address=None, start_time=None, subnet=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • expire_time (str or None) – expire time of the lease
    • +
  • ip_address (str) – ip address of client
    • +
  • lease_time (str or None) – lease time of the ip address, in seconds
    • +
  • mac_address (str) – mac address of client
    • +
  • start_time (str) – start time of lease
    • +
  • subnet (str or None) – subnet of client network
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DhcpLeases(dhcp_server_id=None, leases=None, timestamp=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • dhcp_server_id (str or None) – dhcp server uuid
    • +
  • leases (list of DhcpLeasePerIP or None) – The lease info list of the server
    • +
  • timestamp (long or None) – timestamp of the lease info format: int64
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DhcpOption121(static_routes=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:static_routes (list of ClasslessStaticRoute) – dhcp classless static routes
+
+ +
+
+class com.vmware.nsx.model_client.DhcpOptions(option121=None, others=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+ +
+
+class com.vmware.nsx.model_client.DhcpProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, edge_cluster_id=None, edge_cluster_member_indexes=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • edge_cluster_id (str) – edge cluster uuid
    • +
  • edge_cluster_member_indexes (list of long or None) – If none is provided, the NSX will auto-select two edge-nodes from +the given edge cluster. If user provides only one edge node, there +will be no HA support. If both the member indexes are changed in a +same PUT API, e.g. change from [a,b] to [x,y], the current dhcp +server states will be lost, which could cause the network crash due +to ip conflicts. Hence the suggestion is to change only one member +index in one single update, e.g. from [a,b] to [a,y]. format: int64
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DhcpProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of DhcpProfile) – paginated list of dhcp profiles
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DhcpRelayProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, server_addresses=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • server_addresses (list of str) –
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DhcpRelayProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of DhcpRelayProfile) – Dhcp relay profile list results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DhcpRelayService(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, dhcp_relay_profile_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • dhcp_relay_profile_id (str) – dhcp relay profile referenced by the dhcp relay service
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DhcpRelayServiceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of DhcpRelayService) – Dhcp relay service list results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DhcpServerStatus(active_node=None, error_message=None, service_status=None, stand_by_node=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • active_node (str) – uuid of active transport node
    • +
  • error_message (str or None) – Error message, if available
    • +
  • service_status (str) –

    Possible values are:

    + +

    UP means the dhcp service is working fine on both active +transport-node and stand-by transport-node (if have), hence +fail-over can work at this time if there is failure happens on one +of the transport-node; DOWN means the dhcp service is down on both +active transport-node and stand-by node (if have), hence the +dhcp-service will not repsonse any dhcp request; Error means error +happens on transport-node(s) or no status is reported from +transport-node(s). The dhcp service may be working (or not +working); NO_STANDBY means dhcp service is working in one of the +transport node while not in the other transport-node (if have). +Hence if the dhcp service in the working transport-node is down, +fail-over will not happen and the dhcp service will go down.

    +
    • +
  • stand_by_node (str or None) – uuid of stand_by transport node. null if non-HA mode
    • +
+
+
+
+SERVICE_STATUS_DOWN = 'DOWN'
+
+ +
+
+SERVICE_STATUS_ERROR = 'ERROR'
+
+ +
+
+SERVICE_STATUS_NO_STANDBY = 'NO_STANDBY'
+
+ +
+
+SERVICE_STATUS_UP = 'UP'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.DhcpStaticBinding(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, gateway_ip=None, lease_time=None, options=None, host_name=None, ip_address=None, mac_address=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • gateway_ip (str or None) – gateway ip format: ip
    • +
  • lease_time (long or None) – lease time, in seconds, [60-(2^32-1)], default 86400 format: int64
    • +
  • options (DhcpOptions or None) – If an option is defined at server level and not configred at +ip-pool/static-binding level, the option will be inherited to +ip-pool/static-binding. If both define a same-code option, the +option defined at ip-pool/static-binding level take precedence over +that defined at server level.
    • +
  • host_name (str or None) – host name format: hostname
    • +
  • ip_address (str) – ip addres format: ip
    • +
  • mac_address (str) – mac address
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DhcpStaticBindingListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of DhcpStaticBinding) – paginated list of dhcp static bindings
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DhcpStatistics(acks=None, declines=None, dhcp_server_id=None, discovers=None, errors=None, informs=None, ip_pool_stats=None, nacks=None, offers=None, releases=None, requests=None, timestamp=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • acks (long) – The total number of DHCP ACK packets format: int64
    • +
  • declines (long) – The total number of DHCP DECLINE packets format: int64
    • +
  • dhcp_server_id (str) – dhcp server uuid
    • +
  • discovers (long) – The total number of DHCP DISCOVER packets format: int64
    • +
  • errors (long) – The total number of DHCP errors format: int64
    • +
  • informs (long) – The total number of DHCP INFORM packets format: int64
    • +
  • ip_pool_stats (list of DhcpIpPoolUsage or None) – The DHCP ip pool usage statistics
    • +
  • nacks (long) – The total number of DHCP NACK packets format: int64
    • +
  • offers (long) – The total number of DHCP OFFER packets format: int64
    • +
  • releases (long) – The total number of DHCP RELEASE packets format: int64
    • +
  • requests (long) – The total number of DHCP REQUEST packets format: int64
    • +
  • timestamp (long) – timestamp of the statistics format: int64
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DirectoryAdDomain(base_distinguished_name=None, sync_settings=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Active Directory Domain

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • base_distinguished_name (str or None) – Each active directory domain has a domain naming context (NC), +which contains domain-specific data. The root of this naming +context is represented by a domain’s distinguished name (DN) and is +typically referred to as the NC head.
    • +
  • sync_settings (DirectoryDomainSyncSettings or None) – Each domain sync settings can be changed using this object. It is +not required since there are default values used if there is no +specification for this object.
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) – Domain resource type comes from multiple sub-classes extending this +base class. For example, DirectoryAdDomain is one accepted +resource_type. If there are more sub-classes defined, they will +also be accepted resource_type.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • name (str) – Directory domain name which best describes the domain. It could be +unique fqdn name or it could also be descriptive. There is no +unique contraint for domain name among different domains.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DirectoryAdGroup(object_guid=None, secure_id=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, distinguished_name=None, domain_id=None, domain_sync_node_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • object_guid (str) – GUID is a 128-bit value that is unique not only in the enterprise +but also across the world. GUIDs are assigned to every object +created by Active Directory, not just User and Group objects.
    • +
  • secure_id (str) – A security identifier (SID) is a unique value of variable length +used to identify a trustee. A SID consists of the following +components - The revision level of the SID structure; A 48-bit +identifier authority value that identifies the authority that +issued the SID; A variable number of subauthority or relative +identifier (RID) values that uniquely identify the trustee relative +to the authority that issued the SID.
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) – Directory group resource type comes from multiple sub-classes +extending this base class. For example, DirectoryAdGroup is one +accepted resource_type. If there are more sub-classes defined, they +will also be accepted resource_type.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • distinguished_name (str) – Directory group distinguished name
    • +
  • domain_id (str) – Domain ID this directory group belongs to.
    • +
  • domain_sync_node_id (str) – Domain sync node under which this directory group is located.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DirectoryDomain(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='DirectoryDomain', tags=None, name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Directory Domain

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) – Domain resource type comes from multiple sub-classes extending this +base class. For example, DirectoryAdDomain is one accepted +resource_type. If there are more sub-classes defined, they will +also be accepted resource_type.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • name (str) – Directory domain name which best describes the domain. It could be +unique fqdn name or it could also be descriptive. There is no +unique contraint for domain name among different domains.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DirectoryDomainListResults(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

List of Directory Domain

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of vmware.vapi.struct.VapiStruct) – List of Directory Domains +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +DirectoryDomain. When methods return a value of this class +as a return value, the attribute will contain all the attributes +defined in DirectoryDomain.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DirectoryDomainSyncNode(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, distinguished_name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Directory Domain Synchronization Nodes

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • distinguished_name (str) – Distinguished name of the domain sync node
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DirectoryDomainSyncNodeListResults(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

List of Directory Domain Synchronization Nodes

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of DirectoryDomainSyncNode) – List of Directory Domain Synchronization Nodes
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DirectoryDomainSyncRemoteNodes(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

List of Directory Domain sync remote nodes

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of str) – Directory domain sync remote node candidate
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DirectoryDomainSyncSettings(delta_sync_interval=None, full_sync_cron_expr=None, sync_entire_domain=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Domain synchronization settings

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • delta_sync_interval (long or None) – Directory domain delta synchronization interval time between two +delta sync in minutes. format: int64
    • +
  • full_sync_cron_expr (str or None) – Directory domain full synchronization schedule using cron +expression. For example, cron expression "0 0 12 ? \* SUN +\*" means full sync is scheduled every Sunday midnight. If +this object is null, it means there is no background cron job +running for full sync.
    • +
  • sync_entire_domain (bool or None) – This flag will decide whether to synchronize the directory objects +under entire domain or configured synchronization nodes.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DirectoryDomainSyncStats(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, avg_delta_sync_time=None, avg_full_sync_time=None, current_state=None, current_state_begin_time=None, num_delta_sync=None, num_full_sync=None, prev_sync_end_time=None, prev_sync_status=None, prev_sync_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Directory Domain Synchronization Statistics

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • avg_delta_sync_time (long or None) – All the historical delta sync are counted in calculating the +average delta sync time in seconds. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • avg_full_sync_time (long or None) – All the historical full sync are counted in calculating the average +full sync time in seconds. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • current_state (str or None) –

    Possible values are:

    + +

    Current running state of the directory domain in synchronization +life cycle. It could be one of the following three states. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • current_state_begin_time (long or None) – Since what time the current state has begun. The time is expressed +in millisecond epoch time. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • num_delta_sync (long or None) – number of historical delta sync initiated either by system or by +API request. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • num_full_sync (long or None) – number of historical full sync initiated either by system or by API +request. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • prev_sync_end_time (long or None) – Directory domain previous sync ending time expressed in millisecond +epoch time. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • prev_sync_status (str or None) –

    Possible values are:

    + +

    Directory domain previous sync status. It could be one of the +following two states. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • prev_sync_type (str or None) –

    Possible values are:

    + +

    Directory domain previous sync type. It could be one of the +following three states. Right after the directory domain is +configured, this field is set to IDLE. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
+
+
+
+CURRENT_STATE_DELTA_SYNC = 'DELTA_SYNC'
+
+ +
+
+CURRENT_STATE_FULL_SYNC = 'FULL_SYNC'
+
+ +
+
+CURRENT_STATE_IDLE = 'IDLE'
+
+ +
+
+PREV_SYNC_STATUS_FAILURE = 'FAILURE'
+
+ +
+
+PREV_SYNC_STATUS_SUCCESS = 'SUCCESS'
+
+ +
+
+PREV_SYNC_STATUS_UNKNOWN = 'UNKNOWN'
+
+ +
+
+PREV_SYNC_TYPE_DELTA_SYNC = 'DELTA_SYNC'
+
+ +
+
+PREV_SYNC_TYPE_FULL_SYNC = 'FULL_SYNC'
+
+ +
+
+PREV_SYNC_TYPE_IDLE = 'IDLE'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.DirectoryGroup(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='DirectoryGroup', tags=None, distinguished_name=None, domain_id=None, domain_sync_node_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) – Directory group resource type comes from multiple sub-classes +extending this base class. For example, DirectoryAdGroup is one +accepted resource_type. If there are more sub-classes defined, they +will also be accepted resource_type.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • distinguished_name (str) – Directory group distinguished name
    • +
  • domain_id (str) – Domain ID this directory group belongs to.
    • +
  • domain_sync_node_id (str) – Domain sync node under which this directory group is located.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DirectoryGroupListResults(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of vmware.vapi.struct.VapiStruct) – Directory group list +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +DirectoryGroup. When methods return a value of this class +as a return value, the attribute will contain all the attributes +defined in DirectoryGroup.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DirectoryGroupMember(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, group_distinguished_name=None, group_id=None, member_group_distinguished_name=None, member_group_id=None, nested=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • group_distinguished_name (str) – Directory group distinguished name this group member belongs to.
    • +
  • group_id (str) – Directory group id this group member belongs to
    • +
  • member_group_distinguished_name (str) – Directory group name this group member owns
    • +
  • member_group_id (str) – Directory group id this group member owns
    • +
  • nested (bool) – Whether this member group is a directory member of the parent group +speicified by group_id or a nested member group which parent group +is also member group of the parent group speicified by group_id.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DirectoryGroupMemberListResults(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of DirectoryGroupMember) – Directory group member list
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DirectoryLdapServer(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, enabled=None, host=None, password=None, port=None, protocol=None, thumbprint=None, username=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Ldap Server of Directory Domain

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • enabled (bool or None) – Whether this directory LDAP server is enabled or not.
    • +
  • host (str) – Directory LDAP server DNS host name or ip address which is +reachable by NSX manager to be connected and do object +synchronization. format: ip-or-hostname
    • +
  • password (str) – Directory LDAP server connection password.
    • +
  • port (long or None) – Directory LDAP server connection TCP/UDP port. format: int64
    • +
  • protocol (str or None) –

    Possible values are:

    + +

    Directory LDAP server connection protocol which is either LDAP or +LDAPS.

    +
    • +
  • thumbprint (str or None) – Directory LDAP server certificate thumbprint used in secure LDAPS +connection.
    • +
  • username (str) – Directory LDAP server connection user name.
    • +
+
+
+
+PROTOCOL_LDAP = 'LDAP'
+
+ +
+
+PROTOCOL_LDAPS = 'LDAPS'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.DirectoryLdapServerListResults(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

List of Directory Domain LDAP servers

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of DirectoryLdapServer) – List of Directory Domain Ldap Servers
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DiscoveredNode(links=None, schema=None, self_=None, last_sync_time=None, description=None, display_name=None, resource_type=None, tags=None, certificate=None, cm_local_id=None, external_id=None, hardware_id=None, ip_addresses=None, node_type=None, origin_id=None, origin_properties=None, os_type=None, os_version=None, parent_compute_collection=None, stateless=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • last_sync_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Display name of discovered node +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • certificate (str or None) – Certificate of the discovered node
    • +
  • cm_local_id (str or None) – Local Id of the discovered node in the Compute Manager +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • external_id (str or None) – External id of the discovered node, ex. a mo-ref from VC +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • hardware_id (str or None) – Hardware Id is generated using system hardware info. It is used to +retrieve fabric node of the esx. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • ip_addresses (list of str or None) – IP Addresses of the the discovered node. format: ip +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • node_type (str or None) – Discovered Node type like Host +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • origin_id (str or None) – Id of the compute manager from where this node was discovered +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • origin_properties (list of KeyValuePair or None) – Key-Value map of additional specific properties of discovered node +in the Compute Manager +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • os_type (str or None) – OS type of the discovered node +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • os_version (str or None) – OS version of the discovered node +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • parent_compute_collection (str or None) – External id of the compute collection to which this node belongs +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • stateless (bool or None) – The stateless property describes whether host persists its state +across reboot or not. If state persists, value is set as false +otherwise true. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DiscoveredNodeInterfaceProperties(connected_switch=None, interface_id=None, physical_address=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Network interface properties of discovered node

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • connected_switch (str or None) – Switch name which is connected to nic, switch can be opaque, +proxyHostSwitch or virtual
    • +
  • interface_id (str or None) – Id of the network interface
    • +
  • physical_address (str or None) – Mac address of the interface
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DiscoveredNodeListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Discovered Node list result

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of DiscoveredNode) – Discovered Node list results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DiscoveredNodeNetworkInterfaces(discovered_node_id=None, network_interfaces=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

All the network interfaces of the discovered node

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • discovered_node_id (str) – Id of the discovered node
    • +
  • network_interfaces (list of DiscoveredNodeInterfaceProperties or None) – Network interfaces of the node
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DiscoveredResource(links=None, schema=None, self_=None, last_sync_time=None, description=None, display_name=None, resource_type=None, tags=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Base class for resources that are discovered and automatically updated

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • last_sync_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DnsAnswer(authoritative_answers=None, dns_server=None, edge_node_id=None, non_authoritative_answers=None, raw_answer=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Answer of dns nslookup

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • authoritative_answers (list of DnsQueryAnswer or None) – Authoritative answers
    • +
  • dns_server (str) – Dns server ip address and port, format is "ip +address#port".
    • +
  • edge_node_id (str) – ID of the edge node that performed the query.
    • +
  • non_authoritative_answers (list of DnsQueryAnswer or None) – Non authoritative answers
    • +
  • raw_answer (str or None) – It can be NXDOMAIN or error message which is not consisted of +authoritative_answer or non_authoritative_answer.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DnsForwarder(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, cache_size=None, conditional_forwarders=None, default_forwarder=None, listener_ip=None, log_level=None, logical_router_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • cache_size (long or None) – One dns answer cache entry will consume ~120 bytes. Hence 1 KB +cache size can cache ~8 dns answer entries, and the default 1024 KB +cache size can hold ~8k dns answer entries. format: int32
    • +
  • conditional_forwarders (list of ConditionalForwarderZone or None) – The conditional zone forwarders. During matching a zone forwarder, +the dns forwarder will use the conditional fowarder with the +longest domain name that matches the query.
    • +
  • default_forwarder (ForwarderZone) – The default zone forwarder that catches all other domain names +except those matched by conditional forwarder zone.
    • +
  • listener_ip (str) – The ip address the dns forwarder listens on. It can be an ip +address already owned by the logical-router uplink port or +router-link, or a loopback port ip address. But it can not be a +downlink port address. User needs to ensure the address is +reachable via router or NAT from both client VMs and upstream +servers. User will need to create Firewall rules if needed to allow +such traffic on a Tier-1 or Tier-0. format: ipv4
    • +
  • log_level (str or None) –

    Possible values are:

    + +
    +
    Log level of the dns forwarder
    +
    • +
  • logical_router_id (str) – Specify the LogicalRouter where the DnsForwarder runs. The HA mode +of the hosting LogicalRouter must be Active/Standby.
    • +
+
+
+
+LOG_LEVEL_DEBUG = 'DEBUG'
+
+ +
+
+LOG_LEVEL_ERROR = 'ERROR'
+
+ +
+
+LOG_LEVEL_FATAL = 'FATAL'
+
+ +
+
+LOG_LEVEL_INFO = 'INFO'
+
+ +
+
+LOG_LEVEL_WARNING = 'WARNING'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.DnsForwarderListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of DnsForwarder) – Paginated list of dns forwarders
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DnsHeader(address=None, message_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • address (str or None) – This is used to define what is being asked or responded. format: +hostname-or-ip
    • +
  • message_type (str or None) –

    Possible values are:

    + +
    +
    Specifies the message type whether it is a query or a response.
    +
    • +
+
+
+
+MESSAGE_TYPE_QUERY = 'QUERY'
+
+ +
+
+MESSAGE_TYPE_RESPONSE = 'RESPONSE'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.DnsQueryAnswer(address=None, name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Answer of nslookup

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • address (str or None) – Can be resolved ip address.
    • +
  • name (str or None) – Matched name of the given address.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DonutConfiguration(display_count=None, label=None, navigation=None, sections=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='DonutConfiguration', tags=None, datasources=None, drilldown_id=None, footer=None, is_drilldown=None, shared=None, weight=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Represents configuration of a Donut

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • display_count (bool or None) – If true, displays the count of entities in the donut
    • +
  • label (Label or None) – Displayed at the middle of the donut, by default. It labels the +entities of donut.
    • +
  • navigation (str or None) – Hyperlink of the specified UI page that provides details.
    • +
  • sections (list of DonutSection) – Sections
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str) – Title of the widget.
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +

    Supported visualization types are LabelValueConfiguration, +DonutConfiguration, GridConfiguration, StatsConfiguration, +MultiWidgetConfiguration and ContainerConfiguration.

    +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • datasources (list of Datasource or None) – The ‘datasources’ represent the sources from which data will be +fetched. Currently, only NSX-API is supported as a ‘default’ +datasource. An example of specifying ‘default’ datasource along +with the urls to fetch data from is given at ‘example_request’ +section of ‘CreateWidgetConfiguration’ API.
    • +
  • drilldown_id (str or None) – Id of drilldown widget, if any. Id should be a valid id of an +existing widget. A widget is considered as drilldown widget when it +is associated with any other widget and provides more detailed +information about any data item from the parent widget.
    • +
  • footer (Footer or None) –
    • +
  • is_drilldown (bool or None) – Set to true if this widget should be used as a drilldown.
    • +
  • shared (bool or None) – Please use the property ‘shared’ of View instead of this. The +widgets of a shared view are visible to other users.
    • +
  • weight (long or None) – Specify relavite weight in WidgetItem for placement in a view. +Please see WidgetItem for details. format: int32
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DonutPart(field=None, label=None, render_configuration=None, tooltip=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Represents an entity or portion to be plotted on a donut or stats chart.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • field (str) – A numerical value that represents the portion or entity of the +donut or stats chart.
    • +
  • label (Label or None) – If a section ‘template’ holds this donut or stats part, then the +label is auto-generated from the fetched field values after +applying the template.
    • +
  • render_configuration (list of RenderConfiguration or None) – Additional rendering or conditional evaluation of the field values +to be performed, if any.
    • +
  • tooltip (list of Tooltip or None) – Multi-line text to be shown on tooltip while hovering over the +portion.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.DonutSection(parts=None, row_list_field=None, template=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Represents high level logical grouping of portions or segments of a donut / +stats chart.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • parts (list of DonutPart) – Array of portions or parts of the donut or stats chart.
    • +
  • row_list_field (str or None) – Field of the root of the api result set for forming parts.
    • +
  • template (bool or None) – If true, the section will be appled as template for forming parts. +Only one part will be formed from each element of ‘row_list_field’.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.Dscp(mode=None, priority=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Dscp value is ignored in case of ‘TRUSTED’ DscpMode.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • mode (str or None) –

    Possible values are:

    + +
    +
    Trust settings
    +
    • +
  • priority (long or None) – Internal Forwarding Priority format: int32
    • +
+
+
+
+MODE_TRUSTED = 'TRUSTED'
+
+ +
+
+MODE_UNTRUSTED = 'UNTRUSTED'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.EULAAcceptance(acceptance=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Indicate the status of End User License Agreement acceptance

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:acceptance (bool) – End User License Agreement acceptance status
+
+ +
+
+class com.vmware.nsx.model_client.EULAContent(content=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

End User License Agreement content

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:content (str or None) – End User License Agreement content
+
+ +
+
+class com.vmware.nsx.model_client.EdgeCluster(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, cluster_profile_bindings=None, deployment_type=None, member_node_type=None, members=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • cluster_profile_bindings (list of ClusterProfileTypeIdEntry or None) – Edge cluster profile bindings
    • +
  • deployment_type (str or None) –

    Possible values are:

    + +

    This field is a readonly field which shows the deployment_type of +members. It returns UNKNOWN if there are no members, and returns +VIRTUAL_MACHINE| PHYSICAL_MACHINE if all edge members are +VIRTUAL_MACHINE|PHYSICAL_MACHINE. It returns HYBRID if the cluster +contains edge members of both types VIRTUAL_MACHINE and +PHYSICAL_MACHINE. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • member_node_type (str or None) –

    Possible values are:

    + +

    Edge cluster is homogenous collection of transport nodes. Hence all +transport nodes of the cluster must be of same type. This readonly +field shows the type of transport nodes. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • members (list of EdgeClusterMember or None) – EdgeCluster only supports homogeneous members. These member should +be backed by either EdgeNode or PublicCloudGatewayNode. +TransportNode type of these nodes should be the same. +DeploymentType (VIRTUAL_MACHINE|PHYSICAL_MACHINE) of these +EdgeNodes is recommended to be the same. EdgeCluster supports +members of different deployment types.
    • +
+
+
+
+DEPLOYMENT_TYPE_PHYSICAL_MACHINE = 'PHYSICAL_MACHINE'
+
+ +
+
+DEPLOYMENT_TYPE_UNKNOWN = 'UNKNOWN'
+
+ +
+
+DEPLOYMENT_TYPE_VIRTUAL_MACHINE = 'VIRTUAL_MACHINE'
+
+ +
+
+MEMBER_NODE_TYPE_EDGE_NODE = 'EDGE_NODE'
+
+ +
+
+MEMBER_NODE_TYPE_PUBLIC_CLOUD_GATEWAY_NODE = 'PUBLIC_CLOUD_GATEWAY_NODE'
+
+ +
+
+MEMBER_NODE_TYPE_UNKNOWN = 'UNKNOWN'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.EdgeClusterListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of EdgeCluster) – Edge cluster list results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.EdgeClusterMember(description=None, display_name=None, member_index=None, transport_node_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • description (str or None) – description of edge cluster member
    • +
  • display_name (str or None) – display name of edge cluster member
    • +
  • member_index (long or None) – System generated index for cluster member format: int32 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • transport_node_id (str) – Identifier of the transport node backed by an Edge node
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.EdgeClusterMemberAllocationPool(allocation_pool_type='EdgeClusterMemberAllocationPool')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:allocation_pool_type (str) –

Possible values are:

+ +
+
+
+ALLOCATION_POOL_TYPE_LOADBALANCERALLOCATIONPOOL = 'LoadBalancerAllocationPool'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.EdgeClusterMemberAllocationProfile(allocation_pool=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:allocation_pool (vmware.vapi.struct.VapiStruct or None) – Logical router allocation can be tracked for specific services and +services may have their own hard limits and allocation sizes. For +example load balancer pool should be specified if load balancer +service will be attached to logical router. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +EdgeClusterMemberAllocationPool. When methods return a +value of this class as a return value, the attribute will contain +all the attributes defined in +EdgeClusterMemberAllocationPool.
+
+ +
+
+class com.vmware.nsx.model_client.EdgeClusterMemberListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of EdgeClusterMember) – edge cluster member list results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.EdgeClusterMemberTransportNode(member_index=None, transport_node_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • member_index (long) – System generated index for cluster member format: int32
    • +
  • transport_node_id (str) – Identifier of the transport node backed by an Edge node
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.EdgeHighAvailabilityProfile(bfd_allowed_hops=None, bfd_declare_dead_multiple=None, bfd_probe_interval=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='EdgeHighAvailabilityProfile', tags=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Profile for BFD HA cluster setting

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • bfd_allowed_hops (long or None) – BFD allowed hops format: int64
    • +
  • bfd_declare_dead_multiple (long or None) – Number of times a packet is missed before BFD declares the neighbor +down. format: int64
    • +
  • bfd_probe_interval (long or None) – the time interval (in millisec) between probe packets for heartbeat +purpose format: int64
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.EdgeNode(allocation_list=None, deployment_config=None, deployment_type=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='EdgeNode', tags=None, discovered_ip_addresses=None, external_id=None, fqdn=None, ip_addresses=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • allocation_list (list of str or None) – List of logical router ids to which this edge node is allocated. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • deployment_config (EdgeNodeDeploymentConfig or None) – When this configuration is specified, edge fabric node of +deployment_type VIRTUAL_MACHINE will be deployed and registered +with MP.
    • +
  • deployment_type (str or None) –

    Possible values are:

    + +
    +
    Supported edge deployment type.
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) – Fabric node type, for example ‘HostNode’, ‘EdgeNode’ or +‘PublicCloudGatewayNode’
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • discovered_ip_addresses (list of str or None) – Discovered IP Addresses of the fabric node, version 4 or 6 format: +ip +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • external_id (str or None) – ID of the Node maintained on the Node and used to recognize the +Node
    • +
  • fqdn (str or None) – Fully qualified domain name of the fabric node +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • ip_addresses (list of str or None) – IP Addresses of the Node, version 4 or 6. This property is +mandatory for all nodes except for automatic deployment of edge +virtual machine node. For automatic deployment, the ip address from +management_port_subnets property will be considered. format: ip
    • +
+
+
+
+DEPLOYMENT_TYPE_PHYSICAL_MACHINE = 'PHYSICAL_MACHINE'
+
+ +
+
+DEPLOYMENT_TYPE_UNKNOWN = 'UNKNOWN'
+
+ +
+
+DEPLOYMENT_TYPE_VIRTUAL_MACHINE = 'VIRTUAL_MACHINE'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.EdgeNodeDeploymentConfig(form_factor=None, node_user_settings=None, vm_deployment_config=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+FORM_FACTOR_LARGE = 'LARGE'
+
+ +
+
+FORM_FACTOR_MEDIUM = 'MEDIUM'
+
+ +
+
+FORM_FACTOR_SMALL = 'SMALL'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.EdgeUpgradeStatus(can_skip=None, component_type=None, details=None, percent_complete=None, status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Status of edge upgrade

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • can_skip (bool or None) – Can the upgrade of the remaining units in this component be skipped +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • component_type (str or None) – Component type for the upgrade status +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • details (str or None) – Details about the upgrade status +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • percent_complete (float or None) – Indicator of upgrade progress in percentage +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • status (str or None) –

    Possible values are:

    + +
    +
    Upgrade status of component
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
+
+
+
+STATUS_FAILED = 'FAILED'
+
+ +
+
+STATUS_IN_PROGRESS = 'IN_PROGRESS'
+
+ +
+
+STATUS_NOT_STARTED = 'NOT_STARTED'
+
+ +
+
+STATUS_PAUSED = 'PAUSED'
+
+ +
+
+STATUS_SUCCESS = 'SUCCESS'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.EffectiveIPAddressMemberListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of str) – Paged Collection of effective ip addresses for the given NSGroup +format: address-or-block-or-range
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.EffectiveMemberResourceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of ResourceReference) – Paged Collection of resources which are the effective members of an +NSGroup.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.EffectiveMemberTypeListResult(result_count=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+RESULTS_DIRECTORYGROUP = 'DirectoryGroup'
+
+ +
+
+RESULTS_IPSET = 'IPSet'
+
+ +
+
+RESULTS_LOGICALPORT = 'LogicalPort'
+
+ +
+
+RESULTS_LOGICALSWITCH = 'LogicalSwitch'
+
+ +
+
+RESULTS_MACSET = 'MACSet'
+
+ +
+
+RESULTS_NSGROUP = 'NSGroup'
+
+ +
+
+RESULTS_VIRTUALMACHINE = 'VirtualMachine'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.EgressRateShaper(enabled=None, resource_type=None, average_bandwidth_mbps=None, burst_size_bytes=None, peak_bandwidth_mbps=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

A shaper that specifies egress rate properties in Mb/s

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+RESOURCE_TYPE_EGRESSRATESHAPER = 'EgressRateShaper'
+
+ +
+
+RESOURCE_TYPE_INGRESSBROADCASTRATESHAPER = 'IngressBroadcastRateShaper'
+
+ +
+
+RESOURCE_TYPE_INGRESSRATESHAPER = 'IngressRateShaper'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.EmbeddedResource(links=None, schema=None, self_=None, revision=None, owner=None, description=None, display_name=None, id=None, resource_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Base class for resources that are embedded in other resources

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • owner (OwnerResourceLink or None) – Owner of this resource
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Identifier of the resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.Endpoint(default_gateway=None, device_name=None, ip=None, label=None, mac=None, subnet_mask=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

An Endpoint object is part of HostSwitch configuration in TransportNode

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • default_gateway (str or None) – Gateway IP format: ip +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • device_name (str or None) – Name of the virtual tunnel endpoint +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • ip (str or None) – Depending upon the EndpointIpConfig used in HostSwitch, IP could be +allocated either from DHCP (default) or from Static IP Pool. +format: ip +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • label (long or None) – Unique label for this Endpoint format: int32 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • mac (str or None) – MAC address +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • subnet_mask (str or None) – Subnet mask format: ip +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ErrorInfo(error_message=None, timestamp=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Error information

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • error_message (str or None) – Error message +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • timestamp (long or None) – Timestamp when the error occurred format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ErrorResolverInfo(error_id=None, resolver_present=None, user_metadata=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Metadata related to a given error_id

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • error_id (long) – The error id for which metadata information is needed format: int64
    • +
  • resolver_present (bool) – Indicates whether there is a resolver associated with the error or +not
    • +
  • user_metadata (ErrorResolverUserMetadata or None) – User supplied metadata that might be required by the resolver
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ErrorResolverInfoList(results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Collection of all registered ErrorResolverInfo

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:results (list of ErrorResolverInfo) – ErrorResolverInfo list
+
+ +
+
+class com.vmware.nsx.model_client.ErrorResolverMetadata(entity_id=None, error_id=None, system_metadata=None, user_metadata=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Error along with its metadata

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • entity_id (str) – The entity/node UUID where the error has occurred.
    • +
  • error_id (long) – The error id as reported by the entity where the error occurred. +format: int64
    • +
  • system_metadata (ErrorResolverSystemMetadata or None) – This can come from some external system like syslog collector
    • +
  • user_metadata (ErrorResolverUserMetadata or None) – User supplied metadata that might be required by the resolver
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ErrorResolverMetadataList(errors=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

List of errors with their metadata

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:errors (list of ErrorResolverMetadata) – List of errors with their corresponding metadata.
+
+ +
+
+class com.vmware.nsx.model_client.ErrorResolverSystemMetadata(value=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Metadata fetched from an external system like Syslog or LogInsight.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:value (str or None) – The value fetched from another system
+
+ +
+
+class com.vmware.nsx.model_client.ErrorResolverUserInputData(data_type=None, property_name=None, property_value=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Corresponds to one property entered by the user

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+DATA_TYPE_NUMBER = 'NUMBER'
+
+ +
+
+DATA_TYPE_PASSWORD = 'PASSWORD'
+
+ +
+
+DATA_TYPE_TEXT = 'TEXT'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.ErrorResolverUserMetadata(user_input_list=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

User supplied metadata needed for resolving errors

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:user_input_list (list of ErrorResolverUserInputData or None) – List of user supplied input data.
+
+ +
+
+class com.vmware.nsx.model_client.EtherTypeNSService(ether_type=None, resource_type='EtherTypeNSService')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

An NSService element that represents an ethertype protocol

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+ +
+
+class com.vmware.nsx.model_client.EthernetHeader(dst_mac=None, eth_type=None, src_mac=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • dst_mac (str or None) – The destination MAC address of form: +"^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$". For example: +00:00:00:00:00:00.
    • +
  • eth_type (long or None) – This field defaults to IPv4. format: int64
    • +
  • src_mac (str or None) – The source MAC address of form: +"^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$". For example: +00:00:00:00:00:00.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ExcludeList(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, members=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • members (list of ResourceReference) – List of the members in the exclude list
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ExtraConfig(config_pair=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Extra config is intended for supporting vendor specific configuration on +the data path, it can be set as key value string pairs on either logical +switch or logical port. If it was set on logical switch, it will be +inherited automatically by logical ports in it. Also logical port setting +will override logical switch setting if specific key was dual set on both +logical switch and logical port.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:config_pair (KeyValuePair) – Key value pair in string for the configuration
+
+ +
+
+class com.vmware.nsx.model_client.ExtraConfigHostSwitchProfile(extra_configs=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ExtraConfigHostSwitchProfile', tags=None, required_capabilities=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Profile for extra configs in host switch

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • extra_configs (list of ExtraConfig or None) – list of extra configs
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • required_capabilities (list of str or None) –
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.FabricModule(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, current_version=None, custom_data=None, deployment_specs=None, fabric_module_name=None, source_authentication_mode=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Fabric module contains list of deployment specs and current version. Each +deployment spec is a different version of same fabric module. If fabric +module have two deployment specs or say two different versions then current +version will specify which version needs to be installed.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • current_version (str) – current version on for the host prep fabric module.
    • +
  • custom_data (list of StringMapEntry or None) – Slot for storing consumer data (fabric module’s specific data +common across all the realizations of the fabric module)
    • +
  • deployment_specs (list of DeploymentSpec) – List of deployment specs
    • +
  • fabric_module_name (str) – Name of the fabric module
    • +
  • source_authentication_mode (str or None) –

    Possible values are:

    + +

    This enum specifies the authentication supported at source i.e. for +downloading VM. If this attribute is not provided, then +NO_AUTHENTICATION will be considered.

    +
    • +
+
+
+
+SOURCE_AUTHENTICATION_MODE_BASIC_AUTHENTICATION = 'BASIC_AUTHENTICATION'
+
+ +
+
+SOURCE_AUTHENTICATION_MODE_MARKET_PLACE = 'MARKET_PLACE'
+
+ +
+
+SOURCE_AUTHENTICATION_MODE_NO_AUTHENTICATION = 'NO_AUTHENTICATION'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.FabricModuleListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Fabric Module list result

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of FabricModule or None) – Fabric Module list results +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.FailedNodeSupportBundleResult(error_code=None, error_message=None, node_display_name=None, node_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • error_code (str or None) – Error code +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • error_message (str or None) – Error message +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • node_display_name (str or None) – Display name of node +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • node_id (str or None) – UUID of node +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.FeatureAccess(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, enabled=None, feature=None, information=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Feature access

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • enabled (bool or None) – Feature enabled or not +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • feature (str or None) – Feature +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • information (list of FeatureInfo or None) – Feature Info
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.FeatureAccessListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of FeatureAccess) – List results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.FeatureInfo(info=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Feature Info

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:info (str or None) – Info +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
+
+ +
+
+class com.vmware.nsx.model_client.FeaturePermission(feature=None, permission=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Feature Permission

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+PERMISSION_CRUD = 'crud'
+
+ +
+
+PERMISSION_EXECUTE = 'execute'
+
+ +
+
+PERMISSION_NONE = 'none'
+
+ +
+
+PERMISSION_READ = 'read'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.FeaturePermissionListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of FeaturePermission) – List results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.FeatureStackCollectionConfiguration(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, client_type_collection_configurations=None, feature_stack_name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

HPM feature stack data collection frequency configuration

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • client_type_collection_configurations (list of ClientTypeCollectionConfiguration or None) – The set of client type data collection configurations
    • +
  • feature_stack_name (str) – The name of the feature stack
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.FeatureStackCollectionConfigurationList(results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Feature stack collection configuration list result

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:results (list of FeatureStackCollectionConfiguration or None) – The complete set of feature stack data collection configurations +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
+
+ +
+
+class com.vmware.nsx.model_client.FeatureUsage(links=None, schema=None, self_=None, capacity_usage=None, feature=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

feature usage result item

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • capacity_usage (list of CapacityUsage or None) – Capacity Usage List +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • feature (str or None) – name of the feature +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.FeatureUsageCsvRecord(cpu_usage_count=None, feature=None, vcpu_usage_count=None, vm_usage_count=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • cpu_usage_count (long or None) – count of number of cpu sockets used by this feature format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • feature (str or None) – name of the feature +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • vcpu_usage_count (long or None) – count of number of vcpus of public cloud VMs format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • vm_usage_count (long or None) – count of number of vms used by this feature format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.FeatureUsageList(links=None, schema=None, self_=None, feature_usage_info=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

list of feature usage items

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • feature_usage_info (list of FeatureUsage or None) – Feature Usage List +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.FeatureUsageListInCsvFormat(file_name=None, last_update_timestamp=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • file_name (str or None) – File name set by HTTP server if API returns CSV result as a file.
    • +
  • last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has +never updated the data. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of FeatureUsageCsvRecord or None) –
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.FieldsPacketData(frame_size=None, resource_type=None, routed=None, transport_type=None, eth_header=None, ip_header=None, payload=None, transport_header=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+RESOURCE_TYPE_BINARYPACKETDATA = 'BinaryPacketData'
+
+ +
+
+RESOURCE_TYPE_FIELDSPACKETDATA = 'FieldsPacketData'
+
+ +
+
+TRANSPORT_TYPE_BROADCAST = 'BROADCAST'
+
+ +
+
+TRANSPORT_TYPE_MULTICAST = 'MULTICAST'
+
+ +
+
+TRANSPORT_TYPE_UNICAST = 'UNICAST'
+
+ +
+
+TRANSPORT_TYPE_UNKNOWN = 'UNKNOWN'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.FileHash(links=None, schema=None, self_=None, hash_code=None, hash_type=None, name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

File hash code

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • hash_code (str) – Computed hash of file
    • +
  • hash_type (str) –

    Possible values are:

    + +
    +
    Algorithm used to compute the file’s hash
    +
    • +
  • name (str) – File name
    • +
+
+
+
+HASH_TYPE_SHA1 = 'SHA1'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.FileProperties(links=None, schema=None, self_=None, created_epoch_ms=None, modified_epoch_ms=None, name=None, size=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

File properties

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • created_epoch_ms (long) – File creation time in epoch milliseconds format: int64
    • +
  • modified_epoch_ms (long) – File modification time in epoch milliseconds format: int64
    • +
  • name (str) – File name
    • +
  • size (long) – Size of the file in bytes format: int64
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.FilePropertiesListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

File properties query results

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of FileProperties) – File property results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.FileThumbprint(links=None, schema=None, self_=None, name=None, sha1=None, sha256=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

File thumbprint

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • name (str) – File name
    • +
  • sha1 (str) – File’s SHA1 thumbprint
    • +
  • sha256 (str) – File’s SHA256 thumbprint
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.FileTransferAuthenticationScheme(password=None, scheme_name=None, username=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Remote server authentication details

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+SCHEME_NAME_PASSWORD = 'PASSWORD'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.FileTransferProtocol(authentication_scheme=None, protocol_name=None, ssh_fingerprint=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Protocol to transfer backup file to remote server

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • authentication_scheme (FileTransferAuthenticationScheme) – Scheme to authenticate if required
    • +
  • protocol_name (str) –

    Possible values are:

    + +
    +
    Protocol name
    +
    • +
  • ssh_fingerprint (str) – The expected SSH fingerprint of the server. If the server’s +fingerprint does not match this fingerprint, the connection will be +terminated. Only ECDSA fingerprints hashed with SHA256 are +supported. To obtain the host’s ssh fingerprint, you should connect +via some method other than SSH to obtain this information. You can +use one of these commands to view the key’s fingerprint: 1. +ssh-keygen -l -E sha256 -f ssh_host_ecdsa_key.pub 2. awk ‘{print +$2}’ ssh_host_ecdsa_key.pub | base64 -d | sha256sum -b | sed ‘s/ +.\*$//’ | xxd -r -p | base64 | sed ‘s/.//44g’ | awk ‘{print +"SHA256:"$1}’
    • +
+
+
+
+PROTOCOL_NAME_SFTP = 'sftp'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.Filter(name=None, value=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • name (str) – The name of the filter.
    • +
  • value (str) – The value of the filter.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.FilterRequest(field_names=None, value=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Filter request parameters

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • field_names (str) – Comma seperated fields to be filtered on
    • +
  • value (str) – Filter value
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.FireWallServiceAssociationListResult(results=None, links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, service_type='FireWallServiceAssociationListResult')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • results (list of FirewallRule or None) – Firewall rule list result with pagination support. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • service_type (str) –

    Possible values are:

    + +
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.FirewallRule(links=None, schema=None, self_=None, revision=None, owner=None, description=None, display_name=None, id=None, resource_type=None, action=None, applied_tos=None, destinations=None, destinations_excluded=None, direction=None, disabled=None, ip_protocol=None, is_default=None, logged=None, notes=None, rule_tag=None, services=None, sources=None, sources_excluded=None, section_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • owner (OwnerResourceLink or None) – Owner of this resource
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Identifier of the resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • action (str) –

    Possible values are:

    + +

    Action enforced on the packets which matches the distributed +service rule. Currently DS Layer supports below actions. ALLOW - +Forward any packet when a rule with this action gets a match (Used +by Firewall). DROP - Drop any packet when a rule with this action +gets a match. Packets won’t go further(Used by Firewall). REJECT - +Terminate TCP connection by sending TCP reset for a packet when a +rule with this action gets a match (Used by Firewall). REDIRECT - +Redirect any packet to a partner appliance when a rule with this +action gets a match (Used by Service Insertion). DO_NOT_REDIRECT - +Do not redirect any packet to a partner appliance when a rule with +this action gets a match (Used by Service Insertion).

    +
    • +
  • applied_tos (list of ResourceReference or None) – List of object where rule will be enforced. The section level field +overrides this one. Null will be treated as any.
    • +
  • destinations (list of ResourceReference or None) – List of the destinations. Null will be treated as any.
    • +
  • destinations_excluded (bool or None) – Negation of the destination.
    • +
  • direction (str or None) –

    Possible values are:

    + +

    Rule direction in case of stateless distributed service rules. This +will only considered if section level parameter is set to +stateless. Default to IN_OUT if not specified.

    +
    • +
  • disabled (bool or None) – Flag to disable rule. Disabled will only be persisted but never +provisioned/realized.
    • +
  • ip_protocol (str or None) –

    Possible values are:

    + +
    +
    Type of IP packet that should be matched while enforcing the rule.
    +
    • +
  • is_default (bool or None) – Flag to indicate whether rule is default. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • logged (bool or None) – Flag to enable packet logging. Default is disabled.
    • +
  • notes (str or None) – User notes specific to the rule.
    • +
  • rule_tag (str or None) – User level field which will be printed in CLI and packet logs.
    • +
  • services (list of FirewallService or None) – List of the services. Null will be treated as any.
    • +
  • sources (list of ResourceReference or None) – List of sources. Null will be treated as any.
    • +
  • sources_excluded (bool or None) – Negation of the source.
    • +
  • section_id (str or None) – Section Id of the section to which this rule belongs to. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+
+ACTION_ALLOW = 'ALLOW'
+
+ +
+
+ACTION_DO_NOT_REDIRECT = 'DO_NOT_REDIRECT'
+
+ +
+
+ACTION_DROP = 'DROP'
+
+ +
+
+ACTION_REDIRECT = 'REDIRECT'
+
+ +
+
+ACTION_REJECT = 'REJECT'
+
+ +
+
+DIRECTION_IN = 'IN'
+
+ +
+
+DIRECTION_IN_OUT = 'IN_OUT'
+
+ +
+
+DIRECTION_OUT = 'OUT'
+
+ +
+
+IP_PROTOCOL_IPV4 = 'IPV4'
+
+ +
+
+IP_PROTOCOL_IPV4_IPV6 = 'IPV4_IPV6'
+
+ +
+
+IP_PROTOCOL_IPV6 = 'IPV6'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.FirewallRuleList(rules=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:rules (list of FirewallRule) – List of firewall rules in the section. Only homogenous rules are +supported.
+
+ +
+
+class com.vmware.nsx.model_client.FirewallRuleListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of FirewallRule or None) – Firewall rule list result with pagination support. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.FirewallSection(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, applied_tos=None, is_default=None, rule_count=None, section_type=None, stateful=None, autoplumbed=None, comments=None, enforced_on=None, lock_modified_by=None, lock_modified_time=None, locked=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • applied_tos (list of ResourceReference or None) – List of objects where the rules in this section will be enforced. +This will take precedence over rule level appliedTo.
    • +
  • is_default (bool or None) – It is a boolean flag which reflects whether a distributed service +section is default section or not. Each Layer 3 and Layer 2 section +will have at least and at most one default section. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • rule_count (long or None) – Number of rules in this section. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • section_type (str) –

    Possible values are:

    + +

    Type of the rules which a section can contain. Only homogeneous +sections are supported.

    +
    • +
  • stateful (bool) – Stateful or Stateless nature of distributed service section is +enforced on all rules inside the section. Layer3 sections can be +stateful or stateless. Layer2 sections can only be stateless.
    • +
  • autoplumbed (bool or None) – This flag indicates whether it is an auto-plumbed section that is +associated to a LogicalRouter. Auto-plumbed sections are system +owned and cannot be updated via the API. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • comments (str or None) – Comments for section lock/unlock. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • enforced_on (str or None) – This attribute represents enforcement point of firewall section. +For example, firewall section enforced on logical port with +attachment type bridge endpoint will have ‘BRIDGEENDPOINT’ value, +firewall section enforced on logical router will have +‘LOGICALROUTER’ value and rest have ‘VIF’ value. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • lock_modified_by (str or None) – ID of the user who last modified the lock for the section. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • lock_modified_time (long or None) – Section locked/unlocked time in epoch milliseconds. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • locked (bool or None) – Section is locked/unlocked. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+
+SECTION_TYPE_L3REDIRECT = 'L3REDIRECT'
+
+ +
+
+SECTION_TYPE_LAYER2 = 'LAYER2'
+
+ +
+
+SECTION_TYPE_LAYER3 = 'LAYER3'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.FirewallSectionListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of FirewallSection or None) – List of the firewall sections. The list has to be homogenous. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.FirewallSectionLock(comments=None, section_revision=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • comments (str) – Comments for section lock/unlock.
    • +
  • section_revision (long) – Revision of the section. format: int64
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.FirewallSectionRuleList(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, applied_tos=None, is_default=None, rule_count=None, section_type=None, stateful=None, autoplumbed=None, comments=None, enforced_on=None, lock_modified_by=None, lock_modified_time=None, locked=None, rules=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • applied_tos (list of ResourceReference or None) – List of objects where the rules in this section will be enforced. +This will take precedence over rule level appliedTo.
    • +
  • is_default (bool or None) – It is a boolean flag which reflects whether a distributed service +section is default section or not. Each Layer 3 and Layer 2 section +will have at least and at most one default section. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • rule_count (long or None) – Number of rules in this section. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • section_type (str) –

    Possible values are:

    + +

    Type of the rules which a section can contain. Only homogeneous +sections are supported.

    +
    • +
  • stateful (bool) – Stateful or Stateless nature of distributed service section is +enforced on all rules inside the section. Layer3 sections can be +stateful or stateless. Layer2 sections can only be stateless.
    • +
  • autoplumbed (bool or None) – This flag indicates whether it is an auto-plumbed section that is +associated to a LogicalRouter. Auto-plumbed sections are system +owned and cannot be updated via the API. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • comments (str or None) – Comments for section lock/unlock. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • enforced_on (str or None) – This attribute represents enforcement point of firewall section. +For example, firewall section enforced on logical port with +attachment type bridge endpoint will have ‘BRIDGEENDPOINT’ value, +firewall section enforced on logical router will have +‘LOGICALROUTER’ value and rest have ‘VIF’ value. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • lock_modified_by (str or None) – ID of the user who last modified the lock for the section. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • lock_modified_time (long or None) – Section locked/unlocked time in epoch milliseconds. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • locked (bool or None) – Section is locked/unlocked. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • rules (list of FirewallRule) – List of firewall rules in the section. Only homogenous rules are +supported.
    • +
+
+
+
+SECTION_TYPE_L3REDIRECT = 'L3REDIRECT'
+
+ +
+
+SECTION_TYPE_LAYER2 = 'LAYER2'
+
+ +
+
+SECTION_TYPE_LAYER3 = 'LAYER3'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.FirewallSectionState(details=None, failure_code=None, failure_message=None, state=None, revision_desired=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+STATE_FAILED = 'failed'
+
+ +
+
+STATE_IN_PROGRESS = 'in_progress'
+
+ +
+
+STATE_ORPHANED = 'orphaned'
+
+ +
+
+STATE_PARTIAL_SUCCESS = 'partial_success'
+
+ +
+
+STATE_PENDING = 'pending'
+
+ +
+
+STATE_SUCCESS = 'success'
+
+ +
+
+STATE_UNKNOWN = 'unknown'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.FirewallSectionsSummary(links=None, schema=None, self_=None, rule_count=None, section_count=None, section_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • rule_count (long or None) – Total number of rules in the section. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • section_count (long or None) – Total number of sections for the section type. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • section_type (str or None) –

    Possible values are:

    + +
    +
    Type of rules which a section can contain.
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
+
+
+
+SECTION_TYPE_L2DFW = 'L2DFW'
+
+ +
+
+SECTION_TYPE_L3DFW = 'L3DFW'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.FirewallSectionsSummaryList(last_compute_time=None, sections_summary=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • last_compute_time (long or None) – Timestamp of the last computation, in epoch milliseconds. format: +int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sections_summary (list of FirewallSectionsSummary or None) – List of firewall sections summary. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.FirewallService(is_valid=None, target_display_name=None, target_id=None, target_type=None, service=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • is_valid (bool or None) – Will be set to false if the referenced NSX resource has been +deleted. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • target_display_name (str or None) – Display name of the NSX resource. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • target_id (str or None) – Identifier of the NSX resource.
    • +
  • target_type (str or None) – Type of the NSX resource.
    • +
  • service (vmware.vapi.struct.VapiStruct or None) – Distributed Service API accepts raw protocol and ports as part of +NS service element in Distributed Service Rule that describes +traffic corresponding to an NSService. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +NSServiceElement. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in NSServiceElement.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.FirewallStats(links=None, schema=None, self_=None, byte_count=None, max_popularity_index=None, max_session_count=None, packet_count=None, popularity_index=None, rule_id=None, session_count=None, total_session_count=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • byte_count (long or None) – Aggregated number of bytes processed by the rule. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • max_popularity_index (long or None) – Maximum value of popularity index of all firewall rules of the +type. This is aggregated statistic which are computed with lower +frequency compared to individual generic rule statistics. It may +have a computation delay up to 15 minutes in response to this API. +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • max_session_count (long or None) – Maximum value of sessions count of all firewall rules of the type. +This is aggregated statistic which are computed with lower +frequency compared to generic rule statistics. It may have a +computation delay up to 15 minutes in response to this API. format: +int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • packet_count (long or None) – Aggregated number of packets processed by the rule. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • popularity_index (long or None) – This is calculated by sessions count divided by age of the rule. +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • rule_id (str or None) – Rule Identifier of the Firewall rule. This is a globally unique +number. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • session_count (long or None) – Aggregated number of sessions processed by the rule. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • total_session_count (long or None) – Aggregated number of sessions processed by the all firewall rules. +This is aggregated statistic which are computed with lower +frequency compared to individual generic rule statistics. It may +have a computation delay up to 15 minutes in response to this API. +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.FirewallStatsList(result_count=None, results=None, section_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • result_count (long or None) – Total count for firewall rule statistics in results set format: +int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of FirewallStats or None) – List of rule statistics +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • section_id (str or None) – Corresponding firewall section identifier for list of rule +statistics +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.FirewallStatus(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, context=None, global_status=None, target_statuses=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Firewall Status Response

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • context (str) –

    Possible values are:

    + +
    +
    Types of firewall contexts.
    +
    • +
  • global_status (str) –

    Possible values are:

    + +

    Firewall status for a fabric entity or in global context where +firewall is supported.

    +
    • +
  • target_statuses (list of TargetResourceStatus or None) – List of firewall status on various target logical resources. This +will override the global status of corresponding firewall context +(e.g it will override the gloabal status of logical_routers).
    • +
+
+
+
+CONTEXT_LOGICAL_ROUTERS = 'logical_routers'
+
+ +
+
+CONTEXT_TRANSPORT_NODES = 'transport_nodes'
+
+ +
+
+GLOBAL_STATUS_DISABLED = 'DISABLED'
+
+ +
+
+GLOBAL_STATUS_ENABLED = 'ENABLED'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.FirewallStatusListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

List of firewall statuses for a context or all context

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of FirewallStatus or None) –
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.Footer(actions=None, condition=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Footer of a widget that provides additional information or allows an action +such as clickable url for navigation. An example usage of footer is +provided under ‘example_request’ section of ‘CreateWidgetConfiguration’ +API.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • actions (list of FooterAction or None) – Action to be performed at the footer of a widget. An action at the +footer can be simple text description or a hyperlink to a UI page. +Action allows a clickable url for navigation. An example usage of +footer action is provided under ‘example_request’ section of +‘CreateWidgetConfiguration’ API.
    • +
  • condition (str or None) – If the condition is met then the footer will be applied. Examples +of expression syntax are provided under ‘example_request’ section +of ‘CreateWidgetConfiguration’ API.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.FooterAction(dock_to_container_footer=None, label=None, url=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Action specified at the footer of a widget to provide additional +information or to provide a clickable url for navigation. An example usage +of footer action is provided under the ‘example_request’ section of +‘CreateWidgetConfiguration’ API.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • dock_to_container_footer (bool or None) – If true, the footer will appear in the underlying container that +holds the widget.
    • +
  • label (Label) – Label to be displayed against the footer action.
    • +
  • url (str or None) – Hyperlink to the UI page that provides details of action.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ForwarderZone(source_ip=None, upstream_servers=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • source_ip (str or None) – The source ip used by the fowarder of the zone. If no source ip +specified, the ip address of listener of the dns forwarder will be +used. format: ipv4
    • +
  • upstream_servers (list of str) – Ip address of the upstream dns servers the dns forwarder accesses. +format: ipv4
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.GenericDhcpOption(code=None, values=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • code (long) – dhcp option code, [0-255] format: int64
    • +
  • values (list of str) – dhcp option value
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.GlobalCollectionConfiguration(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, aggregated_data_collection_frequency=None, is_data_collection_enabled=None, modified_feature_stack_collection_configurations=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • aggregated_data_collection_frequency (long) – The frequency in seconds at which data, which is subject to the +aggregation function, is collected. format: int64
    • +
  • is_data_collection_enabled (bool) – Indicates whether data collection required by the aggregation +service is enabled. If false, no aggregation service data will be +collected. Changing this property will not affect the existing data +collection frequency settings.
    • +
  • modified_feature_stack_collection_configurations (FeatureStackCollectionConfigurationList or None) – The list of the locally modified feature stack data collection +frequency settings. If all feature stack data collection +configurations are set to their default values, this list will be +empty.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.GlobalRestoreStatus(description=None, value=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Overall restore process status

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+VALUE_ABORTED = 'ABORTED'
+
+ +
+
+VALUE_ERROR = 'ERROR'
+
+ +
+
+VALUE_NOT_AVAILABLE = 'NOT_AVAILABLE'
+
+ +
+
+VALUE_NOT_STARTED = 'NOT_STARTED'
+
+ +
+
+VALUE_RUNNING = 'RUNNING'
+
+ +
+
+VALUE_SUCCESS = 'SUCCESS'
+
+ +
+
+VALUE_SUSPENDED = 'SUSPENDED'
+
+ +
+
+VALUE_SUSPENDING = 'SUSPENDING'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.GridConfiguration(columns=None, page_size=None, row_list_fields=None, span=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='GridConfiguration', tags=None, datasources=None, drilldown_id=None, footer=None, is_drilldown=None, shared=None, weight=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Represents configuration of a Grid or Table widget.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • columns (list of ColumnItem) – Array of columns of a Grid widget
    • +
  • page_size (long or None) – Number of records per page. page_size will be effective only when +the urls provided in the datasource support paging. format: int32
    • +
  • row_list_fields (list of RowListField) – Rows of grid or table are formed from the list of objects returned +by a row list field.
    • +
  • span (long or None) – Represents the horizontal span of the Grid. format: int32
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str) – Title of the widget.
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +

    Supported visualization types are LabelValueConfiguration, +DonutConfiguration, GridConfiguration, StatsConfiguration, +MultiWidgetConfiguration and ContainerConfiguration.

    +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • datasources (list of Datasource or None) – The ‘datasources’ represent the sources from which data will be +fetched. Currently, only NSX-API is supported as a ‘default’ +datasource. An example of specifying ‘default’ datasource along +with the urls to fetch data from is given at ‘example_request’ +section of ‘CreateWidgetConfiguration’ API.
    • +
  • drilldown_id (str or None) – Id of drilldown widget, if any. Id should be a valid id of an +existing widget. A widget is considered as drilldown widget when it +is associated with any other widget and provides more detailed +information about any data item from the parent widget.
    • +
  • footer (Footer or None) –
    • +
  • is_drilldown (bool or None) – Set to true if this widget should be used as a drilldown.
    • +
  • shared (bool or None) – Please use the property ‘shared’ of View instead of this. The +widgets of a shared view are visible to other users.
    • +
  • weight (long or None) – Specify relavite weight in WidgetItem for placement in a view. +Please see WidgetItem for details. format: int32
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.HaVipConfig(enabled=None, ha_vip_subnets=None, redundant_uplink_port_ids=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • enabled (bool or None) – Flag to enable this ha vip config.
    • +
  • ha_vip_subnets (list of VIPSubnet) – Array of IP address subnets which will be used as floating IP +addresses. | Note - this configuration is applicable only for +Active-Standby LogicalRouter. | For Active-Active LogicalRouter +this configuration will be rejected.
    • +
  • redundant_uplink_port_ids (list of str) – Identifiers of logical router uplink ports which are to be paired +to provide | redundancy. Floating IP will be owned by one of these +uplink ports (depending upon | which node is Active).
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.HeatMapTransportNodesAggregateStatus(degraded_count=None, down_count=None, unknown_count=None, up_count=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • degraded_count (long or None) – Number of transport nodes that are degraded format: int32
    • +
  • down_count (long or None) – Number of transport nodes that are down format: int32
    • +
  • unknown_count (long or None) – Number of transport nodes with unknown status format: int32
    • +
  • up_count (long or None) – Number of transport nodes that are up format: int32
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.HeatMapTransportZoneStatus(degraded_count=None, down_count=None, unknown_count=None, up_count=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • degraded_count (long or None) – Number of transport nodes that are degraded format: int32
    • +
  • down_count (long or None) – Number of transport nodes that are down format: int32
    • +
  • unknown_count (long or None) – Number of transport nodes with unknown status format: int32
    • +
  • up_count (long or None) – Number of transport nodes that are up format: int32
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.HostAggregateInfo(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, host=None, status=None, transport_node=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Aggregation of desired and runtime status of host

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • host (HostNode or None) – Host attributes
    • +
  • status (NodeStatus or None) – Host status
    • +
  • transport_node (TransportNode or None) –
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.HostAggregateInfoListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Host aggregate state list result

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of HostAggregateInfo) – Host Aggregate Info Results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.HostInfraTrafficType(dynamic_res_pool_name=None, traffic_name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The traffic_name specifies the infrastructure traffic type and it must be +one of the following system-defined types: FAULT_TOLERANCE is traffic for +failover and recovery. HBR is traffic for Host based replication. ISCSI is +traffic for Internet Small Computer System Interface. MANAGEMENT is traffic +for host management. NFS is traffic related to file transfer in network +file system. VDP is traffic for vSphere data protection. VIRTUAL_MACHINE is +traffic generated by virtual machines. VMOTION is traffic for computing +resource migration. VSAN is traffic generated by virtual storage area +network. The dynamic_res_pool_name provides a name for the resource pool. +It can be any arbitrary string. Either traffic_name or +dynamic_res_pool_name must be set. If both are specified or omitted, an +error will be returned.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+TRAFFIC_NAME_FAULT_TOLERANCE = 'FAULT_TOLERANCE'
+
+ +
+
+TRAFFIC_NAME_HBR = 'HBR'
+
+ +
+
+TRAFFIC_NAME_ISCSI = 'ISCSI'
+
+ +
+
+TRAFFIC_NAME_MANAGEMENT = 'MANAGEMENT'
+
+ +
+
+TRAFFIC_NAME_NFS = 'NFS'
+
+ +
+
+TRAFFIC_NAME_VDP = 'VDP'
+
+ +
+
+TRAFFIC_NAME_VIRTUAL_MACHINE = 'VIRTUAL_MACHINE'
+
+ +
+
+TRAFFIC_NAME_VMOTION = 'VMOTION'
+
+ +
+
+TRAFFIC_NAME_VSAN = 'VSAN'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.HostNode(discovered_node_id=None, host_credential=None, managed_by_server=None, os_type=None, os_version=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='HostNode', tags=None, discovered_ip_addresses=None, external_id=None, fqdn=None, ip_addresses=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • discovered_node_id (str or None) – Id of the discovered node which was converted to create this node +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • host_credential (HostNodeLoginCredential or None) – Login credentials for the host
    • +
  • managed_by_server (str or None) – The id of the virtual center server managing the ESXi type +HostNode. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • os_type (str) –

    Possible values are:

    + +
    +
    Hypervisor type, for example ESXi or RHEL KVM.
    +
    • +
  • os_version (str or None) – The version of the hypervisor operating system.
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) – Fabric node type, for example ‘HostNode’, ‘EdgeNode’ or +‘PublicCloudGatewayNode’
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • discovered_ip_addresses (list of str or None) – Discovered IP Addresses of the fabric node, version 4 or 6 format: +ip +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • external_id (str or None) – ID of the Node maintained on the Node and used to recognize the +Node
    • +
  • fqdn (str or None) – Fully qualified domain name of the fabric node +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • ip_addresses (list of str or None) – IP Addresses of the Node, version 4 or 6. This property is +mandatory for all nodes except for automatic deployment of edge +virtual machine node. For automatic deployment, the ip address from +management_port_subnets property will be considered. format: ip
    • +
+
+
+
+OS_TYPE_CENTOSKVM = 'CENTOSKVM'
+
+ +
+
+OS_TYPE_CENTOSSERVER = 'CENTOSSERVER'
+
+ +
+
+OS_TYPE_ESXI = 'ESXI'
+
+ +
+
+OS_TYPE_HYPERV = 'HYPERV'
+
+ +
+
+OS_TYPE_RHELCONTAINER = 'RHELCONTAINER'
+
+ +
+
+OS_TYPE_RHELKVM = 'RHELKVM'
+
+ +
+
+OS_TYPE_RHELSERVER = 'RHELSERVER'
+
+ +
+
+OS_TYPE_UBUNTUKVM = 'UBUNTUKVM'
+
+ +
+
+OS_TYPE_UBUNTUSERVER = 'UBUNTUSERVER'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.HostNodeLoginCredential(password=None, thumbprint=None, username=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The credentials to login into the host node

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • password (str or None) – The authentication password of the host node
    • +
  • thumbprint (str or None) – For ESXi hosts, the thumbprint of the ESXi management service. For +KVM hosts, the SSH key fingerprint.
    • +
  • username (str or None) – The username of the account on the host node
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.HostProfileNetworkMigrationSpec(network_mappings=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='HostProfileNetworkMigrationSpec', tags=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This specification should be used to define which VMK adapters need to be +migrated to NSX logical switches from VC network switches. Migrations +specified here should match with those from associated Host Profiles from +VC. Mismatch will result in migration failures. This specification only +supports migration vmkernal adapters to NSX logical switches.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • network_mappings (list of VmkToLogicalSwitchMapping or None) – Based on provided mappings, VMkernal adapters will be migrated to +mentioned logical switch. Without mappings specification doesn’t +make any sense, hence minium one mapping should be specified. +Assuming some sane value of 10 maximum migrations which will be +supported by any single specification.
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.HostSwitch(host_switch_name=None, host_switch_profile_ids=None, pnics=None, static_ip_pool_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Host Switch specification

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • host_switch_name (str or None) – If this name is unset or empty then the default host switch name +will be used. The name must be unique among all host switches +specified in a given Transport Node; unset name, empty name and the +default host switch name are considered the same in terms of +uniqueness.
    • +
  • host_switch_profile_ids (list of HostSwitchProfileTypeIdEntry or None) – HostSwitch profiles bound to this HostSwitch. If a profile ID is +not provided for any HostSwitchProfileType that is supported by the +Transport Node, the corresponding default profile will be bound to +the HostSwitch.
    • +
  • pnics (list of Pnic or None) – Physical NICs connected to the host switch
    • +
  • static_ip_pool_id (str or None) – ID of configured Static IP Pool. If specified allocate IP for +Endpoints from Pool. Else assume IP will be assigned for Endpoints +from DHCP. This field is deprecated, use ip_assignment_spec field +instead.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.HostSwitchProfileTypeIdEntry(key=None, value=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+KEY_EXTRACONFIGHOSTSWITCHPROFILE = 'ExtraConfigHostSwitchProfile'
+
+ +
+
+KEY_LLDPHOSTSWITCHPROFILE = 'LldpHostSwitchProfile'
+
+ +
+
+KEY_NIOCPROFILE = 'NiocProfile'
+
+ +
+
+KEY_UPLINKHOSTSWITCHPROFILE = 'UplinkHostSwitchProfile'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.HostSwitchProfilesListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

HostSwitch Profile queries result

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of vmware.vapi.struct.VapiStruct or None) – HostSwitch Profile Results +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +BaseHostSwitchProfile. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in BaseHostSwitchProfile. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.HostSwitchSpec(resource_type='HostSwitchSpec')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The HostSwitchSpec is the base class for standard and preconfigured host +switch specifications.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:resource_type (str) –

Possible values are:

+ +
+
+
+RESOURCE_TYPE_PRECONFIGUREDHOSTSWITCHSPEC = 'PreconfiguredHostSwitchSpec'
+
+ +
+
+RESOURCE_TYPE_STANDARDHOSTSWITCHSPEC = 'StandardHostSwitchSpec'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.HostSwitchState(endpoints=None, host_switch_id=None, host_switch_name=None, transport_zone_ids=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Host Switch State

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • endpoints (list of Endpoint or None) – List of virtual tunnel endpoints which are configured on this +switch +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • host_switch_id (str or None) – External ID of the HostSwitch +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • host_switch_name (str or None) – The name must be unique among all host switches specified in a +given Transport Node. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • transport_zone_ids (list of str or None) – List of Ids of TransportZones this HostSwitch belongs to +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.HostUpgradeStatus(can_skip=None, component_type=None, details=None, percent_complete=None, status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Status of host upgrade

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • can_skip (bool or None) – Can the upgrade of the remaining units in this component be skipped +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • component_type (str or None) – Component type for the upgrade status +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • details (str or None) – Details about the upgrade status +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • percent_complete (float or None) – Indicator of upgrade progress in percentage +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • status (str or None) –

    Possible values are:

    + +
    +
    Upgrade status of component
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
+
+
+
+STATUS_FAILED = 'FAILED'
+
+ +
+
+STATUS_IN_PROGRESS = 'IN_PROGRESS'
+
+ +
+
+STATUS_NOT_STARTED = 'NOT_STARTED'
+
+ +
+
+STATUS_PAUSED = 'PAUSED'
+
+ +
+
+STATUS_SUCCESS = 'SUCCESS'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.HttpProtocol(authentication_scheme=None, name='HttpProtocol')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+ +
+
+class com.vmware.nsx.model_client.HttpServiceProperties(certificate=None, cipher_suites=None, client_api_concurrency_limit=None, client_api_rate_limit=None, connection_timeout=None, global_api_concurrency_limit=None, protocol_versions=None, redirect_host=None, session_timeout=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

HTTP Service properties

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • certificate (Certificate or None) –
    • +
  • cipher_suites (list of CipherSuite or None) – Cipher suites used to secure contents of connection
    • +
  • client_api_concurrency_limit (long or None) – The maximum number of concurrent API requests that will be serviced +for a given authenticated client. If the number of API requests +being processed exceeds this limit, new API requests will be +refused and a 503 Service Unavailable response will be returned to +the client. To disable API concurrency limiting, set this value to +0. format: int64
    • +
  • client_api_rate_limit (long or None) – The maximum number of API requests that will be serviced per second +for a given authenticated client. If more API requests are received +than can be serviced, a 429 Too Many Requests HTTP response will be +returned. To disable API rate limiting, set this value to 0. +format: int64
    • +
  • connection_timeout (long or None) – NSX connection timeout, set to 0 to configure no timeout format: +int64
    • +
  • global_api_concurrency_limit (long or None) – The maximum number of concurrent API requests that will be +serviced. If the number of API requests being processed exceeds +this limit, new API requests will be refused and a 503 Service +Unavailable response will be returned to the client. To disable API +concurrency limiting, set this value to 0. format: int64
    • +
  • protocol_versions (list of ProtocolVersion or None) – TLS protocol versions
    • +
  • redirect_host (str or None) – Host name or IP address to use for redirect location headers, or +empty string to derive from current request
    • +
  • session_timeout (long or None) – NSX session inactivity timeout, set to 0 to configure no timeout +format: int64
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.HttpsProtocol(authentication_scheme=None, sha256_thumbprint=None, name='HttpsProtocol')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+ +
+
+class com.vmware.nsx.model_client.ICMPTypeNSService(icmp_code=None, icmp_type=None, protocol=None, resource_type='ICMPTypeNSService')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

A NSService that represents IPv4 or IPv6 ICMP protocol

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+PROTOCOL_ICMPV4 = 'ICMPv4'
+
+ +
+
+PROTOCOL_ICMPV6 = 'ICMPv6'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.IGMPTypeNSService(resource_type='IGMPTypeNSService')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

A NSService that represents IGMP protocol

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:resource_type (str) –

Possible values are:

+ +
+
The specific type of NSServiceElement
+
+
+ +
+
+class com.vmware.nsx.model_client.IPInfo(ip_addresses=None, prefix_length=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • ip_addresses (list of str) – IPv4 Addresses format: ipv4
    • +
  • prefix_length (long) – Subnet Prefix Length format: int64
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IPMirrorDestination(destination_ips=None, encapsulation_type=None, erspan_id=None, gre_key=None, resource_type='IPMirrorDestination')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+ENCAPSULATION_TYPE_ERSPAN_THREE = 'ERSPAN_THREE'
+
+ +
+
+ENCAPSULATION_TYPE_ERSPAN_TWO = 'ERSPAN_TWO'
+
+ +
+
+ENCAPSULATION_TYPE_GRE = 'GRE'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.IPPrefixList(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, logical_router_id=None, prefixes=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • logical_router_id (str or None) – Logical router id +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • prefixes (list of PrefixConfig) – Ordered list of PrefixConfig
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IPPrefixListListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of IPPrefixList) – Paginated list of IPPrefixLists
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IPProtocolNSService(protocol_number=None, resource_type='IPProtocolNSService')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

An NSService element that represents an IP protocol

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+ +
+
+class com.vmware.nsx.model_client.IPSecVPNDPDProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, dpd_probe_interval=None, enabled=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Dead peer detection (DPD) is a method that allows detection of unreachable +internet key excahnge (IKE) peers. Any changes affects all IPSec VPN +sessions consuming this profile.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • dpd_probe_interval (long or None) – DPD probe interval defines a periodic interval for DPD probes. +format: int64
    • +
  • enabled (bool or None) – If true, enable dead peer detection.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IPSecVPNDPDProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

List all the dead peer detection (DPD) profiles.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of IPSecVPNDPDProfile) – IPSec DPD Profile list results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IPSecVPNIKEProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, dh_groups=None, digest_algorithms=None, encryption_algorithms=None, ike_version=None, sa_life_time=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

IKE Profile is a reusable profile that captures IKE phase one negotiation +parameters. Any changes affects all IPSec VPN sessions consuming this +profile.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • dh_groups (list of str or None) –

    Possible values are:

    + +

    Diffie-Hellman group to be used if PFS is enabled. Default is +GROUP14.

    +
    • +
  • digest_algorithms (list of str or None) –

    Possible values are:

    + +

    Algorithm to be used for message digest during Internet Key +Exchange(IKE) negotiation. Default is SHA2_256.

    +
    • +
  • encryption_algorithms (list of str or None) –

    Possible values are:

    + +

    Encryption algorithm is used during Internet Key Exchange(IKE) +negotiation. Default is AES_128.

    +
    • +
  • ike_version (str or None) –

    Possible values are:

    + +

    IKE protocol version to be used. IKE-Flex will initiate IKE-V2 and +responds to both IKE-V1 and IKE-V2.

    +
    • +
  • sa_life_time (long or None) – Life time for security association. Default is 86400 seconds (1 +day). format: int64
    • +
+
+
+
+DH_GROUPS_GROUP14 = 'GROUP14'
+
+ +
+
+DH_GROUPS_GROUP15 = 'GROUP15'
+
+ +
+
+DH_GROUPS_GROUP16 = 'GROUP16'
+
+ +
+
+DH_GROUPS_GROUP2 = 'GROUP2'
+
+ +
+
+DH_GROUPS_GROUP5 = 'GROUP5'
+
+ +
+
+DIGEST_ALGORITHMS_SHA1 = 'SHA1'
+
+ +
+
+DIGEST_ALGORITHMS_SHA2_256 = 'SHA2_256'
+
+ +
+
+DIGEST_ALGORITHMS_SHA2_384 = 'SHA2_384'
+
+ +
+
+DIGEST_ALGORITHMS_SHA2_512 = 'SHA2_512'
+
+ +
+
+ENCRYPTION_ALGORITHMS_128 = 'AES_128'
+
+ +
+
+ENCRYPTION_ALGORITHMS_256 = 'AES_256'
+
+ +
+
+ENCRYPTION_ALGORITHMS_GCM_128 = 'AES_GCM_128'
+
+ +
+
+ENCRYPTION_ALGORITHMS_GCM_192 = 'AES_GCM_192'
+
+ +
+
+ENCRYPTION_ALGORITHMS_GCM_256 = 'AES_GCM_256'
+
+ +
+
+IKE_VERSION_FLEX = 'IKE_FLEX'
+
+ +
+
+IKE_VERSION_V1 = 'IKE_V1'
+
+ +
+
+IKE_VERSION_V2 = 'IKE_V2'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.IPSecVPNIKEProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

List all the IKE profiles.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of IPSecVPNIKEProfile) – IKE Profile list results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IPSecVPNIKEServiceSummary(aggregate_traffic_counters=None, last_update_timestamp=None, session_summary=None, traffic_summary_per_session=None, display_name=None, ipsec_vpn_service_id=None, logical_router_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Summarized view of all IPSec VPN sessions for a specified service.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • aggregate_traffic_counters (IPSecVPNTrafficCounters or None) – Aggregate traffic statistics across all selected sessions.
    • +
  • last_update_timestamp (long or None) – Timestamp when the data was last updated. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • session_summary (IPsecVPNIKESessionSummary or None) – Session summary for number of total, established, failed and +degraded IPSec VPN sessions.
    • +
  • traffic_summary_per_session (list of IPSecVPNSessionTrafficSummary or None) – Traffic summary per session.
    • +
  • display_name (str or None) – VPN service display name. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • ipsec_vpn_service_id (str or None) – UUID for a vpn service. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • logical_router_id (str or None) – Logical router identifier associated with vpn service. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IPSecVPNIKESessionStatus(fail_reason=None, ike_session_state=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Status for IPSec VPN IKE session UP, DOWN, NEGOTIATING and fail reason if +IKE session is down.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+IKE_SESSION_STATE_DOWN = 'DOWN'
+
+ +
+
+IKE_SESSION_STATE_NEGOTIATING = 'NEGOTIATING'
+
+ +
+
+IKE_SESSION_STATE_UP = 'UP'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.IPSecVPNIKETrafficStatistics(bytes_in=None, bytes_out=None, fail_count=None, packets_in=None, packets_out=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Traffic statistics for IPSec VPN IKE session.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • bytes_in (long or None) – Number of bytes in. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • bytes_out (long or None) – Number of bytes out. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • fail_count (long or None) – Fail count. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • packets_in (long or None) – Number of packets in. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • packets_out (long or None) – Number of packets out. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IPSecVPNLocalEndpoint(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, certificate_id=None, ipsec_vpn_service_id=None, local_address=None, local_id=None, trust_ca_ids=None, trust_crl_ids=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Local endpoint represents a logical router on which tunnel needs to be +terminated.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • certificate_id (str or None) – Site certificate identifier. Field is marked for future use. +Certificate based authentication is not supported.
    • +
  • ipsec_vpn_service_id (ResourceReference) – VPN Service id.
    • +
  • local_address (str) – IPV4 Address for local endpoint. format: ipv4
    • +
  • local_id (str or None) – Local identifier.
    • +
  • trust_ca_ids (list of str or None) – Certificate authority (CA) identifier list to verify peer +certificates. Field is marked for future use. Certificate based +authentication is not supported.
    • +
  • trust_crl_ids (list of str or None) – Certificate revocation list (CRL) identifier list to peer +certificates. Field is marked for future use. Certificate based +authentication is not supported.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IPSecVPNLocalEndpointListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

List all the local endpoints.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of IPSecVPNLocalEndpoint) – IPSec local endpoint list results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IPSecVPNPeerEndpoint(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, authentication_mode=None, connection_initiation_mode=None, dpd_profile_id=None, ike_profile_id=None, ipsec_tunnel_profile_id=None, peer_address=None, peer_id=None, psk=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

IPSec VPN Peer Endpoint covers configuration to be applied locally to +establish a session with remote endpoint on peer site.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • authentication_mode (str or None) –

    Possible values are:

    + +

    For peer authentication only Pre shared key (PSK) mode will be +supported.

    +
    • +
  • connection_initiation_mode (str or None) –

    Possible values are:

    + +

    Connection initiation mode used by local endpoint to establish ike +connection with peer endpoint. INITIATOR - In this mode local +endpoint initiates tunnel setup and will also respond to incoming +tunnel setup requests from peer gateway. RESPOND_ONLY - In this +mode, local endpoint shall only respond to incoming tunnel setup +requests. It shall not initiate the tunnel setup. ON_DEMAND - In +this mode local endpoint will initiate tunnel creation once first +packet matching the policy rule is received and will also respond +to incoming initiation request.

    +
    • +
  • dpd_profile_id (str or None) – Dead peer detection (DPD) profile id. Default will be set according +to system default policy.
    • +
  • ike_profile_id (str or None) – IKE profile id to be used. Default will be set according to system +default policy.
    • +
  • ipsec_tunnel_profile_id (str or None) – Tunnel profile id to be used. By default it will point to system +default profile.
    • +
  • peer_address (str) – IPV4 address of peer endpoint on remote site.
    • +
  • peer_id (str) – Peer identifier.
    • +
  • psk (str or None) – IPSec Pre-shared key. Maximum length of this field is 128 +characters.
    • +
+
+
+
+AUTHENTICATION_MODE_PSK = 'PSK'
+
+ +
+
+CONNECTION_INITIATION_MODE_INITIATOR = 'INITIATOR'
+
+ +
+
+CONNECTION_INITIATION_MODE_ON_DEMAND = 'ON_DEMAND'
+
+ +
+
+CONNECTION_INITIATION_MODE_RESPOND_ONLY = 'RESPOND_ONLY'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.IPSecVPNPeerEndpointListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

List all the peer endpoints.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of IPSecVPNPeerEndpoint) – IPSec Peer endpoint list results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IPSecVPNPolicyRule(links=None, schema=None, self_=None, revision=None, owner=None, description=None, display_name=None, id=None, resource_type=None, action=None, destinations=None, enabled=None, logged=None, sources=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

For policy-based IPsec VPNs, a security policy specifies as its action the +VPN tunnel to be used for transit traffic that meets the policy’s match +criteria.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • owner (OwnerResourceLink or None) – Owner of this resource
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique policy id.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • action (str or None) –

    Possible values are:

    + +

    PROTECT - Protect rules are defined per policy based IPSec VPN +session. BYPASS - Bypass rules are defined per IPSec VPN service +and affects all policy based IPSec VPN sessions. Bypass rules are +prioritized over protect rules. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • destinations (list of IPSecVPNPolicySubnet or None) – List of peer subnets.
    • +
  • enabled (bool or None) – A flag to enable/disable the policy rule.
    • +
  • logged (bool or None) – A flag to enable/disable the logging for the policy rule.
    • +
  • sources (list of IPSecVPNPolicySubnet or None) – List of local subnets.
    • +
+
+
+
+ACTION_BYPASS = 'BYPASS'
+
+ +
+
+ACTION_PROTECT = 'PROTECT'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.IPSecVPNPolicySubnet(subnet=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Used to specify the local/peer subnets in IPSec VPN Policy rule.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:subnet (str) – Subnet used in policy rule. format: ipv4-cidr-block
+
+ +
+
+class com.vmware.nsx.model_client.IPSecVPNPolicyTrafficStatistics(aggregate_traffic_counters=None, policy_id=None, tunnel_port_id=None, tunnel_statistics=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

IPSec VPN policy traffic statistics

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • aggregate_traffic_counters (IPSecVPNTrafficCounters or None) – Aggregate traffic statistics across all ipsec tunnels.
    • +
  • policy_id (str or None) – Policy Identifier. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • tunnel_port_id (str or None) – Tunnel port identifier. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • tunnel_statistics (list of IPSecVPNTunnelTrafficStatistics or None) – Tunnel statistics. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IPSecVPNService(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, bypass_rules=None, enabled=None, ike_log_level=None, logical_router_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Create and manage IPSec VPN service for given logical router.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • bypass_rules (list of IPSecVPNPolicyRule or None) – Bypass policy rules are configured using VPN service. Bypass rules +always have higher priority over protect rules and they affect all +policy based vpn sessions associated with the IPSec VPN service. +Protect rules are defined per policy based vpn session.
    • +
  • enabled (bool or None) – If true, enable VPN services for given logical router.
    • +
  • ike_log_level (str or None) –

    Possible values are:

    + +
    +
    Log level for internet key exchange (IKE).
    +
    • +
  • logical_router_id (str) – Logical router id.
    • +
+
+
+
+IKE_LOG_LEVEL_DEBUG = 'DEBUG'
+
+ +
+
+IKE_LOG_LEVEL_EMERGENCY = 'EMERGENCY'
+
+ +
+
+IKE_LOG_LEVEL_ERROR = 'ERROR'
+
+ +
+
+IKE_LOG_LEVEL_INFO = 'INFO'
+
+ +
+
+IKE_LOG_LEVEL_WARN = 'WARN'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.IPSecVPNServiceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

List all the IPSec VPN services.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of IPSecVPNService) – IPSec VPN serivce list result
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IPSecVPNSession(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='IPSecVPNSession', tags=None, enabled=None, ipsec_vpn_service_id=None, local_endpoint_id=None, peer_endpoint_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

VPN session defines connection between local and peer endpoint. Untill VPN +session is defined configuration is not realized.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +

    A Policy Based VPN requires to define protect rules that match +local and peer subnets. IPSec security associations is negotiated +for each pair of local and peer subnet. A Route Based VPN is more +flexible, more powerful and recommended over policy based VPN. IP +Tunnel port is created and all traffic routed via tunnel port is +protected. Routes can be configured statically or can be learned +through BGP. A route based VPN is must for establishing redundant +VPN session to remote site.

    +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • enabled (bool or None) – Enable/Disable IPSec VPN session.
    • +
  • ipsec_vpn_service_id (str or None) – Identifier of VPN Service linked with local endpoint. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • local_endpoint_id (str) – Local endpoint identifier.
    • +
  • peer_endpoint_id (str) – Peer endpoint identifier.
    • +
+
+
+
+RESOURCE_TYPE_POLICYBASEDIPSECVPNSESSION = 'PolicyBasedIPSecVPNSession'
+
+ +
+
+RESOURCE_TYPE_ROUTEBASEDIPSECVPNSESSION = 'RouteBasedIPSecVPNSession'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.IPSecVPNSessionListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

List all the IPSec VPN sessions.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of vmware.vapi.struct.VapiStruct) – IPSec VPN sessions list result +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +IPSecVPNSession. When methods return a value of this class +as a return value, the attribute will contain all the attributes +defined in IPSecVPNSession.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IPSecVPNSessionStatistics(aggregate_traffic_counters=None, display_name=None, ike_status=None, ike_traffic_statistics=None, ipsec_vpn_session_id=None, last_update_timestamp=None, partial_stats=None, policy_statistics=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Session statistics gives aggregated statistics of all policies for all the +tunnels.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • aggregate_traffic_counters (IPSecVPNTrafficCounters or None) – Aggregate traffic statistics across all ipsec tunnels.
    • +
  • display_name (str or None) – Display name of vpn session. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • ike_status (IPSecVPNIKESessionStatus or None) – Status for IPSec VPN IKE session UP/DOWN and fail reason if IKE +session is down.
    • +
  • ike_traffic_statistics (IPSecVPNIKETrafficStatistics or None) – Traffic statistics for IPSec VPN IKE session.
    • +
  • ipsec_vpn_session_id (str or None) – UUID of vpn session. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_update_timestamp (long or None) – Timestamp when the data was last updated. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • partial_stats (bool or None) – Partial statistics if true specifies that the statistics are only +from active node. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • policy_statistics (list of IPSecVPNPolicyTrafficStatistics or None) – Gives aggregate traffic statistics across all ipsec tunnels and +individual tunnel statistics. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IPSecVPNSessionStatus(aggregate_traffic_counters=None, display_name=None, failed_tunnels=None, ike_status=None, ipsec_vpn_session_id=None, last_update_timestamp=None, negotiated_tunnels=None, session_status=None, total_tunnels=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

IKE session traffic summary provides IKE session status and aggregate of +traffic across all tunnel.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • aggregate_traffic_counters (IPSecVPNTrafficCounters or None) – Aggregate traffic statistics across all ipsec tunnels.
    • +
  • display_name (str or None) – Display name of vpn session. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • failed_tunnels (long or None) – Number of failed tunnels. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • ike_status (IPSecVPNIKESessionStatus or None) – Status for IPSec VPN IKE session UP/DOWN and fail reason if IKE +session is down.
    • +
  • ipsec_vpn_session_id (str or None) – UUID of vpn session. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_update_timestamp (long or None) – Timestamp when the data was last updated. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • negotiated_tunnels (long or None) – Number of negotiated tunnels. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • session_status (str or None) –

    Possible values are:

    + +

    Gives session status consolidated using IKE status and tunnel +status. It can be UP, DOWN, DEGRADED. If IKE and all tunnels are UP +status will be UP, if all down it will be DOWN, otherwise it will +be DEGRADED. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • total_tunnels (long or None) – Total number of tunnels. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+
+SESSION_STATUS_DEGRADED = 'DEGRADED'
+
+ +
+
+SESSION_STATUS_DOWN = 'DOWN'
+
+ +
+
+SESSION_STATUS_UP = 'UP'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.IPSecVPNSessionSummary(aggregate_traffic_counters=None, last_update_timestamp=None, session_summary=None, traffic_summary_per_session=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Summarized view of all selected IPSec VPN sessions.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • aggregate_traffic_counters (IPSecVPNTrafficCounters or None) – Aggregate traffic statistics across all selected sessions.
    • +
  • last_update_timestamp (long or None) – Timestamp when the data was last updated. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • session_summary (IPsecVPNIKESessionSummary or None) – Session summary for number of total, established, failed and +degraded IPSec VPN sessions.
    • +
  • traffic_summary_per_session (list of IPSecVPNSessionTrafficSummary or None) – Traffic summary per session.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IPSecVPNSessionTrafficSummary(ipsec_vpn_session=None, traffic_counters=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

IPSec VPN session traffic summary.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+ +
+
+class com.vmware.nsx.model_client.IPSecVPNTrafficCounters(bytes_in=None, bytes_out=None, dropped_packets_in=None, dropped_packets_out=None, packets_in=None, packets_out=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Traffic counters for IPSec VPN session.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • bytes_in (long or None) – Total number of bytes recevied. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • bytes_out (long or None) – Total number of bytes sent. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • dropped_packets_in (long or None) – Total number of incoming packets dropped on inbound security +association. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • dropped_packets_out (long or None) – Total number of outgoing packets dropped on outbound security +association. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • packets_in (long or None) – Total number of packets received. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • packets_out (long or None) – Total number of packets sent. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IPSecVPNTransportStatus(status=None, resource_type='IPSecVPNTransportStatus', tunnel_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Provides IPSec VPN session status.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+ +
+
+class com.vmware.nsx.model_client.IPSecVPNTunnelProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, df_policy=None, dh_groups=None, digest_algorithms=None, enable_perfect_forward_secrecy=None, encapsulation_mode=None, encryption_algorithms=None, sa_life_time=None, transform_protocol=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

IPSec VPN tunnel profile is a reusable profile that captures phase two +negotiation parameters and tunnel properties. Any changes affects all IPSec +VPN sessions consuming this profile.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • df_policy (str or None) –

    Possible values are:

    + +

    Defragmentation policy helps to handle defragmentation bit present +in the inner packet. COPY copies the defragmentation bit from the +inner IP packet into the outer packet. CLEAR ignores the +defragmentation bit present in the inner packet.

    +
    • +
  • dh_groups (list of str or None) –

    Possible values are:

    + +

    Diffie-Hellman group to be used if PFS is enabled. Default is +GROUP14.

    +
    • +
  • digest_algorithms (list of str or None) –

    Possible values are:

    + +

    Algorithm to be used for message digest. Default digest algorithm +is implicitly covered by default encryption algorithm +"AES_GCM_128".

    +
    • +
  • enable_perfect_forward_secrecy (bool or None) – If true, perfect forward secrecy (PFS) is enabled.
    • +
  • encapsulation_mode (str or None) –

    Possible values are:

    + +

    Encapsulation Mode to be used for encryption of packet. Tunnel mode +protects internal routing information by encrypting IP header of +original packet. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • encryption_algorithms (list of str or None) –

    Possible values are:

    + +

    Encryption algorithm to encrypt/decrypt the messages exchanged +between IPSec VPN initiator and responder during tunnel +negotiation. Default is AES_GCM_128.

    +
    • +
  • sa_life_time (long or None) – SA life time specifies the expiry time of security association. +Default is 3600 seconds. format: int64
    • +
  • transform_protocol (str or None) –

    Possible values are:

    + +
    +
    IPSec transform specifies IPSec security protocol.
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
+
+
+
+DF_POLICY_CLEAR = 'CLEAR'
+
+ +
+
+DF_POLICY_COPY = 'COPY'
+
+ +
+
+DH_GROUPS_GROUP14 = 'GROUP14'
+
+ +
+
+DH_GROUPS_GROUP15 = 'GROUP15'
+
+ +
+
+DH_GROUPS_GROUP16 = 'GROUP16'
+
+ +
+
+DH_GROUPS_GROUP2 = 'GROUP2'
+
+ +
+
+DH_GROUPS_GROUP5 = 'GROUP5'
+
+ +
+
+DIGEST_ALGORITHMS_SHA1 = 'SHA1'
+
+ +
+
+DIGEST_ALGORITHMS_SHA2_256 = 'SHA2_256'
+
+ +
+
+DIGEST_ALGORITHMS_SHA2_384 = 'SHA2_384'
+
+ +
+
+DIGEST_ALGORITHMS_SHA2_512 = 'SHA2_512'
+
+ +
+
+ENCAPSULATION_MODE_MODE = 'TUNNEL_MODE'
+
+ +
+
+ENCRYPTION_ALGORITHMS_AES_128 = 'AES_128'
+
+ +
+
+ENCRYPTION_ALGORITHMS_AES_256 = 'AES_256'
+
+ +
+
+ENCRYPTION_ALGORITHMS_AES_GCM_128 = 'AES_GCM_128'
+
+ +
+
+ENCRYPTION_ALGORITHMS_AES_GCM_192 = 'AES_GCM_192'
+
+ +
+
+ENCRYPTION_ALGORITHMS_AES_GCM_256 = 'AES_GCM_256'
+
+ +
+
+ENCRYPTION_ALGORITHMS_NO_ENCRYPTION = 'NO_ENCRYPTION'
+
+ +
+
+ENCRYPTION_ALGORITHMS_NO_ENCRYPTION_AUTH_AES_GMAC_128 = 'NO_ENCRYPTION_AUTH_AES_GMAC_128'
+
+ +
+
+ENCRYPTION_ALGORITHMS_NO_ENCRYPTION_AUTH_AES_GMAC_192 = 'NO_ENCRYPTION_AUTH_AES_GMAC_192'
+
+ +
+
+ENCRYPTION_ALGORITHMS_NO_ENCRYPTION_AUTH_AES_GMAC_256 = 'NO_ENCRYPTION_AUTH_AES_GMAC_256'
+
+ +
+
+TRANSFORM_PROTOCOL_ESP = 'ESP'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.IPSecVPNTunnelProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

List all the tunnel profiles.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of IPSecVPNTunnelProfile) – IPSec Tunnel Profile list results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IPSecVPNTunnelTrafficStatistics(bytes_in=None, bytes_out=None, decryption_failures=None, dropped_packets_in=None, dropped_packets_out=None, encryption_failures=None, integrity_failures=None, local_subnet=None, nomatching_policy_errors=None, packets_in=None, packets_out=None, packets_receive_other_error=None, packets_sent_other_error=None, peer_subnet=None, replay_errors=None, sa_mismatch_errors_in=None, sa_mismatch_errors_out=None, seq_number_overflow_error=None, tunnel_down_reason=None, tunnel_status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

IPSec VPN tunnel traffic statistics.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • bytes_in (long or None) – Total number of incoming bytes on inbound Security association +(SA). format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • bytes_out (long or None) – Total number of outgoing bytes on outbound Security association +(SA). format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • decryption_failures (long or None) – Total number of packets dropped due to decryption failures. format: +int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • dropped_packets_in (long or None) – Total number of incoming packets dropped on inbound security +association. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • dropped_packets_out (long or None) – Total number of outgoing packets dropped on outbound security +association. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • encryption_failures (long or None) – Total number of packets dropped because of failure in encryption. +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • integrity_failures (long or None) – Total number of packets dropped due to integrity failures. format: +int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • local_subnet (str or None) – Local subnet to which a tunnel belongs. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • nomatching_policy_errors (long or None) – Number of packets dropped because of no matching policy is +available. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • packets_in (long or None) – Total number of incoming packets on inbound Security association +(SA). format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • packets_out (long or None) – Total number of outgoing packets on outbound Security association +(SA). format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • packets_receive_other_error (long or None) – Total number of incoming packets dropped on inbound Security +association (SA)(misc). format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • packets_sent_other_error (long or None) – Total number of packets dropped while sending for any reason. +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • peer_subnet (str or None) – Peer subnet to which a tunnel belongs. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • replay_errors (long or None) – Total number of packets dropped due to replay check on that +Security association (SA). format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sa_mismatch_errors_in (long or None) – Totoal number of security association (SA) mismatch errors on +incoming packets. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sa_mismatch_errors_out (long or None) – Totoal number of security association (SA) mismatch errors on +outgoing packets. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • seq_number_overflow_error (long or None) – Total number of packets dropped while sending due to overflow in +sequence number. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • tunnel_down_reason (str or None) – Gives the detailed reason about the tunnel when it is down. If +tunnel is UP tunnel down reason will be empty. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • tunnel_status (str or None) –

    Possible values are:

    + +

    Specifies the status of tunnel. If all the SA (Security +association) are negotiated then tunnels status will be UP. If +negotiation fails for the SAs status will be DOWN, if SAs are in +negotiating phase tunnels status will be NEGOTIATING. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
+
+
+
+TUNNEL_STATUS_DOWN = 'DOWN'
+
+ +
+
+TUNNEL_STATUS_NEGOTIATING = 'NEGOTIATING'
+
+ +
+
+TUNNEL_STATUS_UP = 'UP'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.IPSet(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, ip_addresses=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

IPSet is used to group individual IP addresses, range of IP addresses or +subnets. An IPSet is a homogeneous group of IP addresses, either of type +IPv4 or of type IPv6. IPSets can be used as source or destination in +firewall rules. These can also be used as members of NSGroups.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • ip_addresses (list of str or None) – IP addresses format: address-or-block-or-range
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IPSetListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Paged collection of IPSets

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of IPSet) – IPSet list results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IPSubnet(ip_addresses=None, prefix_length=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • ip_addresses (list of str) – IPv4 Addresses format: ipv4
    • +
  • prefix_length (long) – Subnet Prefix Length format: int64
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IPsecVPNIKESessionSummary(degraded_sessions=None, established_sessions=None, failed_sessions=None, total_sessions=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

IPSec VPN session status summary, gives total, failed, degraded and +established IPSec VPN sessions.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • degraded_sessions (long or None) – Number of degraded sessions. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • established_sessions (long or None) – Number of established sessions. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • failed_sessions (long or None) – Number of failed sessions. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • total_sessions (long or None) – Total sessions configured. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IPv4AddressProperties(ip_address=None, netmask=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

IPv4 address properties

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • ip_address (str or None) – Interface IPv4 address
    • +
  • netmask (str or None) – Interface netmask
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IPv4DhcpServer(dhcp_server_ip=None, dns_nameservers=None, domain_name=None, gateway_ip=None, options=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • dhcp_server_ip (str) – dhcp server ip in cidr format format: ipv4-cidr-block
    • +
  • dns_nameservers (list of str or None) – dns ips format: ipv4
    • +
  • domain_name (str or None) – domain name format: hostname
    • +
  • gateway_ip (str or None) – gateway ip format: ipv4
    • +
  • options (DhcpOptions or None) – Defines the default options for all ip-pools and static-bindings of +this server. These options will be ignored if options are defined +for ip-pools or static-bindings.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IcmpEchoRequestHeader(id=None, sequence=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • id (long or None) – ICMP id format: int64
    • +
  • sequence (long or None) – ICMP sequence number format: int64
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.Icon(placement=None, tooltip=None, type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Icon to be applied at dashboard for widgets and UI elements.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+PLACEMENT_POST = 'POST'
+
+ +
+
+PLACEMENT_PRE = 'PRE'
+
+ +
+
+TYPE_DETAIL = 'DETAIL'
+
+ +
+
+TYPE_ERROR = 'ERROR'
+
+ +
+
+TYPE_INFO = 'INFO'
+
+ +
+
+TYPE_INPROGRESS = 'INPROGRESS'
+
+ +
+
+TYPE_NOT_AVAILABLE = 'NOT_AVAILABLE'
+
+ +
+
+TYPE_SUCCESS = 'SUCCESS'
+
+ +
+
+TYPE_WARNING = 'WARNING'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.IncludedFieldsParameters(included_fields=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

A list of fields to include in query results

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:included_fields (str or None) – Comma separated list of fields that should be included in query +result
+
+ +
+
+class com.vmware.nsx.model_client.IngressBroadcastRateShaper(enabled=None, resource_type=None, average_bandwidth_kbps=None, burst_size_bytes=None, peak_bandwidth_kbps=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

A shaper that specifies ingress rate properties in kb/s

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+RESOURCE_TYPE_EGRESSRATESHAPER = 'EgressRateShaper'
+
+ +
+
+RESOURCE_TYPE_INGRESSBROADCASTRATESHAPER = 'IngressBroadcastRateShaper'
+
+ +
+
+RESOURCE_TYPE_INGRESSRATESHAPER = 'IngressRateShaper'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.IngressRateShaper(enabled=None, resource_type=None, average_bandwidth_mbps=None, burst_size_bytes=None, peak_bandwidth_mbps=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

A shaper that specifies ingress rate properties in Mb/s

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+RESOURCE_TYPE_EGRESSRATESHAPER = 'EgressRateShaper'
+
+ +
+
+RESOURCE_TYPE_INGRESSBROADCASTRATESHAPER = 'IngressBroadcastRateShaper'
+
+ +
+
+RESOURCE_TYPE_INGRESSRATESHAPER = 'IngressRateShaper'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.InitiateClusterRestoreRequest(node_id=None, timestamp=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • node_id (str or None) – Unique id of the backed-up configuration from which the appliance +will be restored +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • timestamp (long or None) – Timestamp of the backed-up configuration from which the appliance +will be restored format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.InstallUpgradeServiceProperties(enabled=None, enabled_on=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

install-upgrade service properties

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • enabled (bool) – True if service enabled; otherwise, false
    • +
  • enabled_on (str or None) – IP of manager on which install-upgrade is enabled +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.InstanceDeploymentConfig(compute_id=None, context_id=None, storage_id=None, vm_nic_infos=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Instance Deployment Config contains settings that is applied during +install time.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • compute_id (str) – Resource Pool or Compute Id.
    • +
  • context_id (str) – Context Id or VCenter Id.
    • +
  • storage_id (str) – Storage Id.
    • +
  • vm_nic_infos (list of VmNicInfo) – List of set of NIC information for VMs
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.InstanceEndpoint(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, endpoint_type=None, link_ids=None, service_attachments=None, target_ips=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

An InstanceEndpoint belongs to one ServiceInstance and represents a +redirection target for a Rule. For Example - It can be an L3 Destination. +Service Attachments is required for a InstanceEndpoint of type LOGICAL, and +deployed_to if its a VIRTUAL InstanceEndpoint.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • endpoint_type (str or None) –

    Possible values are:

    + +

    LOGICAL - It must be created with a ServiceAttachment and +identifies a destination connected to the Service Port of the +ServiceAttachment, through the ServiceAttachment’s Logical Switch. +VIRTUAL - It represents a L3 destination the router can route to +but does not provide any further information about its location in +the network. Virtual InstanceEndpoints are used for redirection +targets that are not connected to Service Ports, such as the +next-hop routers on the Edge uplinks.

    +
    • +
  • link_ids (list of ResourceReference or None) – Link Ids are mandatory for VIRTUAL Instance Endpoint. Even though +VIRTUAL, the Instance Endpoint should be connected/accessible +through an NSX object. The link id is this NSX object id. Example - +For North-South Service Insertion, this is the LogicalRouter Id +through which the targetIp/L3 destination accessible.
    • +
  • service_attachments (list of ResourceReference or None) – Id(s) of the Service Attachment where this enndpoint is connected +to. Service Attachment is mandatory for LOGICAL Instance Endpoint.
    • +
  • target_ips (list of IPInfo) – Target IPs on an interface of the Service Instance.
    • +
+
+
+
+ENDPOINT_TYPE_LOGICAL = 'LOGICAL'
+
+ +
+
+ENDPOINT_TYPE_VIRTUAL = 'VIRTUAL'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.InstanceEndpointListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

List of instance endpoints.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of InstanceEndpoint or None) – List of instance endpoints. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.InstanceRuntime(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, deployment_status=None, error_message=None, runtime_status=None, service_instance_id=None, service_vm_id=None, vm_nic_info=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

A Service Runtime is the runtime entity associated with ever Service-VM +deployed.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • deployment_status (str or None) –

    Possible values are:

    + +

    Service-Instance Runtime deployment status of the Service-VM. It +shows the latest status during the process of deployment, redeploy, +upgrade, and un-deployment of VM. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • error_message (str or None) – Error message for the Service Instance Runtime if any. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • runtime_status (str or None) –

    Possible values are:

    + +
    +
    Service-Instance Runtime status of the deployed Service-VM.
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • service_instance_id (str or None) – Id of an instantiation of a registered service. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • service_vm_id (str or None) – Service-VM/SVM id of deployed virtual-machine. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • vm_nic_info (VmNicInfo or None) – VM NIC info
    • +
+
+
+
+DEPLOYMENT_STATUS_DEPLOYMENT_FAILED = 'DEPLOYMENT_FAILED'
+
+ +
+
+DEPLOYMENT_STATUS_DEPLOYMENT_IN_PROGRESS = 'DEPLOYMENT_IN_PROGRESS'
+
+ +
+
+DEPLOYMENT_STATUS_DEPLOYMENT_SUCCESSFUL = 'DEPLOYMENT_SUCCESSFUL'
+
+ +
+
+DEPLOYMENT_STATUS_UNDEPLOYMENT_FAILED = 'UNDEPLOYMENT_FAILED'
+
+ +
+
+DEPLOYMENT_STATUS_UNDEPLOYMENT_IN_PROGRESS = 'UNDEPLOYMENT_IN_PROGRESS'
+
+ +
+
+DEPLOYMENT_STATUS_UNDEPLOYMENT_SUCCESSFUL = 'UNDEPLOYMENT_SUCCESSFUL'
+
+ +
+
+DEPLOYMENT_STATUS_UNKNOWN = 'UNKNOWN'
+
+ +
+
+DEPLOYMENT_STATUS_UPGRADE_FAILED = 'UPGRADE_FAILED'
+
+ +
+
+DEPLOYMENT_STATUS_UPGRADE_IN_PROGRESS = 'UPGRADE_IN_PROGRESS'
+
+ +
+
+RUNTIME_STATUS_IN_SERVICE = 'IN_SERVICE'
+
+ +
+
+RUNTIME_STATUS_NEEDS_ATTENTION = 'NEEDS_ATTENTION'
+
+ +
+
+RUNTIME_STATUS_NOT_AVAILABLE = 'NOT_AVAILABLE'
+
+ +
+
+RUNTIME_STATUS_OUT_OF_SERVICE = 'OUT_OF_SERVICE'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.InstanceRuntimeListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Result of List of InstanceRuntimes

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of InstanceRuntime) – Array of existing InstanceRuntimes in database
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.InstructionInfo(actions=None, fields=None, id=None, name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Details of the instructions displayed during restore process

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • actions (list of str or None) – A list of actions that are to be applied to resources +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • fields (list of str or None) – A list of fields that are displayable to users in a table +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • id (str or None) – UUID of the instruction +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • name (str or None) – Instruction name +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.InterfaceNeighborProperties(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, ifindex=None, mac=None, name=None, neighbors=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Interface neighbor properties

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • ifindex (long or None) – Interface index format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • mac (str or None) – Interface MAC address +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • name (str or None) – Interface Name +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • neighbors (list of NeighborProperties or None) – Neighbor properties +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.InterfaceNeighborPropertyListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Interface neighbor property query results

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of InterfaceNeighborProperties or None) – Interface neighbor property results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.InterfaceStatistics(links=None, schema=None, self_=None, rx_bytes=None, rx_errors=None, rx_packets=None, tx_bytes=None, tx_errors=None, tx_packets=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Statistics for a network interface

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • rx_bytes (long or None) – Count of bytes received on this port format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • rx_errors (long or None) – Count of receive errors occurring on this port format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • rx_packets (long or None) – Count of packets received on this port format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • tx_bytes (long or None) – Count of bytes transmitted on this port format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • tx_errors (long or None) – Count of transmit errors occurring on this port format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • tx_packets (long or None) – Count of packets transmitted on this port format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IntervalBackupSchedule(seconds_between_backups=None, resource_type='IntervalBackupSchedule')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Schedule to specify the interval time at which automated backups need to be +taken

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+ +
+
+class com.vmware.nsx.model_client.InventoryConfig(compute_managers_soft_limit=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:compute_managers_soft_limit (long) – Soft limit on number of compute managers, which can be added, +beyond which, addition of compute managers will result in warning +getting logged format: int32
+
+ +
+
+class com.vmware.nsx.model_client.IpAddressInfo(ip_addresses=None, source=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Ipaddress information of the fabric node.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • ip_addresses (list of str or None) – IP Addresses of the the virtual network interface, as discovered in +the source. format: ip +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • source (str or None) –

    Possible values are:

    + +
    +
    Source of the ipaddress information.
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
+
+
+
+SOURCE_TOOLS = 'VM_TOOLS'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.IpAllocationBase(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, gateway_ip=None, lease_time=None, options=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • gateway_ip (str or None) – gateway ip format: ip
    • +
  • lease_time (long or None) – lease time, in seconds, [60-(2^32-1)], default 86400 format: int64
    • +
  • options (DhcpOptions or None) – If an option is defined at server level and not configred at +ip-pool/static-binding level, the option will be inherited to +ip-pool/static-binding. If both define a same-code option, the +option defined at ip-pool/static-binding level take precedence over +that defined at server level.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IpAssignmentSpec(resource_type='IpAssignmentSpec')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Abstract base type for specification of IPs to be used with host switch +virtual tunnel endpoints

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:resource_type (str) –

Possible values are:

+ +
+
+
+RESOURCE_TYPE_ASSIGNEDBYDHCP = 'AssignedByDhcp'
+
+ +
+
+RESOURCE_TYPE_STATICIPLISTSPEC = 'StaticIpListSpec'
+
+ +
+
+RESOURCE_TYPE_STATICIPMACLISTSPEC = 'StaticIpMacListSpec'
+
+ +
+
+RESOURCE_TYPE_STATICIPPOOLSPEC = 'StaticIpPoolSpec'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.IpBlock(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, cidr=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

A block of IPv4 addresses defined by a start address and a mask/prefix +(network CIDR). An IP block is typically large & allocated to a tenant for +automated consumption. An IP block is always a contiguous address space, +for example 192.0.0.1/8. An IP block can be further subdivided into subnets +called IP block subnets. These IP block subnets can later be added to IP +pools and used for IP allocation. An IP pool is typically a collection of +subnets that are often not a contiguous address space. Clients are +allocated IP addresses only from IP pools. Sample Structure Diagram +IpBlock_VMware 192.0.0.1/8 +======================================================================= / +___________________________________________/________ / +IpBlockSubnet_Finance ( IpBlockSubnet_Eng1 IpBlockSubnet_Eng2 / ) / +192.168.0.1/16 ( 192.170.1.1/16 192.180.1.1/24 / ) IpPool_Eng / +(___________________________________________/________) / / +=======================================================================

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • cidr (str) – Represents network address and the prefix length which will be +associated with a layer-2 broadcast domain format: ipv4-cidr-block
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IpBlockListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of IpBlock) – IP block list results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IpBlockSubnet(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, allocation_ranges=None, block_id=None, cidr=None, size=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

A set of IPv4 addresses defined by a start address and a mask/prefix which +will typically be associated with a layer-2 broadcast domain.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • allocation_ranges (list of IpPoolRange or None) – A collection of IPv4 IP ranges used for IP allocation. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • block_id (str) – Block id for which the subnet is created.
    • +
  • cidr (str or None) – Represents network address and the prefix length which will be +associated with a layer-2 broadcast domain format: ipv4-cidr-block +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • size (long) – Represents the size or number of ip addresses in the subnet format: +int64
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IpBlockSubnetListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of IpBlockSubnet) – IP block subnet list results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IpDiscoverySwitchingProfile(arp_bindings_limit=None, arp_snooping_enabled=None, dhcp_snooping_enabled=None, vm_tools_enabled=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='IpDiscoverySwitchingProfile', tags=None, required_capabilities=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • arp_bindings_limit (long or None) – Indicates the number of arp snooped IP addresses to be remembered +per LogicalPort. Decreasing this value, will retain the latest +bindings from the existing list of address bindings. Increasing +this value will retain existing bindings and also learn any new +address bindings discovered on the port until the new limit is +reached. format: int32
    • +
  • arp_snooping_enabled (bool or None) – Indicates whether ARP snooping is enabled
    • +
  • dhcp_snooping_enabled (bool or None) – Indicates whether DHCP snooping is enabled
    • +
  • vm_tools_enabled (bool or None) – This option is only supported on ESX where vm-tools is installed.
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • required_capabilities (list of str or None) –
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IpMacPair(ip=None, mac=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

IP and MAC pair.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • ip (str) – IP address format: ip
    • +
  • mac (str or None) – MAC address
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IpPool(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, pool_usage=None, subnets=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

A collection of one or more IPv4 or IPv6 subnets or ranges that are often +not a contiguous address space. Clients are allocated IPs from an IP pool. +Often used when a client that consumes addresses exhausts an initial subnet +or range and needs to be expanded but the adjoining address space is not +available as it has been allocated to a different client.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • pool_usage (PoolUsage or None) – Pool usage statistics
    • +
  • subnets (list of IpPoolSubnet or None) – Subnets can be IPv4 or IPv6 and they should not overlap. The +maximum number will not exceed 5 subnets.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IpPoolListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of IpPool) – IP pool list results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IpPoolRange(links=None, schema=None, self_=None, end=None, start=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

A set of IPv4 or IPv6 addresses defined by a start and end address.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • end (str) – The end IP Address of the IP Range. format: ip
    • +
  • start (str) – The start IP Address of the IP Range. format: ip
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IpPoolSubnet(links=None, schema=None, self_=None, allocation_ranges=None, cidr=None, dns_nameservers=None, dns_suffix=None, gateway_ip=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

A set of IPv4 or IPv6 addresses defined by a network CIDR.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • allocation_ranges (list of IpPoolRange) – A collection of IPv4 or IPv6 IP Pool Ranges.
    • +
  • cidr (str) – Represents network address and the prefix length which will be +associated with a layer-2 broadcast domain
    • +
  • dns_nameservers (list of str or None) – The collection of upto 3 DNS servers for the subnet. format: ip
    • +
  • dns_suffix (str or None) – The DNS suffix for the DNS server. format: hostname
    • +
  • gateway_ip (str or None) – The default gateway address on a layer-3 router. format: ip
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IpfixCollector(collector_ip_address=None, collector_port=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • collector_ip_address (str) – IP address for the IPFIX collector format: ip
    • +
  • collector_port (long or None) – Port for the IPFIX collector format: int32
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IpfixCollectorConfig(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, collectors=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This managed entity contains a set of IPFIX collectors.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • collectors (list of IpfixCollector) – IPFIX Collectors
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IpfixCollectorConfigListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

List of IPFIX Collector Configs

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of IpfixCollectorConfig or None) – IPFIX Collector Config +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IpfixCollectorUpmProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, collectors=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The configuration for Internet protocol flow information export (IPFIX) +collector. It should be referenced in other IPFIX profile as a collecor +config. The IPFIX exporter will send records to these collectors.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • collectors (list of IpfixCollector) – IPFIX Collector Set
    • +
+
+
+
+RESOURCE_TYPE_IPFIXCOLLECTORUPMPROFILE = 'IpfixCollectorUpmProfile'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.IpfixCollectorUpmProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

IPFIX collector profile list result for query with profile list parameters

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of IpfixCollectorUpmProfile or None) – IPFIX Collector Profile List +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IpfixConfig(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='IpfixConfig', tags=None, applied_tos=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

IPFIX Config base representation

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +
    +
    Supported IPFIX Config Types.
    +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • applied_tos (list of ResourceReference or None) – List of objects where the IPFIX Config will be enabled.
    • +
+
+
+
+RESOURCE_TYPE_IPFIXDFWCONFIG = 'IpfixDfwConfig'
+
+ +
+
+RESOURCE_TYPE_IPFIXSWITCHCONFIG = 'IpfixSwitchConfig'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.IpfixConfigListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

List of IPFIX Config

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of vmware.vapi.struct.VapiStruct or None) – IPFIX Config +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +IpfixConfig. When methods return a value of this class as +a return value, the attribute will contain all the attributes +defined in IpfixConfig. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IpfixDfwConfig(active_flow_export_timeout=None, collector=None, observation_domain_id=None, priority=None, template_parameters=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='IpfixDfwConfig', tags=None, applied_tos=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

It defines IPFIX DFW Configuration.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • active_flow_export_timeout (long or None) – For long standing active flows, IPFIX records will be sent per +timeout period format: int64
    • +
  • collector (str) – Each IPFIX DFW config can have its own collector config.
    • +
  • observation_domain_id (long) – An identifier that is unique to the exporting process and used to +meter the Flows. format: int64
    • +
  • priority (long) – This priority field is used to resolve conflicts in Logical Ports +which are covered by more than one IPFIX profiles. The IPFIX +exporter will send records to Collectors in highest priority +profile (lowest number) only. format: int64
    • +
  • template_parameters (IpfixDfwTemplateParameters or None) – An object that indicates whether each corresponding template +parameter is required or not.
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +
    +
    Supported IPFIX Config Types.
    +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • applied_tos (list of ResourceReference or None) – List of objects where the IPFIX Config will be enabled.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IpfixDfwTemplateParameters(destination_address=None, destination_transport_port=None, firewall_event=None, flow_direction=None, flow_end=None, flow_start=None, icmp_code=None, octet_delta_count=None, packet_delta_count=None, protocol_identifier=None, rule_id=None, source_address=None, source_icmp_type=None, source_transport_port=None, vif_uuid=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This entity represents the flow parameters which are exported.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • destination_address (bool or None) – The destination IP address of a monitored network flow. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • destination_transport_port (bool or None) – The destination transport port of a monitored network flow. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • firewall_event (bool or None) – Five valid values are allowed: 1. Flow Created. 2. Flow Deleted. 3. +Flow Denied. 4. Flow Alert (not used in DropKick implementation). +5. Flow Update. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • flow_direction (bool or None) – Two valid values are allowed: 1. 0x00: igress flow to VM. 2. 0x01: +egress flow from VM. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • flow_end (bool or None) – The absolute timestamp (seconds) of the last packet of this flow. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • flow_start (bool or None) – The absolute timestamp (seconds) of the first packet of this flow. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • icmp_code (bool or None) – Code of the IPv4 ICMP message. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • octet_delta_count (bool or None) – The number of octets since the previous report (if any) in incoming +packets for this flow at the observation point. The number of +octets include IP header(s) and payload. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • packet_delta_count (bool or None) – The number of incoming packets since the previous report (if any) +for this flow at the observation point. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protocol_identifier (bool or None) – The value of the protocol number in the IP packet header. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • rule_id (bool or None) – Firewall rule Id - enterprise specific Information Element that +uniquely identifies firewall rule. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • source_address (bool or None) – The source IP address of a monitored network flow. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • source_icmp_type (bool or None) – Type of the IPv4 ICMP message. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • source_transport_port (bool or None) – The source transport port of a monitored network flow. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • vif_uuid (bool or None) – VIF UUID - enterprise specific Information Element that uniquely +identifies VIF. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IpfixObsPointConfig(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, active_timeout=None, collectors=None, enabled=None, idle_timeout=None, max_flows=None, observation_domain_id=None, packet_sample_probability=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

IpfixObsPointConfig (i.e. global switch IPFIX config) is deprecated. Please +use IpfixSwitchUpmProfile & IpfixCollectorUpmProfile instead. With them, +switch IPFIX profile can be applied to specific entities, such as logical +switch, logical port and so on.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • active_timeout (long or None) – The time in seconds after a Flow is expired even if more packets +matching this Flow are received by the cache. format: int32
    • +
  • collectors (list of IpfixCollector or None) – List of IPFIX collectors
    • +
  • enabled (bool) – Enabled status of IPFIX export
    • +
  • idle_timeout (long or None) – The time in seconds after a Flow is expired if no more packets +matching this Flow are received by the cache. format: int32
    • +
  • max_flows (long or None) – The maximum number of flow entries in each exporter flow cache. +format: int64
    • +
  • observation_domain_id (long or None) – An identifier that is unique to the exporting process and used to +meter the Flows. format: int64
    • +
  • packet_sample_probability (float or None) – The probability in percentage that a packet is sampled, in range +0-100. The probability is equal for every packet.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IpfixObsPointsListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This is deprecated. Please use UpmProfileListResult instead.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of IpfixObsPointConfig or None) – IPFIX observation points
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IpfixServiceAssociationListResult(results=None, links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, service_type='IpfixServiceAssociationListResult')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • results (list of vmware.vapi.struct.VapiStruct or None) – Ipfix config list result with pagination support. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +IpfixConfig. When methods return a value of this class as +a return value, the attribute will contain all the attributes +defined in IpfixConfig. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • service_type (str) –

    Possible values are:

    + +
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IpfixSwitchConfig(active_timeout=None, idle_timeout=None, max_flows=None, packet_sample_probability=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='IpfixSwitchConfig', tags=None, applied_tos=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This is deprecated. Please use IpfixSwitchUpmProfile instead which can +specify its own collectors and observation ID.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • active_timeout (long or None) – The time in seconds after a Flow is expired even if more packets +matching this Flow are received by the cache. format: int32
    • +
  • idle_timeout (long or None) – The time in seconds after a Flow is expired if no more packets +matching this Flow are received by the cache. format: int32
    • +
  • max_flows (long or None) – The maximum number of flow entries in each exporter flow cache. +format: int64
    • +
  • packet_sample_probability (float or None) – The probability in percentage that a packet is sampled, in range +0-100. The probability is equal for every packet.
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +
    +
    Supported IPFIX Config Types.
    +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • applied_tos (list of ResourceReference or None) – List of objects where the IPFIX Config will be enabled.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IpfixSwitchUpmProfile(active_timeout=None, applied_tos=None, collector_profile=None, idle_timeout=None, max_flows=None, observation_domain_id=None, packet_sample_probability=None, priority=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='IpfixSwitchUpmProfile', tags=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The configuration for Internet protocol flow information export (IPFIX) and +would be enabled on the switching module to collect flow information.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • active_timeout (long or None) – The time in seconds after a flow is expired even if more packets +matching this Flow are received by the cache. format: int32
    • +
  • applied_tos (AppliedTos or None) – Entities where the IPFIX profile will be enabled on. Maximum entity +count of all types is 128.
    • +
  • collector_profile (str) – Each IPFIX switching profile can have its own collector profile.
    • +
  • idle_timeout (long or None) – The time in seconds after a flow is expired if no more packets +matching this flow are received by the cache. format: int32
    • +
  • max_flows (long or None) – The maximum number of flow entries in each exporter flow cache. +format: int64
    • +
  • observation_domain_id (long) – An identifier that is unique to the exporting process and used to +meter the Flows. format: int64
    • +
  • packet_sample_probability (float or None) – The probability in percentage that a packet is sampled, in range +(0,100]. The probability is equal for every packet.
    • +
  • priority (long) – This priority field is used to resolve conflicts in logical +ports/switch which inherit multiple switch IPFIX profiles from +NSGroups. Override rule is : for multiple profiles inherited from +NSGroups, the one with highest priority (lowest number) overrides +others; the profile directly applied to logical switch overrides +profiles inherited from NSGroup; the profile directly applied to +logical port overides profiles inherited from logical switch and/or +nsgroup; The IPFIX exporter will send records to collectors of +final effective profile only. format: int32
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +
    +
    All IPFIX profile types.
    +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.IpfixUpmProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='IpfixUpmProfile', tags=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Parent profile of all IPFIX profiles.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +
    +
    All IPFIX profile types.
    +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
+
+
+
+RESOURCE_TYPE_IPFIXSWITCHUPMPROFILE = 'IpfixSwitchUpmProfile'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.IpfixUpmProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

IPFIX profile list result for query with list parameters

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of vmware.vapi.struct.VapiStruct or None) – IPFIX Profile List +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +IpfixUpmProfile. When methods return a value of this class +as a return value, the attribute will contain all the attributes +defined in IpfixUpmProfile. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.Ipv4Header(dst_ip=None, flags=None, protocol=None, src_ip=None, src_subnet_prefix_len=None, ttl=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • dst_ip (str or None) – The destination ip address. format: ip
    • +
  • flags (long or None) – IP flags format: int64
    • +
  • protocol (long or None) – IP protocol - defaults to ICMP format: int64
    • +
  • src_ip (str or None) – The source ip address. format: ip
    • +
  • src_subnet_prefix_len (long or None) – This is used together with src_ip to calculate dst_ip for broadcast +when dst_ip is not given; not used in all other cases. format: +int64
    • +
  • ttl (long or None) – Time to live (ttl) format: int64
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.KeyValue(key=None, value=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • key (str) – key name
    • +
  • value (str) – key value
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.KeyValuePair(key=None, value=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

An arbitrary key-value pair

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • key (str) – Key
    • +
  • value (str) – Value
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.KnownHostParameter(host=None, port=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • host (str) – Known host hostname or IP address format: hostname-or-ipv4
    • +
  • port (long or None) – Known host port format: int64
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.L2VPNPerLSTrafficStatistics(bum_bytes_in=None, bum_bytes_out=None, bum_packets_in=None, bum_packets_out=None, bytes_in=None, bytes_out=None, logical_switch=None, packets_in=None, packets_out=None, packets_receive_error=None, packets_sent_error=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Traffic statistics for a logical switch.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • bum_bytes_in (long or None) – Total number of incoming Broadcast, Unknown unicast and Multicast +(BUM) bytes. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • bum_bytes_out (long or None) – Total number of outgoing Broadcast, Unknown unicast and Multicast +(BUM) bytes. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • bum_packets_in (long or None) – Total number of incoming Broadcast, Unknown unicast and Multicast +(BUM) packets. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • bum_packets_out (long or None) – Total number of outgoing Broadcast, Unknown unicast and Multicast +(BUM) packets. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • bytes_in (long or None) – Total number of incoming bytes. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • bytes_out (long or None) – Total number of outgoing bytes. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • logical_switch (ResourceReference or None) – Logical switch
    • +
  • packets_in (long or None) – Total number of incoming packets. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • packets_out (long or None) – Total number of outgoing packets. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • packets_receive_error (long or None) – Total number of incoming packets dropped. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • packets_sent_error (long or None) – Total number of packets dropped while sending for any reason. +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.L2VPNSessionRemoteMacs(display_name=None, remote_mac_addresses=None, session_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Remote MAC addresses for all logical switches for a L2VPN session.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • display_name (str or None) – L2VPN display name. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • remote_mac_addresses (list of L2VPNSessionRemoteMacsForLS or None) – List MAC addresses for all logical switch for a particular L2VPN +session. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • session_id (str or None) – L2VPN session identifier. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.L2VPNSessionRemoteMacsForLS(logical_switch=None, remote_mac_addresses=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Remote MAC addresses for logical switch.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • logical_switch (ResourceReference or None) – Logical switch.
    • +
  • remote_mac_addresses (list of str or None) – Mac addresses. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.L2VPNSessionStatistics(display_name=None, partial_stats=None, session_id=None, tap_traffic_counters=None, traffic_statistics_per_logical_switch=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Session statistics gives VPN session status and traffic statistics per +logical switch.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • display_name (str or None) – L2VPN display name. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • partial_stats (bool or None) – Partial statistics is set to true if onle active node responds +while standby does not. In case of both nodes responded statistics +will be summed and partial stats will be false. If cluster has only +active node, partial statistics will always be false. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • session_id (str or None) – Session identifier for L2VPN. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • tap_traffic_counters (list of L2VPNTapTrafficStatistics or None) – Tunnel port traffic counters. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • traffic_statistics_per_logical_switch (list of L2VPNPerLSTrafficStatistics or None) – Traffic statistics per logical switch. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.L2VPNSessionStatus(display_name=None, session_id=None, status=None, transport_tunnels=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

L2VPN session status.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • display_name (str or None) – L2VPN display name. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • session_id (str or None) – L2VPN session identifier. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • status (str or None) –

    Possible values are:

    + +
    +
    L2 VPN session status, specifies UP/DOWN.
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • transport_tunnels (list of vmware.vapi.struct.VapiStruct or None) – Transport tunnels status. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +L2VPNTransportTunnelStatus. When methods return a value of +this class as a return value, the attribute will contain all the +attributes defined in L2VPNTransportTunnelStatus. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+
+STATUS_DOWN = 'DOWN'
+
+ +
+
+STATUS_UP = 'UP'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.L2VPNSessionSummary(established_l2vpn_sessions=None, failed_l2vpn_sessions=None, total_l2vpn_sessions=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

List summary of L2VPN sessions.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • established_l2vpn_sessions (long or None) – Number of established L2VPN sessions. L2VPN session is established +when all the tunnels are up. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • failed_l2vpn_sessions (long or None) – Number of failed L2VPN sessions. L2VPN session is failed when all +the tunnels are down. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • total_l2vpn_sessions (long or None) – Total L2VPN sessions configured. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.L2VPNTapTrafficStatistics(bytes_in=None, bytes_out=None, packets_in=None, packets_out=None, packets_receive_error=None, packets_sent_error=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

TAP (Terminal access point) traffic statistics for L2VPN.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • bytes_in (long or None) – Total number of incoming bytes. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • bytes_out (long or None) – Total number of outgoing bytes. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • packets_in (long or None) – Total number of incoming packets. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • packets_out (long or None) – Total number of outgoing packets. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • packets_receive_error (long or None) – Total number of incoming packets dropped. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • packets_sent_error (long or None) – Total number of packets dropped while sending for any reason. +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.L2VPNTransportTunnelStatus(resource_type='L2VPNTransportTunnelStatus', tunnel_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Transport tunnel status.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+RESOURCE_TYPE_IPSECVPNTRANSPORTSTATUS = 'IPSecVPNTransportStatus'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.L2VpnAttachmentContext(tunnel_id=None, allocate_addresses=None, resource_type='L2VpnAttachmentContext')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+ +
+
+class com.vmware.nsx.model_client.L2VpnService(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, enable_full_mesh=None, logical_router_id=None, logical_tap_ip_pool=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Defines if service running as hub or spoke Also defines all the common +properties for the multiple L2VpnSessions associated with this service.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • enable_full_mesh (bool or None) – Hub replicates traffic received from peer to all other peers.
    • +
  • logical_router_id (str) – Logical router id
    • +
  • logical_tap_ip_pool (list of str or None) – IP Pool to allocate local and peer endpoint IPs for L2VpnSession +logical Tap. format: ipv4-cidr-block
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.L2VpnServiceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Paginated list all the L2VPN services.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of L2VpnService) – L2VPN serivce list result
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.L2VpnSession(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, enabled=None, l2vpn_service_id=None, transport_tunnels=None, tunnel_encapsulation=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Defines the tunnel local and peer addresses along with the multiple +tansport tunnels for redundancy. L2VpnSession belongs on to only one +L2VpnService.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • enabled (bool or None) – Enable to extend all the associated logical switches.
    • +
  • l2vpn_service_id (str) – L2VPN service id
    • +
  • transport_tunnels (list of ResourceReference) – List of transport tunnels for redundancy.
    • +
  • tunnel_encapsulation (L2VpnTunnelEncapsulation or None) – Tunnel encapsulation config.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.L2VpnSessionListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Paginated list all the L2VPN sessions

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of L2VpnSession) – L2VPN sessions list result
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.L2VpnSessionPeerCodes(peer_codes=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Get the peer_code for each tunnel to paste on the remote end of the tunnel. +Currently only stand-along/unmanaged edge is supported on the remote end of +the tunnel.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:peer_codes (list of L2VpnTunnelPeerCode) – List of peer codes per transport tunnel.
+
+ +
+
+class com.vmware.nsx.model_client.L2VpnTunnelEncapsulation(local_endpoint_ip=None, peer_endpoint_ip=None, protocol=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

L2VPN tunnel encapsulation config

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • local_endpoint_ip (str or None) – IP Address of the tunnel port. The IP are allocated from +L2VpnService logical_tap_ip_pool. All sessions on same L2VpnService +get the same local_endpoint_ip. format: ipv4
    • +
  • peer_endpoint_ip (str or None) – IP Address of the peer tunnel port. The IP are allocated from +L2VpnService logical_tap_ip_pool. format: ipv4
    • +
  • protocol (str or None) –

    Possible values are:

    + +
    +
    Encapsulation protocol used by the tunnel
    +
    • +
+
+
+
+PROTOCOL_GRE = 'GRE'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.L2VpnTunnelPeerCode(peer_code=None, transport_tunnel=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

L2Vpn tunnel peer code

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • peer_code (str) – Copy this code to paste on the remote end of the tunnel. This is a +base64 encoded string which has all the configuration for tunnel. +E.g tap device local/peer ips and protocol, encryption algorithm, +etc. The peer code also contains a pre-shared key; be careful when +sharing or storing it.
    • +
  • transport_tunnel (ResourceReference) – Transport tunnel
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.L4PortSetNSService(destination_ports=None, l4_protocol=None, source_ports=None, resource_type='L4PortSetNSService')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

L4PortSet can be specified in comma separated notation of parts. Parts of a +L4PortSet includes single integer or range of port in hyphen notation. +Example of a PortSet: "22, 33-70, 44".

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+L4PROTOCOL_TCP = 'TCP'
+
+ +
+
+L4PROTOCOL_UDP = 'UDP'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.Label(condition=None, hover=None, icons=None, navigation=None, text=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Label that will be displayed for a UI element.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • condition (str or None) – If the condition is met then the label will be applied. Examples of +expression syntax are provided under example_request section of +CreateWidgetConfiguration API.
    • +
  • hover (bool or None) – If true, displays the label only on hover
    • +
  • icons (list of Icon or None) – Icons to be applied at dashboard for the label
    • +
  • navigation (str or None) – Hyperlink of the specified UI page that provides details.
    • +
  • text (str) – Text to be displayed at the label.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LabelValueConfiguration(navigation=None, properties=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LabelValueConfiguration', tags=None, datasources=None, drilldown_id=None, footer=None, is_drilldown=None, shared=None, weight=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Represents a Label-Value widget configuration

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • navigation (str or None) – Hyperlink of the specified UI page that provides details.
    • +
  • properties (list of PropertyItem) – An array of label-value properties.
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str) – Title of the widget.
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +

    Supported visualization types are LabelValueConfiguration, +DonutConfiguration, GridConfiguration, StatsConfiguration, +MultiWidgetConfiguration and ContainerConfiguration.

    +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • datasources (list of Datasource or None) – The ‘datasources’ represent the sources from which data will be +fetched. Currently, only NSX-API is supported as a ‘default’ +datasource. An example of specifying ‘default’ datasource along +with the urls to fetch data from is given at ‘example_request’ +section of ‘CreateWidgetConfiguration’ API.
    • +
  • drilldown_id (str or None) – Id of drilldown widget, if any. Id should be a valid id of an +existing widget. A widget is considered as drilldown widget when it +is associated with any other widget and provides more detailed +information about any data item from the parent widget.
    • +
  • footer (Footer or None) –
    • +
  • is_drilldown (bool or None) – Set to true if this widget should be used as a drilldown.
    • +
  • shared (bool or None) – Please use the property ‘shared’ of View instead of this. The +widgets of a shared view are visible to other users.
    • +
  • weight (long or None) – Specify relavite weight in WidgetItem for placement in a view. +Please see WidgetItem for details. format: int32
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.Lag(id=None, load_balance_algorithm=None, mode=None, name=None, number_of_uplinks=None, timeout_type=None, uplinks=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

LACP group

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+LOAD_BALANCE_ALGORITHM_DESTMAC = 'DESTMAC'
+
+ +
+
+LOAD_BALANCE_ALGORITHM_SRCDESTIPVLAN = 'SRCDESTIPVLAN'
+
+ +
+
+LOAD_BALANCE_ALGORITHM_SRCDESTMAC = 'SRCDESTMAC'
+
+ +
+
+LOAD_BALANCE_ALGORITHM_SRCDESTMACIPPORT = 'SRCDESTMACIPPORT'
+
+ +
+
+LOAD_BALANCE_ALGORITHM_SRCMAC = 'SRCMAC'
+
+ +
+
+MODE_ACTIVE = 'ACTIVE'
+
+ +
+
+MODE_PASSIVE = 'PASSIVE'
+
+ +
+
+TIMEOUT_TYPE_FAST = 'FAST'
+
+ +
+
+TIMEOUT_TYPE_SLOW = 'SLOW'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LbActiveMonitor(fall_count=None, interval=None, monitor_port=None, rise_count=None, timeout=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LbActiveMonitor', tags=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • fall_count (long or None) – num of consecutive checks must fail before marking it down format: +int64
    • +
  • interval (long or None) – the frequency at which the system issues the monitor check (in +second) format: int64
    • +
  • monitor_port (str or None) – If the monitor port is specified, it would override pool member +port setting for healthcheck. A port range is not supported. +format: port-or-range
    • +
  • rise_count (long or None) – num of consecutive checks must pass before marking it up format: +int64
    • +
  • timeout (long or None) – the number of seconds the target has in which to respond to the +monitor request format: int64
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +

    Load balancers monitor the health of backend servers to ensure +traffic is not black holed. There are two types of healthchecks: +active and passive. Passive healthchecks depend on failures in +actual client traffic (e.g. RST from server in response to a client +connection) to detect that the server or the application is down. +In case of active healthchecks, load balancer itself initiates new +connections (or sends ICMP ping) to the servers periodically to +check their health, completely independent of any data traffic. +Currently, active health monitors are supported for HTTP, HTTPS, +TCP, UDP and ICMP protocols.

    +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LbAppProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LbAppProfile', tags=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +

    An application profile can be bound to a virtual server to specify +the application protocol characteristics. It is used to influence +how load balancing is performed. Currently, three types of +application profiles are supported: LbFastTCPProfile, +LbFastUDPProfile and LbHttpProfile. LbFastTCPProfile or +LbFastUDPProfile is typically used when the application is using a +custom protocol or a standard protocol not supported by the load +balancer. It is also used in cases where the user only wants L4 +load balancing mainly because L4 load balancing has much higher +performance and scalability, and/or supports connection mirroring. +LbHttpProfile is used for both HTTP and HTTPS applications. Though +application rules, if bound to the virtual server, can be used to +accomplish the same goal, LbHttpProfile is intended to simplify +enabling certain common use cases.

    +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
+
+
+
+RESOURCE_TYPE_LBFASTTCPPROFILE = 'LbFastTcpProfile'
+
+ +
+
+RESOURCE_TYPE_LBFASTUDPPROFILE = 'LbFastUdpProfile'
+
+ +
+
+RESOURCE_TYPE_LBHTTPPROFILE = 'LbHttpProfile'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LbAppProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of vmware.vapi.struct.VapiStruct) – paginated list of load balancer application profiles +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +LbAppProfile. When methods return a value of this class as +a return value, the attribute will contain all the attributes +defined in LbAppProfile.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LbClientCertificateIssuerDnCondition(case_sensitive=None, issuer_dn=None, match_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Match condition for client certficate issuer DN

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+MATCH_TYPE_CONTAINS = 'CONTAINS'
+
+ +
+
+MATCH_TYPE_ENDS_WITH = 'ENDS_WITH'
+
+ +
+
+MATCH_TYPE_EQUALS = 'EQUALS'
+
+ +
+
+MATCH_TYPE_REGEX = 'REGEX'
+
+ +
+
+MATCH_TYPE_STARTS_WITH = 'STARTS_WITH'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LbClientCertificateSubjectDnCondition(case_sensitive=None, match_type=None, subject_dn=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Match condition for client certficate subject DN

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+MATCH_TYPE_CONTAINS = 'CONTAINS'
+
+ +
+
+MATCH_TYPE_ENDS_WITH = 'ENDS_WITH'
+
+ +
+
+MATCH_TYPE_EQUALS = 'EQUALS'
+
+ +
+
+MATCH_TYPE_REGEX = 'REGEX'
+
+ +
+
+MATCH_TYPE_STARTS_WITH = 'STARTS_WITH'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LbClientSslProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, cipher_group_label=None, ciphers=None, is_fips=None, is_secure=None, prefer_server_ciphers=None, protocols=None, session_cache_enabled=None, session_cache_timeout=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA = 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA'
+
+ +
+
+CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256'
+
+ +
+
+CIPHERS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256'
+
+ +
+
+CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA = 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA'
+
+ +
+
+CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384'
+
+ +
+
+CIPHERS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384'
+
+ +
+
+CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHA = 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA'
+
+ +
+
+CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256'
+
+ +
+
+CIPHERS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256'
+
+ +
+
+CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHA = 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA'
+
+ +
+
+CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384'
+
+ +
+
+CIPHERS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384'
+
+ +
+
+CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHA = 'TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA'
+
+ +
+
+CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256'
+
+ +
+
+CIPHERS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256'
+
+ +
+
+CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHA = 'TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA'
+
+ +
+
+CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384'
+
+ +
+
+CIPHERS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384'
+
+ +
+
+CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHA = 'TLS_ECDH_RSA_WITH_AES_128_CBC_SHA'
+
+ +
+
+CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256'
+
+ +
+
+CIPHERS_ECDH_RSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256'
+
+ +
+
+CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHA = 'TLS_ECDH_RSA_WITH_AES_256_CBC_SHA'
+
+ +
+
+CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384'
+
+ +
+
+CIPHERS_ECDH_RSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384'
+
+ +
+
+CIPHERS_RSA_WITH_3DES_EDE_CBC_SHA = 'TLS_RSA_WITH_3DES_EDE_CBC_SHA'
+
+ +
+
+CIPHERS_RSA_WITH_AES_128_CBC_SHA = 'TLS_RSA_WITH_AES_128_CBC_SHA'
+
+ +
+
+CIPHERS_RSA_WITH_AES_128_CBC_SHA256 = 'TLS_RSA_WITH_AES_128_CBC_SHA256'
+
+ +
+
+CIPHERS_RSA_WITH_AES_128_GCM_SHA256 = 'TLS_RSA_WITH_AES_128_GCM_SHA256'
+
+ +
+
+CIPHERS_RSA_WITH_AES_256_CBC_SHA = 'TLS_RSA_WITH_AES_256_CBC_SHA'
+
+ +
+
+CIPHERS_RSA_WITH_AES_256_CBC_SHA256 = 'TLS_RSA_WITH_AES_256_CBC_SHA256'
+
+ +
+
+CIPHERS_RSA_WITH_AES_256_GCM_SHA384 = 'TLS_RSA_WITH_AES_256_GCM_SHA384'
+
+ +
+
+CIPHER_GROUP_LABEL_BALANCED = 'BALANCED'
+
+ +
+
+CIPHER_GROUP_LABEL_CUSTOM = 'CUSTOM'
+
+ +
+
+CIPHER_GROUP_LABEL_HIGH_COMPATIBILITY = 'HIGH_COMPATIBILITY'
+
+ +
+
+CIPHER_GROUP_LABEL_HIGH_SECURITY = 'HIGH_SECURITY'
+
+ +
+
+PROTOCOLS_SSL_V2 = 'SSL_V2'
+
+ +
+
+PROTOCOLS_SSL_V3 = 'SSL_V3'
+
+ +
+
+PROTOCOLS_TLS_V1 = 'TLS_V1'
+
+ +
+
+PROTOCOLS_TLS_V1_1 = 'TLS_V1_1'
+
+ +
+
+PROTOCOLS_TLS_V1_2 = 'TLS_V1_2'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LbClientSslProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of LbClientSslProfile) – paginated list of load balancer client SSL profiles
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LbCookiePersistenceProfile(cookie_domain=None, cookie_fallback=None, cookie_garble=None, cookie_mode=None, cookie_name=None, cookie_path=None, cookie_time=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LbCookiePersistenceProfile', tags=None, persistence_shared=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • cookie_domain (str or None) – HTTP cookie domain could be configured, only available for insert +mode.
    • +
  • cookie_fallback (bool or None) – If fallback is true, once the cookie points to a server that is +down (i.e. admin state DISABLED or healthcheck state is DOWN), then +a new server is selected by default to handle that request. If +fallback is false, it will cause the request to be rejected if +cookie points to a server
    • +
  • cookie_garble (bool or None) – If garble is set to true, cookie value (server IP and port) would +be encrypted. If garble is set to false, cookie value would be +plain text.
    • +
  • cookie_mode (str or None) –

    Possible values are:

    + +
    +
    cookie persistence mode
    +
    • +
  • cookie_name (str) – cookie name
    • +
  • cookie_path (str or None) – HTTP cookie path could be set, only available for insert mode.
    • +
  • cookie_time (vmware.vapi.struct.VapiStruct or None) – Both session cookie and persistence cookie are supported, if not +specified, it’s a session cookie. It expires when the browser is +closed. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +LbCookieTime. When methods return a value of this class as +a return value, the attribute will contain all the attributes +defined in LbCookieTime.
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +

    Source-ip persistence ensures all connections from a client +(identified by IP address) are sent to the same backend server for +a specified period. Cookie persistence allows related client +connections, identified by the same cookie in HTTP requests, to be +redirected to the same server.

    +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • persistence_shared (bool or None) – If persistence shared flag is not set in the cookie persistence +profile bound to a virtual server, it defaults to cookie +persistence that is private to each virtual server and is qualified +by the pool. This is accomplished by load balancer inserting a +cookie with name in the format +<name>.<virtual_server_id>.<pool_id>. If persistence shared flag is +set in the cookie persistence profile, in cookie insert mode, +cookie persistence could be shared across multiple virtual servers +that are bound to the same pools. The cookie name would be changed +to <name>.<profile-id>.<pool-id>. If persistence shared flag is not +set in the sourceIp persistence profile bound to a virtual server, +each virtual server that the profile is bound to maintains its own +private persistence table. If persistence shared flag is set in the +sourceIp persistence profile, all virtual servers the profile is +bound to share the same persistence table.
    • +
+
+
+
+COOKIE_MODE_INSERT = 'INSERT'
+
+ +
+
+COOKIE_MODE_PREFIX = 'PREFIX'
+
+ +
+
+COOKIE_MODE_REWRITE = 'REWRITE'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LbCookieTime(type='LbCookieTime')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:type (str) –

Possible values are:

+ +

Both session cookie and persistence cookie are supported, Use +LbSessionCookieTime for session cookie time setting, Use +LbPersistenceCookieTime for persistence cookie time setting

+
+
+
+TYPE_LBPERSISTENCECOOKIETIME = 'LbPersistenceCookieTime'
+
+ +
+
+TYPE_LBSESSIONCOOKIETIME = 'LbSessionCookieTime'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LbFastTcpProfile(close_timeout=None, ha_flow_mirroring_enabled=None, idle_timeout=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LbFastTcpProfile', tags=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • close_timeout (long or None) – It is used to specify how long a closing TCP connection (both FINs +received or a RST is received) should be kept for this application +before cleaning up the connection. format: int64
    • +
  • ha_flow_mirroring_enabled (bool or None) – If flow mirroring is enabled, all the flows to the bounded virtual +server are mirrored to the standby node.
    • +
  • idle_timeout (long or None) – It is used to configure how long an idle TCP connection in +ESTABLISHED state should be kept for this application before +cleaning up. format: int64
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +

    An application profile can be bound to a virtual server to specify +the application protocol characteristics. It is used to influence +how load balancing is performed. Currently, three types of +application profiles are supported: LbFastTCPProfile, +LbFastUDPProfile and LbHttpProfile. LbFastTCPProfile or +LbFastUDPProfile is typically used when the application is using a +custom protocol or a standard protocol not supported by the load +balancer. It is also used in cases where the user only wants L4 +load balancing mainly because L4 load balancing has much higher +performance and scalability, and/or supports connection mirroring. +LbHttpProfile is used for both HTTP and HTTPS applications. Though +application rules, if bound to the virtual server, can be used to +accomplish the same goal, LbHttpProfile is intended to simplify +enabling certain common use cases.

    +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LbFastUdpProfile(flow_mirroring_enabled=None, idle_timeout=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LbFastUdpProfile', tags=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • flow_mirroring_enabled (bool or None) – If flow mirroring is enabled, all the flows to the bounded virtual +server are mirrored to the standby node.
    • +
  • idle_timeout (long or None) – Though UDP is a connectionless protocol, for the purposes of load +balancing, all UDP packets with the same flow signature (source and +destination IP/ports and IP protocol) received within the idle +timeout period are considered to belong to the same connection and +are sent to the same backend server. If no packets are received for +idle timeout period, the connection (association between flow +signature and the selected server) is cleaned up. format: int64
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +

    An application profile can be bound to a virtual server to specify +the application protocol characteristics. It is used to influence +how load balancing is performed. Currently, three types of +application profiles are supported: LbFastTCPProfile, +LbFastUDPProfile and LbHttpProfile. LbFastTCPProfile or +LbFastUDPProfile is typically used when the application is using a +custom protocol or a standard protocol not supported by the load +balancer. It is also used in cases where the user only wants L4 +load balancing mainly because L4 load balancing has much higher +performance and scalability, and/or supports connection mirroring. +LbHttpProfile is used for both HTTP and HTTPS applications. Though +application rules, if bound to the virtual server, can be used to +accomplish the same goal, LbHttpProfile is intended to simplify +enabling certain common use cases.

    +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LbHttpMonitor(request_body=None, request_headers=None, request_method=None, request_url=None, request_version=None, response_body=None, response_status_codes=None, fall_count=None, interval=None, monitor_port=None, rise_count=None, timeout=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • request_body (str or None) – String to send as part of HTTP health check request body. Valid +only for certain HTTP methods like POST.
    • +
  • request_headers (list of LbHttpRequestHeader or None) – Array of HTTP request headers
    • +
  • request_method (str or None) –

    Possible values are:

    + +
    +
    the health check method for HTTP monitor type
    +
    • +
  • request_url (str or None) – URL used for HTTP monitor
    • +
  • request_version (str or None) –

    Possible values are:

    +
      +
    • LbHttpMonitor.REQUEST_VERSION__1_0
      • +
    • LbHttpMonitor.REQUEST_VERSION__1_1
      • +
    • LbHttpMonitor.REQUEST_VERSION__2_0
      • +
    +
    +
    HTTP request version
    +
    • +
  • response_body (str or None) – If HTTP response body match string (regular expressions not +supported) is specified (using LbHttpMonitor.response_body) then +the healthcheck HTTP response body is matched against the specified +string and server is considered healthy only if there is a match. +If the response body string is not specified, HTTP healthcheck is +considered successful if the HTTP response status code is 2xx, but +it can be configured to accept other status codes as successful.
    • +
  • response_status_codes (list of long or None) – The HTTP response status code should be a valid HTTP status code. +format: int32
    • +
  • fall_count (long or None) – num of consecutive checks must fail before marking it down format: +int64
    • +
  • interval (long or None) – the frequency at which the system issues the monitor check (in +second) format: int64
    • +
  • monitor_port (str or None) – If the monitor port is specified, it would override pool member +port setting for healthcheck. A port range is not supported. +format: port-or-range
    • +
  • rise_count (long or None) – num of consecutive checks must pass before marking it up format: +int64
    • +
  • timeout (long or None) – the number of seconds the target has in which to respond to the +monitor request format: int64
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +

    Load balancers monitor the health of backend servers to ensure +traffic is not black holed. There are two types of healthchecks: +active and passive. Passive healthchecks depend on failures in +actual client traffic (e.g. RST from server in response to a client +connection) to detect that the server or the application is down. +In case of active healthchecks, load balancer itself initiates new +connections (or sends ICMP ping) to the servers periodically to +check their health, completely independent of any data traffic. +Currently, active health monitors are supported for HTTP, HTTPS, +TCP, UDP and ICMP protocols.

    +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
+
+
+
+REQUEST_METHOD_GET = 'GET'
+
+ +
+
+REQUEST_METHOD_HEAD = 'HEAD'
+
+ +
+
+REQUEST_METHOD_OPTIONS = 'OPTIONS'
+
+ +
+
+REQUEST_METHOD_POST = 'POST'
+
+ +
+
+REQUEST_METHOD_PUT = 'PUT'
+
+ +
+
+REQUEST_VERSION_1_0 = 'HTTP_VERSION_1_0'
+
+ +
+
+REQUEST_VERSION_1_1 = 'HTTP_VERSION_1_1'
+
+ +
+
+REQUEST_VERSION_2_0 = 'HTTP_VERSION_2_0'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LbHttpProfile(http_redirect_to=None, http_redirect_to_https=None, idle_timeout=None, ntlm=None, request_body_size=None, request_header_size=None, response_timeout=None, x_forwarded_for=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LbHttpProfile', tags=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • http_redirect_to (str or None) – If a website is temporarily down or has moved, incoming requests +for that virtual server can be temporarily redirected to a URL
    • +
  • http_redirect_to_https (bool or None) – Certain secure applications may want to force communication over +SSL, but instead of rejecting non-SSL connections, they may choose +to redirect the client automatically to use SSL.
    • +
  • idle_timeout (long or None) – It is used to specify the HTTP application idle timeout, it means +that how long the load balancer will keep the connection idle to +wait for the client to send the next keep-alive request. It is not +a TCP socket setting. format: int64
    • +
  • ntlm (bool or None) – NTLM is an authentication protocol that can be used over HTTP. If +the flag is set to true, LB will use NTLM challenge/response +methodology.
    • +
  • request_body_size (long or None) – If it is not specified, it means that request body size is +unlimited. format: int64
    • +
  • request_header_size (long or None) – A request with header larger than request_header_size will be +processed as best effort whereas a request with header below this +specified size is guaranteed to be processed. format: int64
    • +
  • response_timeout (long or None) – If server doesn’t send any packet within this time, the connection +is closed. format: int64
    • +
  • x_forwarded_for (str or None) –

    Possible values are:

    + +
    +
    insert or replace x_forwarded_for
    +
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +

    An application profile can be bound to a virtual server to specify +the application protocol characteristics. It is used to influence +how load balancing is performed. Currently, three types of +application profiles are supported: LbFastTCPProfile, +LbFastUDPProfile and LbHttpProfile. LbFastTCPProfile or +LbFastUDPProfile is typically used when the application is using a +custom protocol or a standard protocol not supported by the load +balancer. It is also used in cases where the user only wants L4 +load balancing mainly because L4 load balancing has much higher +performance and scalability, and/or supports connection mirroring. +LbHttpProfile is used for both HTTP and HTTPS applications. Though +application rules, if bound to the virtual server, can be used to +accomplish the same goal, LbHttpProfile is intended to simplify +enabling certain common use cases.

    +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
+
+
+
+XFORWARDED_FOR_INSERT = 'INSERT'
+
+ +
+
+XFORWARDED_FOR_REPLACE = 'REPLACE'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LbHttpRedirectAction(redirect_status=None, redirect_url=None, type='LbHttpRedirectAction')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This action is used to redirect HTTP request messages to a new URL. The +reply_status value specified in this action is used as the status code of +HTTP response message which is sent back to client (Normally a browser). +The HTTP status code for redirection is 3xx, for example, 301, 302, 303, +307, etc. The redirect_url is the new URL that the HTTP request message is +redirected to. Normally browser will send another HTTP request to the new +URL after receiving a redirection response message. Captured variables and +built-in variables can be used in redirect_url field. For example, to +redirect all HTTP requests to HTTPS requests for a virtual server. We +create an LbRule without any conditions, add an LbHttpRedirectAction to the +rule. Set the redirect_url field of the LbHttpRedirectAction to: +https://$_host$_request_uri And set redirect_status to "302", which +means found. This rule will redirect all HTTP requests to HTTPS server port +on the same host.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+ +
+
+class com.vmware.nsx.model_client.LbHttpRejectAction(reply_message=None, reply_status=None, type='LbHttpRejectAction')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This action is used to reject HTTP request messages. The specified +reply_status value is used as the status code for the corresponding HTTP +response message which is sent back to client (Normally a browser) +indicating the reason it was rejected. Reference official HTTP status code +list for your specific HTTP version to set the reply_status properly. +LbHttpRejectAction does not support variables.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+ +
+
+class com.vmware.nsx.model_client.LbHttpRequestBodyCondition(body_value=None, case_sensitive=None, match_type=None, inverse=None, type='LbHttpRequestBodyCondition')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This condition is used to match the message body of an HTTP request. +Typically, only HTTP POST, PATCH, or PUT requests have request body. The +match_type field defines how body_value field is used to match the body of +HTTP requests.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+MATCH_TYPE_CONTAINS = 'CONTAINS'
+
+ +
+
+MATCH_TYPE_ENDS_WITH = 'ENDS_WITH'
+
+ +
+
+MATCH_TYPE_EQUALS = 'EQUALS'
+
+ +
+
+MATCH_TYPE_REGEX = 'REGEX'
+
+ +
+
+MATCH_TYPE_STARTS_WITH = 'STARTS_WITH'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LbHttpRequestCookieCondition(case_sensitive=None, cookie_name=None, cookie_value=None, match_type=None, inverse=None, type='LbHttpRequestCookieCondition')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This condition is used to match HTTP request messages by cookie which is a +specific type of HTTP header. The match_type and case_sensitive define how +to compare cookie value.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+MATCH_TYPE_CONTAINS = 'CONTAINS'
+
+ +
+
+MATCH_TYPE_ENDS_WITH = 'ENDS_WITH'
+
+ +
+
+MATCH_TYPE_EQUALS = 'EQUALS'
+
+ +
+
+MATCH_TYPE_REGEX = 'REGEX'
+
+ +
+
+MATCH_TYPE_STARTS_WITH = 'STARTS_WITH'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LbHttpRequestHeader(header_name=None, header_value=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • header_name (str) – Name of HTTP request header
    • +
  • header_value (str) – Value of HTTP request header
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LbHttpRequestHeaderCondition(case_sensitive=None, header_name=None, header_value=None, match_type=None, inverse=None, type='LbHttpRequestHeaderCondition')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This condition is used to match HTTP request messages by HTTP header +fields. HTTP header fields are components of the header section of HTTP +request and response messages. They define the operating parameters of an +HTTP transaction. For example, Cookie, Authorization, User-Agent, etc. One +condition can be used to match one header field, to match multiple header +fields, multiple conditions must be specified. The match_type field defines +how header_value field is used to match HTTP requests. The header_name +field does not support match types.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+MATCH_TYPE_CONTAINS = 'CONTAINS'
+
+ +
+
+MATCH_TYPE_ENDS_WITH = 'ENDS_WITH'
+
+ +
+
+MATCH_TYPE_EQUALS = 'EQUALS'
+
+ +
+
+MATCH_TYPE_REGEX = 'REGEX'
+
+ +
+
+MATCH_TYPE_STARTS_WITH = 'STARTS_WITH'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LbHttpRequestHeaderDeleteAction(header_name=None, type='LbHttpRequestHeaderDeleteAction')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This action is used to delete header fields of HTTP request messages at +HTTP_REQUEST_REWRITE phase. One action can be used to delete all headers +with same header name. To delete headers with different header names, +multiple actions must be defined.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+ +
+
+class com.vmware.nsx.model_client.LbHttpRequestHeaderRewriteAction(header_name=None, header_value=None, type='LbHttpRequestHeaderRewriteAction')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This action is used to rewrite header fields of matched HTTP request +messages to specified new values. One action can be used to rewrite one +header field. To rewrite multiple header fields, multiple actions must be +defined. Captured variables and built-in variables can be used in the +header_value field, header_name field does not support variables.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+ +
+
+class com.vmware.nsx.model_client.LbHttpRequestMethodCondition(method=None, inverse=None, type='LbHttpRequestMethodCondition')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This condition is used to match method of HTTP requests. If the method of +an HTTP request is same as the method specified in this condition, the HTTP +request match this condition. For example, if the method field is set to +GET in this condition, any HTTP request with GET method matches the +condition.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+METHOD_GET = 'GET'
+
+ +
+
+METHOD_HEAD = 'HEAD'
+
+ +
+
+METHOD_OPTIONS = 'OPTIONS'
+
+ +
+
+METHOD_POST = 'POST'
+
+ +
+
+METHOD_PUT = 'PUT'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LbHttpRequestUriArgumentsCondition(case_sensitive=None, match_type=None, uri_arguments=None, inverse=None, type='LbHttpRequestUriArgumentsCondition')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This condition is used to match URI arguments aka query string of Http +request messages, for example, in URI http://exaple.com?foo=1&bar=2, the +"foo=1&bar=2" is the query string containing URI arguments. In an +URI scheme, query string is indicated by the first question mark +("?") character and terminated by a number sign ("#") +character or by the end of the URI. The uri_arguments field can be +specified as a regular expression(Set match_type to REGEX). For example, +"foo=(?&lt;x&gt;\d+)". It matches HTTP requests whose URI +arguments containing "foo", the value of foo contains only digits. +And the value of foo is captured as $x which can be used in LbRuleAction +fields which support variables.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+MATCH_TYPE_CONTAINS = 'CONTAINS'
+
+ +
+
+MATCH_TYPE_ENDS_WITH = 'ENDS_WITH'
+
+ +
+
+MATCH_TYPE_EQUALS = 'EQUALS'
+
+ +
+
+MATCH_TYPE_REGEX = 'REGEX'
+
+ +
+
+MATCH_TYPE_STARTS_WITH = 'STARTS_WITH'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LbHttpRequestUriCondition(case_sensitive=None, match_type=None, uri=None, inverse=None, type='LbHttpRequestUriCondition')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This condition is used to match URIs(Uniform Resource Identifier) of HTTP +request messages. The URI field can be specified as a regular expression. +If an HTTP request message is requesting an URI which matches specified +regular expression, it matches the condition. The syntax of whole URI looks +like this: +scheme:[//[user[:password]\@]host[:port]][/path][?query][#fragment] This +condition matches only the path part of entire URI. When match_type field +is specified as REGEX, the uri field is used as a regular expression to +match URI path of HTTP requests. For example, to match any URI that has +"/image/" or "/images/", uri field can be specified as: +"/image[s]?/". Named capturing groups can be used in the uri field +to capture substrings of matched URIs and store them in variables for use +in LbRuleAction. For example, specify uri field as: +"/news/(?&lt;year&gt;\d+)/(?&lt;month&gt;\d+)/(?&lt;article&gt;.\*)" +If the URI path is /articles/news/2017/06/xyz.html, then substring +"2017" is captured in variable year, "06" is captured in +variable month, and "xyz.html" is captured in variable article. +These variables can then be used in an LbRuleAction field which supports +variables, such as uri field of LbHttpRequestUriRewriteAction. For example, +set the uri field of LbHttpRequestUriRewriteAction as: +"/articles/news/$year-$month-$article" Then the URI path +/articles/news/2017/06/xyz.html is rewritten to: +"/articles/news/2017-06-xyz.html"

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+MATCH_TYPE_CONTAINS = 'CONTAINS'
+
+ +
+
+MATCH_TYPE_ENDS_WITH = 'ENDS_WITH'
+
+ +
+
+MATCH_TYPE_EQUALS = 'EQUALS'
+
+ +
+
+MATCH_TYPE_REGEX = 'REGEX'
+
+ +
+
+MATCH_TYPE_STARTS_WITH = 'STARTS_WITH'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LbHttpRequestUriRewriteAction(uri=None, uri_arguments=None, type='LbHttpRequestUriRewriteAction')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This action is used to rewrite URIs in matched HTTP request messages. +Specify the uri and uri_arguments fields in this condition to rewrite the +matched HTTP request message’s URI and URI arguments to the new values. +Full URI scheme of HTTP messages have following syntax: +scheme:[//[user[:password]\@]host[:port]][/path][?query][#fragment] The +uri field of this action is used to rewrite the /path part in above scheme. +And the uri_arguments field is used to rewrite the query part. Captured +variables and built-in variables can be used in the uri and uri_arguments +fields. Check the example in LbRuleAction to see how to use variables in +this action.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+ +
+
+class com.vmware.nsx.model_client.LbHttpRequestVersionCondition(version=None, inverse=None, type='LbHttpRequestVersionCondition')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This condition is used to match the HTTP protocol version of the HTTP +request messages.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+VERSION_1_0 = 'HTTP_VERSION_1_0'
+
+ +
+
+VERSION_1_1 = 'HTTP_VERSION_1_1'
+
+ +
+
+VERSION_2_0 = 'HTTP_VERSION_2_0'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LbHttpResponseHeaderCondition(case_sensitive=None, header_name=None, header_value=None, match_type=None, inverse=None, type='LbHttpResponseHeaderCondition')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This condition is used to match HTTP response messages from backend servers +by HTTP header fields. HTTP header fields are components of the header +section of HTTP request and response messages. They define the operating +parameters of an HTTP transaction. For example, Cookie, Authorization, +User-Agent, etc. One condition can be used to match one header field, to +match multiple header fields, multiple conditions must be specified. The +match_type field defines how header_value field is used to match HTTP +responses. The header_name field does not support match types.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+MATCH_TYPE_CONTAINS = 'CONTAINS'
+
+ +
+
+MATCH_TYPE_ENDS_WITH = 'ENDS_WITH'
+
+ +
+
+MATCH_TYPE_EQUALS = 'EQUALS'
+
+ +
+
+MATCH_TYPE_REGEX = 'REGEX'
+
+ +
+
+MATCH_TYPE_STARTS_WITH = 'STARTS_WITH'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LbHttpResponseHeaderDeleteAction(header_name=None, type='LbHttpResponseHeaderDeleteAction')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This action is used to delete header fields of HTTP response messages at +HTTP_RESPONSE_REWRITE phase. One action can be used to delete allgi headers +with same header name. To delete headers with different header names, +multiple actions must be defined

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+ +
+
+class com.vmware.nsx.model_client.LbHttpResponseHeaderRewriteAction(header_name=None, header_value=None, type='LbHttpResponseHeaderRewriteAction')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This action is used to rewrite header fields of HTTP response messages to +specified new values at HTTP_RESPONSE_REWRITE phase. One action can be used +to rewrite one header field. To rewrite multiple header fields, multiple +actions must be defined. Captured variables and built-in variables can be +used in the header_value field, header_name field does not support +variables.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+ +
+
+class com.vmware.nsx.model_client.LbHttpSslCondition(client_certificate_issuer_dn=None, client_certificate_subject_dn=None, client_supported_ssl_ciphers=None, session_reused=None, used_protocol=None, used_ssl_cipher=None, inverse=None, type='LbHttpSslCondition')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This condition is used to match SSL handshake and SSL connection at all +phases.If multiple properties are configured, the rule is considered a +match when all the configured properties are matched.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA = 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA'
+
+ +
+
+CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256'
+
+ +
+
+CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256'
+
+ +
+
+CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA = 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA'
+
+ +
+
+CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384'
+
+ +
+
+CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384'
+
+ +
+
+CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHA = 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA'
+
+ +
+
+CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256'
+
+ +
+
+CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256'
+
+ +
+
+CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHA = 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA'
+
+ +
+
+CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384'
+
+ +
+
+CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384'
+
+ +
+
+CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHA = 'TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA'
+
+ +
+
+CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256'
+
+ +
+
+CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256'
+
+ +
+
+CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHA = 'TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA'
+
+ +
+
+CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384'
+
+ +
+
+CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384'
+
+ +
+
+CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHA = 'TLS_ECDH_RSA_WITH_AES_128_CBC_SHA'
+
+ +
+
+CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256'
+
+ +
+
+CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_RSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256'
+
+ +
+
+CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHA = 'TLS_ECDH_RSA_WITH_AES_256_CBC_SHA'
+
+ +
+
+CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384'
+
+ +
+
+CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_RSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384'
+
+ +
+
+CLIENT_SUPPORTED_SSL_CIPHERS_RSA_WITH_3DES_EDE_CBC_SHA = 'TLS_RSA_WITH_3DES_EDE_CBC_SHA'
+
+ +
+
+CLIENT_SUPPORTED_SSL_CIPHERS_RSA_WITH_AES_128_CBC_SHA = 'TLS_RSA_WITH_AES_128_CBC_SHA'
+
+ +
+
+CLIENT_SUPPORTED_SSL_CIPHERS_RSA_WITH_AES_128_CBC_SHA256 = 'TLS_RSA_WITH_AES_128_CBC_SHA256'
+
+ +
+
+CLIENT_SUPPORTED_SSL_CIPHERS_RSA_WITH_AES_128_GCM_SHA256 = 'TLS_RSA_WITH_AES_128_GCM_SHA256'
+
+ +
+
+CLIENT_SUPPORTED_SSL_CIPHERS_RSA_WITH_AES_256_CBC_SHA = 'TLS_RSA_WITH_AES_256_CBC_SHA'
+
+ +
+
+CLIENT_SUPPORTED_SSL_CIPHERS_RSA_WITH_AES_256_CBC_SHA256 = 'TLS_RSA_WITH_AES_256_CBC_SHA256'
+
+ +
+
+CLIENT_SUPPORTED_SSL_CIPHERS_RSA_WITH_AES_256_GCM_SHA384 = 'TLS_RSA_WITH_AES_256_GCM_SHA384'
+
+ +
+
+SESSION_REUSED_IGNORE = 'IGNORE'
+
+ +
+
+SESSION_REUSED_NEW = 'NEW'
+
+ +
+
+SESSION_REUSED_REUSED = 'REUSED'
+
+ +
+
+USED_PROTOCOL_SSL_V2 = 'SSL_V2'
+
+ +
+
+USED_PROTOCOL_SSL_V3 = 'SSL_V3'
+
+ +
+
+USED_PROTOCOL_TLS_V1 = 'TLS_V1'
+
+ +
+
+USED_PROTOCOL_TLS_V1_1 = 'TLS_V1_1'
+
+ +
+
+USED_PROTOCOL_TLS_V1_2 = 'TLS_V1_2'
+
+ +
+
+USED_SSL_CIPHER_ECDHE_ECDSA_WITH_AES_128_CBC_SHA = 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA'
+
+ +
+
+USED_SSL_CIPHER_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256'
+
+ +
+
+USED_SSL_CIPHER_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256'
+
+ +
+
+USED_SSL_CIPHER_ECDHE_ECDSA_WITH_AES_256_CBC_SHA = 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA'
+
+ +
+
+USED_SSL_CIPHER_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384'
+
+ +
+
+USED_SSL_CIPHER_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384'
+
+ +
+
+USED_SSL_CIPHER_ECDHE_RSA_WITH_AES_128_CBC_SHA = 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA'
+
+ +
+
+USED_SSL_CIPHER_ECDHE_RSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256'
+
+ +
+
+USED_SSL_CIPHER_ECDHE_RSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256'
+
+ +
+
+USED_SSL_CIPHER_ECDHE_RSA_WITH_AES_256_CBC_SHA = 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA'
+
+ +
+
+USED_SSL_CIPHER_ECDHE_RSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384'
+
+ +
+
+USED_SSL_CIPHER_ECDHE_RSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384'
+
+ +
+
+USED_SSL_CIPHER_ECDH_ECDSA_WITH_AES_128_CBC_SHA = 'TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA'
+
+ +
+
+USED_SSL_CIPHER_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256'
+
+ +
+
+USED_SSL_CIPHER_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256'
+
+ +
+
+USED_SSL_CIPHER_ECDH_ECDSA_WITH_AES_256_CBC_SHA = 'TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA'
+
+ +
+
+USED_SSL_CIPHER_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384'
+
+ +
+
+USED_SSL_CIPHER_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384'
+
+ +
+
+USED_SSL_CIPHER_ECDH_RSA_WITH_AES_128_CBC_SHA = 'TLS_ECDH_RSA_WITH_AES_128_CBC_SHA'
+
+ +
+
+USED_SSL_CIPHER_ECDH_RSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256'
+
+ +
+
+USED_SSL_CIPHER_ECDH_RSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256'
+
+ +
+
+USED_SSL_CIPHER_ECDH_RSA_WITH_AES_256_CBC_SHA = 'TLS_ECDH_RSA_WITH_AES_256_CBC_SHA'
+
+ +
+
+USED_SSL_CIPHER_ECDH_RSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384'
+
+ +
+
+USED_SSL_CIPHER_ECDH_RSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384'
+
+ +
+
+USED_SSL_CIPHER_RSA_WITH_3DES_EDE_CBC_SHA = 'TLS_RSA_WITH_3DES_EDE_CBC_SHA'
+
+ +
+
+USED_SSL_CIPHER_RSA_WITH_AES_128_CBC_SHA = 'TLS_RSA_WITH_AES_128_CBC_SHA'
+
+ +
+
+USED_SSL_CIPHER_RSA_WITH_AES_128_CBC_SHA256 = 'TLS_RSA_WITH_AES_128_CBC_SHA256'
+
+ +
+
+USED_SSL_CIPHER_RSA_WITH_AES_128_GCM_SHA256 = 'TLS_RSA_WITH_AES_128_GCM_SHA256'
+
+ +
+
+USED_SSL_CIPHER_RSA_WITH_AES_256_CBC_SHA = 'TLS_RSA_WITH_AES_256_CBC_SHA'
+
+ +
+
+USED_SSL_CIPHER_RSA_WITH_AES_256_CBC_SHA256 = 'TLS_RSA_WITH_AES_256_CBC_SHA256'
+
+ +
+
+USED_SSL_CIPHER_RSA_WITH_AES_256_GCM_SHA384 = 'TLS_RSA_WITH_AES_256_GCM_SHA384'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LbHttpsMonitor(certificate_chain_depth=None, cipher_group_label=None, ciphers=None, client_certificate_id=None, is_fips=None, is_secure=None, protocols=None, request_body=None, request_headers=None, request_method=None, request_url=None, request_version=None, response_body=None, response_status_codes=None, server_auth=None, server_auth_ca_ids=None, server_auth_crl_ids=None, fall_count=None, interval=None, monitor_port=None, rise_count=None, timeout=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA = 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA'
+
+ +
+
+CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256'
+
+ +
+
+CIPHERS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256'
+
+ +
+
+CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA = 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA'
+
+ +
+
+CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384'
+
+ +
+
+CIPHERS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384'
+
+ +
+
+CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHA = 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA'
+
+ +
+
+CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256'
+
+ +
+
+CIPHERS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256'
+
+ +
+
+CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHA = 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA'
+
+ +
+
+CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384'
+
+ +
+
+CIPHERS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384'
+
+ +
+
+CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHA = 'TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA'
+
+ +
+
+CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256'
+
+ +
+
+CIPHERS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256'
+
+ +
+
+CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHA = 'TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA'
+
+ +
+
+CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384'
+
+ +
+
+CIPHERS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384'
+
+ +
+
+CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHA = 'TLS_ECDH_RSA_WITH_AES_128_CBC_SHA'
+
+ +
+
+CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256'
+
+ +
+
+CIPHERS_ECDH_RSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256'
+
+ +
+
+CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHA = 'TLS_ECDH_RSA_WITH_AES_256_CBC_SHA'
+
+ +
+
+CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384'
+
+ +
+
+CIPHERS_ECDH_RSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384'
+
+ +
+
+CIPHERS_RSA_WITH_3DES_EDE_CBC_SHA = 'TLS_RSA_WITH_3DES_EDE_CBC_SHA'
+
+ +
+
+CIPHERS_RSA_WITH_AES_128_CBC_SHA = 'TLS_RSA_WITH_AES_128_CBC_SHA'
+
+ +
+
+CIPHERS_RSA_WITH_AES_128_CBC_SHA256 = 'TLS_RSA_WITH_AES_128_CBC_SHA256'
+
+ +
+
+CIPHERS_RSA_WITH_AES_128_GCM_SHA256 = 'TLS_RSA_WITH_AES_128_GCM_SHA256'
+
+ +
+
+CIPHERS_RSA_WITH_AES_256_CBC_SHA = 'TLS_RSA_WITH_AES_256_CBC_SHA'
+
+ +
+
+CIPHERS_RSA_WITH_AES_256_CBC_SHA256 = 'TLS_RSA_WITH_AES_256_CBC_SHA256'
+
+ +
+
+CIPHERS_RSA_WITH_AES_256_GCM_SHA384 = 'TLS_RSA_WITH_AES_256_GCM_SHA384'
+
+ +
+
+CIPHER_GROUP_LABEL_BALANCED = 'BALANCED'
+
+ +
+
+CIPHER_GROUP_LABEL_CUSTOM = 'CUSTOM'
+
+ +
+
+CIPHER_GROUP_LABEL_HIGH_COMPATIBILITY = 'HIGH_COMPATIBILITY'
+
+ +
+
+CIPHER_GROUP_LABEL_HIGH_SECURITY = 'HIGH_SECURITY'
+
+ +
+
+PROTOCOLS_SSL_V2 = 'SSL_V2'
+
+ +
+
+PROTOCOLS_SSL_V3 = 'SSL_V3'
+
+ +
+
+PROTOCOLS_TLS_V1 = 'TLS_V1'
+
+ +
+
+PROTOCOLS_TLS_V1_1 = 'TLS_V1_1'
+
+ +
+
+PROTOCOLS_TLS_V1_2 = 'TLS_V1_2'
+
+ +
+
+REQUEST_METHOD_GET = 'GET'
+
+ +
+
+REQUEST_METHOD_HEAD = 'HEAD'
+
+ +
+
+REQUEST_METHOD_OPTIONS = 'OPTIONS'
+
+ +
+
+REQUEST_METHOD_POST = 'POST'
+
+ +
+
+REQUEST_METHOD_PUT = 'PUT'
+
+ +
+
+REQUEST_VERSION_1_0 = 'HTTP_VERSION_1_0'
+
+ +
+
+REQUEST_VERSION_1_1 = 'HTTP_VERSION_1_1'
+
+ +
+
+REQUEST_VERSION_2_0 = 'HTTP_VERSION_2_0'
+
+ +
+
+SERVER_AUTH_IGNORE = 'IGNORE'
+
+ +
+
+SERVER_AUTH_REQUIRED = 'REQUIRED'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LbIcmpMonitor(data_length=None, fall_count=None, interval=None, monitor_port=None, rise_count=None, timeout=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • data_length (long or None) – The data size(in byte) of the ICMP healthcheck packet format: int64
    • +
  • fall_count (long or None) – num of consecutive checks must fail before marking it down format: +int64
    • +
  • interval (long or None) – the frequency at which the system issues the monitor check (in +second) format: int64
    • +
  • monitor_port (str or None) – If the monitor port is specified, it would override pool member +port setting for healthcheck. A port range is not supported. +format: port-or-range
    • +
  • rise_count (long or None) – num of consecutive checks must pass before marking it up format: +int64
    • +
  • timeout (long or None) – the number of seconds the target has in which to respond to the +monitor request format: int64
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +

    Load balancers monitor the health of backend servers to ensure +traffic is not black holed. There are two types of healthchecks: +active and passive. Passive healthchecks depend on failures in +actual client traffic (e.g. RST from server in response to a client +connection) to detect that the server or the application is down. +In case of active healthchecks, load balancer itself initiates new +connections (or sends ICMP ping) to the servers periodically to +check their health, completely independent of any data traffic. +Currently, active health monitors are supported for HTTP, HTTPS, +TCP, UDP and ICMP protocols.

    +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LbIpHeaderCondition(source_address=None, inverse=None, type='LbIpHeaderCondition')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This condition is used to match IP header fields of HTTP messages. +Currently, only the source IP address is supported. IP addresses can be +expressed as a single IP address like 10.1.1.1, or a range of IP addresses +like 10.1.1.101-10.1.1.160. Both IPv4 and IPv6 addresses are supported.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+ +
+
+class com.vmware.nsx.model_client.LbMonitor(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LbMonitor', tags=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +

    Load balancers monitor the health of backend servers to ensure +traffic is not black holed. There are two types of healthchecks: +active and passive. Passive healthchecks depend on failures in +actual client traffic (e.g. RST from server in response to a client +connection) to detect that the server or the application is down. +In case of active healthchecks, load balancer itself initiates new +connections (or sends ICMP ping) to the servers periodically to +check their health, completely independent of any data traffic. +Currently, active health monitors are supported for HTTP, HTTPS, +TCP, UDP and ICMP protocols.

    +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
+
+
+
+RESOURCE_TYPE_LBHTTPMONITOR = 'LbHttpMonitor'
+
+ +
+
+RESOURCE_TYPE_LBHTTPSMONITOR = 'LbHttpsMonitor'
+
+ +
+
+RESOURCE_TYPE_LBICMPMONITOR = 'LbIcmpMonitor'
+
+ +
+
+RESOURCE_TYPE_LBPASSIVEMONITOR = 'LbPassiveMonitor'
+
+ +
+
+RESOURCE_TYPE_LBTCPMONITOR = 'LbTcpMonitor'
+
+ +
+
+RESOURCE_TYPE_LBUDPMONITOR = 'LbUdpMonitor'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LbMonitorListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of vmware.vapi.struct.VapiStruct) – paginated list of load balancer monitors +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +LbMonitor. When methods return a value of this class as a +return value, the attribute will contain all the attributes defined +in LbMonitor.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LbPassiveMonitor(max_fails=None, timeout=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LbPassiveMonitor', tags=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • max_fails (long or None) – When the consecutive failures reach this value, then the member is +considered temporarily unavailable for a configurable period +format: int64
    • +
  • timeout (long or None) – After this timeout period, the member is tried again for a new +connection to see if it is available. format: int64
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +

    Load balancers monitor the health of backend servers to ensure +traffic is not black holed. There are two types of healthchecks: +active and passive. Passive healthchecks depend on failures in +actual client traffic (e.g. RST from server in response to a client +connection) to detect that the server or the application is down. +In case of active healthchecks, load balancer itself initiates new +connections (or sends ICMP ping) to the servers periodically to +check their health, completely independent of any data traffic. +Currently, active health monitors are supported for HTTP, HTTPS, +TCP, UDP and ICMP protocols.

    +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LbPersistenceCookieTime(cookie_max_idle=None, type='LbPersistenceCookieTime')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • cookie_max_idle (long) – HTTP cookie max-age to expire cookie, only available for insert +mode. format: int64
    • +
  • type (str) –

    Possible values are:

    + +

    Both session cookie and persistence cookie are supported, Use +LbSessionCookieTime for session cookie time setting, Use +LbPersistenceCookieTime for persistence cookie time setting

    +
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LbPersistenceProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LbPersistenceProfile', tags=None, persistence_shared=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +

    Source-ip persistence ensures all connections from a client +(identified by IP address) are sent to the same backend server for +a specified period. Cookie persistence allows related client +connections, identified by the same cookie in HTTP requests, to be +redirected to the same server.

    +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • persistence_shared (bool or None) – If persistence shared flag is not set in the cookie persistence +profile bound to a virtual server, it defaults to cookie +persistence that is private to each virtual server and is qualified +by the pool. This is accomplished by load balancer inserting a +cookie with name in the format +<name>.<virtual_server_id>.<pool_id>. If persistence shared flag is +set in the cookie persistence profile, in cookie insert mode, +cookie persistence could be shared across multiple virtual servers +that are bound to the same pools. The cookie name would be changed +to <name>.<profile-id>.<pool-id>. If persistence shared flag is not +set in the sourceIp persistence profile bound to a virtual server, +each virtual server that the profile is bound to maintains its own +private persistence table. If persistence shared flag is set in the +sourceIp persistence profile, all virtual servers the profile is +bound to share the same persistence table.
    • +
+
+
+
+RESOURCE_TYPE_LBCOOKIEPERSISTENCEPROFILE = 'LbCookiePersistenceProfile'
+
+ +
+
+RESOURCE_TYPE_LBSOURCEIPPERSISTENCEPROFILE = 'LbSourceIpPersistenceProfile'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LbPersistenceProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of vmware.vapi.struct.VapiStruct) – paginated list of load balancer persistence profiles +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +LbPersistenceProfile. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in LbPersistenceProfile.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LbPool(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, active_monitor_ids=None, algorithm=None, member_group=None, members=None, min_active_members=None, passive_monitor_id=None, snat_translation=None, tcp_multiplexing_enabled=None, tcp_multiplexing_number=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • active_monitor_ids (list of str or None) – In case of active healthchecks, load balancer itself initiates new +connections (or sends ICMP ping) to the servers periodically to +check their health, completely independent of any data traffic. +Active healthchecks are disabled by default and can be enabled for +a server pool by binding a health monitor to the pool. Currently, +only one active health monitor can be configured per server pool.
    • +
  • algorithm (str or None) –

    Possible values are:

    + +

    Load balancing algorithm, configurable per pool controls how the +incoming connections are distributed among the members.

    +
    • +
  • member_group (PoolMemberGroup or None) – Load balancer pool support grouping object as dynamic pool members. +When member group is defined, members setting should not be +specified.
    • +
  • members (list of PoolMember or None) – Server pool consists of one or more pool members. Each pool member +is identified, typically, by an IP address and a port.
    • +
  • min_active_members (long or None) – A pool is considered active if there are at least certain minimum +number of members. format: int64
    • +
  • passive_monitor_id (str or None) – Passive healthchecks are disabled by default and can be enabled by +attaching a passive health monitor to a server pool. Each time a +client connection to a pool member fails, its failed count is +incremented. For pools bound to L7 virtual servers, a connection is +considered to be failed and failed count is incremented if any TCP +connection errors (e.g. TCP RST or failure to send data) or SSL +handshake failures occur. For pools bound to L4 virtual servers, if +no response is received to a TCP SYN sent to the pool member or if +a TCP RST is received in response to a TCP SYN, then the pool +member is considered to have failed and the failed count is +incremented.
    • +
  • snat_translation (vmware.vapi.struct.VapiStruct or None) – Depending on the topology, Source NAT (SNAT) may be required to +ensure traffic from the server destined to the client is received +by the load balancer. SNAT can be enabled per pool. If SNAT is not +enabled for a pool, then load balancer uses the client IP and port +(spoofing) while establishing connections to the servers. This is +referred to as no-SNAT or TRANSPARENT mode. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +LbSnatTranslation. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in LbSnatTranslation.
    • +
  • tcp_multiplexing_enabled (bool or None) – TCP multiplexing allows the same TCP connection between load +balancer and the backend server to be used for sending multiple +client requests from different client TCP connections.
    • +
  • tcp_multiplexing_number (long or None) – The maximum number of TCP connections per pool that are idly kept +alive for sending future client requests. format: int64
    • +
+
+
+
+ALGORITHM_IP_HASH = 'IP_HASH'
+
+ +
+
+ALGORITHM_LEAST_CONNECTION = 'LEAST_CONNECTION'
+
+ +
+
+ALGORITHM_ROUND_ROBIN = 'ROUND_ROBIN'
+
+ +
+
+ALGORITHM_WEIGHTED_LEAST_CONNECTION = 'WEIGHTED_LEAST_CONNECTION'
+
+ +
+
+ALGORITHM_WEIGHTED_ROUND_ROBIN = 'WEIGHTED_ROUND_ROBIN'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LbPoolListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of LbPool) – paginated list of pools
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LbPoolMemberStatistics(ip_address=None, port=None, statistics=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • ip_address (str) – Pool member IP address format: ip
    • +
  • port (str or None) – The port is configured in pool member. For virtual server port +range case, pool member port must be null. format: port-or-range
    • +
  • statistics (LbStatisticsCounter) – Pool member statistics counter
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LbPoolMemberStatus(failure_cause=None, ip_address=None, last_check_time=None, last_state_change_time=None, port=None, status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • failure_cause (str or None) – The healthcheck failure cause when status is DOWN
    • +
  • ip_address (str) – Pool member IP address format: ip
    • +
  • last_check_time (long or None) – Timestamp in milliseconds since epoch format: int64
    • +
  • last_state_change_time (long or None) – Timestamp in milliseconds since epoch format: int64
    • +
  • port (str or None) – The port is configured in pool member. For virtual server port +range case, pool member port must be null. format: port-or-range
    • +
  • status (str) –

    Possible values are:

    + +

    UP means that pool member is enabled and monitors have marked the +pool member as UP. If the pool member has no monitor configured, it +would be treated as UP. DOWN means that pool member is enabled and +monitors have marked the pool member as DOWN. DISABLED means that +admin state of pool member is set to DISABLED. GRACEFUL_DISABLED +means that admin state of pool member is set to GRACEFUL_DISABLED. +UNUSED means that the pool member is not used when the IP list size +of member group exceeds the maximum setting. The remaining IP +addresses would not be used as available backend servers, hence +mark the status as UNUSED.

    +
    • +
+
+
+
+STATUS_DISABLED = 'DISABLED'
+
+ +
+
+STATUS_DOWN = 'DOWN'
+
+ +
+
+STATUS_GRACEFUL_DISABLED = 'GRACEFUL_DISABLED'
+
+ +
+
+STATUS_UNUSED = 'UNUSED'
+
+ +
+
+STATUS_UP = 'UP'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LbPoolStatistics(last_update_timestamp=None, members=None, pool_id=None, statistics=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • last_update_timestamp (long or None) – Timestamp when the data was last updated format: int64
    • +
  • members (list of LbPoolMemberStatistics or None) – Statistics of load balancer pool members
    • +
  • pool_id (str) – Load balancer pool identifier
    • +
  • statistics (LbStatisticsCounter) – Virtual server statistics counter
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LbPoolStatisticsListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of LbPoolStatistics) – paginated statistics list of pools
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LbPoolStatus(last_update_timestamp=None, members=None, pool_id=None, status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • last_update_timestamp (long or None) – Timestamp when the data was last updated format: int64
    • +
  • members (list of LbPoolMemberStatus or None) – Status of load balancer pool members
    • +
  • pool_id (str) – Load balancer pool identifier
    • +
  • status (str or None) –

    Possible values are:

    + +

    UP means that all primary members are in UP status. PARTIALLY_UP +means that some(not all) primary members are in UP status, the +number of these active members is larger or equal to certain +number(min_active_members) which is defined in LbPool. When there +are no backup members which are in the UP status, the +number(min_active_members) would be ignored. PRIMARY_DOWN means +that less than certain(min_active_members) primary members are in +UP status but backup members are in UP status, connections to this +pool would be dispatched to backup members. DOWN means that all +primary and backup members are DOWN. DETACHED means that the pool +is not bound to any virtual server. UNKOWN means that no status +reported from transport-nodes. The associated load balancer service +may be working(or not working).

    +
    • +
+
+
+
+STATUS_DETACHED = 'DETACHED'
+
+ +
+
+STATUS_DOWN = 'DOWN'
+
+ +
+
+STATUS_PARTIALLY_UP = 'PARTIALLY_UP'
+
+ +
+
+STATUS_PRIMARY_DOWN = 'PRIMARY_DOWN'
+
+ +
+
+STATUS_UNKNOWN = 'UNKNOWN'
+
+ +
+
+STATUS_UP = 'UP'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LbPoolStatusListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of LbPoolStatus) – paginated status list of pools
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LbRule(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, actions=None, match_conditions=None, match_strategy=None, phase=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Load balancer rules allow customization of load balancing behavior using +match/action rules. Currently, load balancer rules are supported for only +layer 7 virtual servers with application profile LbHttpProfile. Each +application rule consists of one or more match conditions and one or more +actions. Load balancer rules could be used by different load balancer +services.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • actions (list of vmware.vapi.struct.VapiStruct) – A list of actions to be executed at specified phase when load +balancer rule matches. The actions are used to manipulate +application traffic, such as rewrite URI of HTTP messages, redirect +HTTP messages, etc. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +LbRuleAction. When methods return a value of this class as +a return value, the attribute will contain all the attributes +defined in LbRuleAction.
    • +
  • match_conditions (list of vmware.vapi.struct.VapiStruct or None) – A list of match conditions used to match application traffic. +Multiple match conditions can be specified in one load balancer +rule, each match condition defines a criterion to match application +traffic. If no match conditions are specified, then the load +balancer rule will always match and it is used typically to define +default rules. If more than one match condition is specified, then +match strategy determines if all conditions should match or any one +condition should match for the load balancer rule to considered a +match. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +LbRuleCondition. When methods return a value of this class +as a return value, the attribute will contain all the attributes +defined in LbRuleCondition.
    • +
  • match_strategy (str) –

    Possible values are:

    + +

    Strategy to define how load balancer rule is considered a match +when multiple match conditions are specified in one rule. If +match_stragety is set to ALL, then load balancer rule is considered +a match only if all the conditions match. If match_strategy is set +to ANY, then load balancer rule is considered a match if any one of +the conditions match.

    +
    • +
  • phase (str) –

    Possible values are:

    + +

    Each load balancer rule is used at a specific phase of load +balancer processing. Currently three phases are supported, +HTTP_REQUEST_REWRITE, HTTP_FORWARDING and HTTP_RESPONSE_REWRITE. +When an HTTP request message is received by load balancer, all +HTTP_REQUEST_REWRITE rules, if present are executed in the order +they are applied to virtual server. And then if HTTP_FORWARDING +rules present, only first matching rule’s action is executed, +remaining rules are not checked. HTTP_FORWARDING rules can have +only one action. If the request is forwarded to a backend server +and the response goes back to load balancer, all +HTTP_RESPONSE_REWRITE rules, if present, are executed in the order +they are applied to the virtual server.

    +
    • +
+
+
+
+MATCH_STRATEGY_ALL = 'ALL'
+
+ +
+
+MATCH_STRATEGY_ANY = 'ANY'
+
+ +
+
+PHASE_FORWARDING = 'HTTP_FORWARDING'
+
+ +
+
+PHASE_REQUEST_REWRITE = 'HTTP_REQUEST_REWRITE'
+
+ +
+
+PHASE_RESPONSE_REWRITE = 'HTTP_RESPONSE_REWRITE'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LbRuleAction(type='LbRuleAction')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Load balancer rule actions are used to manipulate application traffic. +Currently load balancer rules can be used at three load balancer processing +phases. Each phase has its own supported type of actions. Supported actions +in HTTP_REQUST_REWRITE phase are: LbHttpRequestUriRewriteAction +LbHttpRequestHeaderRewriteAction LbHttpRequestHeaderDeleteAction +LbVariableAssignmentAction Supported actions in HTTP_FORWARDING phase are: +LbHttpRejectAction LbHttpRedirectAction LbSelectPoolAction Supported action +in HTTP_RESPONSE_REWRITE phase is: LbHttpResponseHeaderRewriteAction +LbHttpResponseHeaderDeleteAction If the match type of an LbRuleCondition +field is specified as REGEX and named capturing groups are used in the +specified regular expression. The groups can be used as variables in +LbRuleAction fields. For example, define a rule with +LbHttpRequestUriCondition as match condition and +LbHttpRequestUriRewriteAction as action. Set match_type field of +LbHttpRequestUriCondition to REGEX, and set uri field to +"/news/(?&lt;year&gt;\d+)/(?&lt;month&gt;\d+)/(?&lt;article&gt;.\*)". +Set uri field of LbHttpRequestUriRewriteAction to: +"/news/$year-$month/$article" In uri field of +LbHttpRequestUriCondition, the (?&lt;year&gt;\d+), +(?&lt;month&gt;\d+) and (?&lt;article&gt;.\*) are named capturing +groups, they define variables named $year, $month and $article +respectively. The defined variables are used in +LbHttpRequestUriRewriteAction. For a matched HTTP request with URI +"/news/2017/06/xyz.html", the substring "2017" is captured +in variable $year, "06" is captured in variable $month, and +"xyz.html" is captured in variable $article. The +LbHttpRequestUriRewriteAction will rewrite the URI to: +"/news/2017-06/xyz.html" A set of built-in variables can be used in +LbRuleAction as well. The name of built-in variables start with underscore, +the name of user defined variables is not allowed to start with underscore. +Following are some of the built-in variables: $_scheme: Reference the +scheme part of matched HTTP messages, could be "http" or +"https". $_host: Host of matched HTTP messages, for example +"www.example.com". $_server_port: Port part of URI, it is also the +port of the server which accepted a request. Default port is 80 for http +and 443 for https. $_uri: The URI path, for example +"/products/sample.html". $_request_uri: Full original request URI +with arguments, for example, "/products/sample.html?a=b&c=d". +$_args: URI arguments, for instance "a=b&c=d" $_is_args: +"?" if a request has URI arguments, or an empty string otherwise. +For the full list of built-in variables, please reference the NSX-T +Administrator’s Guide.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:type (str) –

Possible values are:

+ +
+
Type of load balancer rule action
+
+
+
+TYPE_LBHTTPREDIRECTACTION = 'LbHttpRedirectAction'
+
+ +
+
+TYPE_LBHTTPREJECTACTION = 'LbHttpRejectAction'
+
+ +
+
+TYPE_LBHTTPREQUESTHEADERDELETEACTION = 'LbHttpRequestHeaderDeleteAction'
+
+ +
+
+TYPE_LBHTTPREQUESTHEADERREWRITEACTION = 'LbHttpRequestHeaderRewriteAction'
+
+ +
+
+TYPE_LBHTTPREQUESTURIREWRITEACTION = 'LbHttpRequestUriRewriteAction'
+
+ +
+
+TYPE_LBHTTPRESPONSEHEADERDELETEACTION = 'LbHttpResponseHeaderDeleteAction'
+
+ +
+
+TYPE_LBHTTPRESPONSEHEADERREWRITEACTION = 'LbHttpResponseHeaderRewriteAction'
+
+ +
+
+TYPE_LBSELECTPOOLACTION = 'LbSelectPoolAction'
+
+ +
+
+TYPE_LBSELECTSERVERACTION = 'LbSelectServerAction'
+
+ +
+
+TYPE_LBVARIABLEASSIGNMENTACTION = 'LbVariableAssignmentAction'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LbRuleCondition(inverse=None, type='LbRuleCondition')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Match conditions are used to match application traffic passing through load +balancers. Multiple match conditions can be specified in one load balancer +rule, each match condition defines a criterion for application traffic. If +inverse field is set to true, the match result of the condition is +inverted. If more than one match condition is specified, match strategy +determines if all conditions should match or any one condition should match +for the load balancer rule to be considered a match. Currently only HTTP +messages are supported by load balancer rules. Each load balancer rule is +used at a specific phase of load balancer processing. Currently three +phases are supported, HTTP_REQUEST_REWRITE, HTTP_FORWARDING and +HTTP_RESPONSE_REWRITE. Each phase supports certain types of match +conditions, supported match conditions in HTTP_REQUEST_REWRITE phase are: +LbHttpRequestMethodCondition LbHttpRequestUriCondition +LbHttpRequestUriArgumentsCondition LbHttpRequestVersionCondition +LbHttpRequestHeaderCondition LbHttpRequestCookieCondition +LbHttpRequestBodyCondition LbTcpHeaderCondition LbIpHeaderCondition +LbVariableCondition LbHttpSslCondition Supported match conditions in +HTTP_FORWARDING phase are: LbHttpRequestMethodCondition +LbHttpRequestUriCondition LbHttpRequestVersionCondition +LbHttpRequestHeaderCondition LbHttpRequestCookieCondition +LbHttpRequestBodyCondition LbTcpHeaderCondition LbIpHeaderCondition +LbVariableCondition LbHttpSslCondition Supported match condition in +HTTP_RESPONSE_REWRITE phase is: LbHttpResponseHeaderCondition +LbHttpRequestMethodCondition LbHttpRequestUriCondition +LbHttpRequestUriArgumentsCondition LbHttpRequestVersionCondition +LbHttpRequestHeaderCondition LbHttpRequestCookieCondition +LbTcpHeaderCondition LbIpHeaderCondition LbVariableCondition +LbHttpSslCondition

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+TYPE_LBHTTPREQUESTBODYCONDITION = 'LbHttpRequestBodyCondition'
+
+ +
+
+TYPE_LBHTTPREQUESTCOOKIECONDITION = 'LbHttpRequestCookieCondition'
+
+ +
+
+TYPE_LBHTTPREQUESTHEADERCONDITION = 'LbHttpRequestHeaderCondition'
+
+ +
+
+TYPE_LBHTTPREQUESTMETHODCONDITION = 'LbHttpRequestMethodCondition'
+
+ +
+
+TYPE_LBHTTPREQUESTURIARGUMENTSCONDITION = 'LbHttpRequestUriArgumentsCondition'
+
+ +
+
+TYPE_LBHTTPREQUESTURICONDITION = 'LbHttpRequestUriCondition'
+
+ +
+
+TYPE_LBHTTPREQUESTVERSIONCONDITION = 'LbHttpRequestVersionCondition'
+
+ +
+
+TYPE_LBHTTPRESPONSEHEADERCONDITION = 'LbHttpResponseHeaderCondition'
+
+ +
+
+TYPE_LBHTTPSSLCONDITION = 'LbHttpSslCondition'
+
+ +
+
+TYPE_LBIPHEADERCONDITION = 'LbIpHeaderCondition'
+
+ +
+
+TYPE_LBTCPHEADERCONDITION = 'LbTcpHeaderCondition'
+
+ +
+
+TYPE_LBVARIABLECONDITION = 'LbVariableCondition'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LbRuleListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of LbRule) – paginated list of LB rules
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LbSelectPoolAction(pool_id=None, type='LbSelectPoolAction')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This action is used to select a pool for matched HTTP request messages. The +pool is specified by UUID. The matched HTTP request messages are forwarded +to the specified pool.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+ +
+
+class com.vmware.nsx.model_client.LbServerSslProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, cipher_group_label=None, ciphers=None, is_fips=None, is_secure=None, protocols=None, session_cache_enabled=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA = 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA'
+
+ +
+
+CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256'
+
+ +
+
+CIPHERS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256'
+
+ +
+
+CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA = 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA'
+
+ +
+
+CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384'
+
+ +
+
+CIPHERS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384'
+
+ +
+
+CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHA = 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA'
+
+ +
+
+CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256'
+
+ +
+
+CIPHERS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256'
+
+ +
+
+CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHA = 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA'
+
+ +
+
+CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384'
+
+ +
+
+CIPHERS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384'
+
+ +
+
+CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHA = 'TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA'
+
+ +
+
+CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256'
+
+ +
+
+CIPHERS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256'
+
+ +
+
+CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHA = 'TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA'
+
+ +
+
+CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384'
+
+ +
+
+CIPHERS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384'
+
+ +
+
+CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHA = 'TLS_ECDH_RSA_WITH_AES_128_CBC_SHA'
+
+ +
+
+CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256'
+
+ +
+
+CIPHERS_ECDH_RSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256'
+
+ +
+
+CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHA = 'TLS_ECDH_RSA_WITH_AES_256_CBC_SHA'
+
+ +
+
+CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384'
+
+ +
+
+CIPHERS_ECDH_RSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384'
+
+ +
+
+CIPHERS_RSA_WITH_3DES_EDE_CBC_SHA = 'TLS_RSA_WITH_3DES_EDE_CBC_SHA'
+
+ +
+
+CIPHERS_RSA_WITH_AES_128_CBC_SHA = 'TLS_RSA_WITH_AES_128_CBC_SHA'
+
+ +
+
+CIPHERS_RSA_WITH_AES_128_CBC_SHA256 = 'TLS_RSA_WITH_AES_128_CBC_SHA256'
+
+ +
+
+CIPHERS_RSA_WITH_AES_128_GCM_SHA256 = 'TLS_RSA_WITH_AES_128_GCM_SHA256'
+
+ +
+
+CIPHERS_RSA_WITH_AES_256_CBC_SHA = 'TLS_RSA_WITH_AES_256_CBC_SHA'
+
+ +
+
+CIPHERS_RSA_WITH_AES_256_CBC_SHA256 = 'TLS_RSA_WITH_AES_256_CBC_SHA256'
+
+ +
+
+CIPHERS_RSA_WITH_AES_256_GCM_SHA384 = 'TLS_RSA_WITH_AES_256_GCM_SHA384'
+
+ +
+
+CIPHER_GROUP_LABEL_BALANCED = 'BALANCED'
+
+ +
+
+CIPHER_GROUP_LABEL_CUSTOM = 'CUSTOM'
+
+ +
+
+CIPHER_GROUP_LABEL_HIGH_COMPATIBILITY = 'HIGH_COMPATIBILITY'
+
+ +
+
+CIPHER_GROUP_LABEL_HIGH_SECURITY = 'HIGH_SECURITY'
+
+ +
+
+PROTOCOLS_SSL_V2 = 'SSL_V2'
+
+ +
+
+PROTOCOLS_SSL_V3 = 'SSL_V3'
+
+ +
+
+PROTOCOLS_TLS_V1 = 'TLS_V1'
+
+ +
+
+PROTOCOLS_TLS_V1_1 = 'TLS_V1_1'
+
+ +
+
+PROTOCOLS_TLS_V1_2 = 'TLS_V1_2'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LbServerSslProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of LbServerSslProfile) – paginated list of load balancer server SSL profiles
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LbService(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, access_log_enabled=None, attachment=None, enabled=None, error_log_level=None, size=None, virtual_server_ids=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • access_log_enabled (bool or None) – whether access log is enabled
    • +
  • attachment (ResourceReference or None) – LBS could be instantiated (or created) on the Logical router, etc. +Typically, it could be applied to Tier1 LogicalRouter. It can be +attached to Tier0 LogicalRouter either in non-multi-tenant +environments or to provide load balancing for infrastructure +services offered by the provider.
    • +
  • enabled (bool or None) – whether the load balancer service is enabled
    • +
  • error_log_level (str or None) –

    Possible values are:

    + +

    Load balancer engine writes information about encountered issues of +different severity levels to the error log. This setting is used to +define the severity level of the error log.

    +
    • +
  • size (str or None) –

    Possible values are:

    + +
    +
    the size of load balancer service
    +
    • +
  • virtual_server_ids (list of str or None) – virtual servers can be associated to LbService(which is similar to +physical/virtual load balancer), Lb virtual servers, pools and +other entities could be defined independently, the virtual server +identifier list here would be used to maintain the relationship of +LbService and other Lb entities.
    • +
+
+
+
+ERROR_LOG_LEVEL_ALERT = 'ALERT'
+
+ +
+
+ERROR_LOG_LEVEL_CRITICAL = 'CRITICAL'
+
+ +
+
+ERROR_LOG_LEVEL_DEBUG = 'DEBUG'
+
+ +
+
+ERROR_LOG_LEVEL_EMERGENCY = 'EMERGENCY'
+
+ +
+
+ERROR_LOG_LEVEL_ERROR = 'ERROR'
+
+ +
+
+ERROR_LOG_LEVEL_INFO = 'INFO'
+
+ +
+
+ERROR_LOG_LEVEL_WARNING = 'WARNING'
+
+ +
+
+SIZE_LARGE = 'LARGE'
+
+ +
+
+SIZE_MEDIUM = 'MEDIUM'
+
+ +
+
+SIZE_SMALL = 'SMALL'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LbServiceDebugInfo(application_profiles=None, client_ssl_profiles=None, monitors=None, persistence_profiles=None, pools=None, rules=None, server_ssl_profiles=None, service=None, tcp_profiles=None, virtual_servers=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The information for a given load balancer service could be used for +debugging and troubleshooting. It includes load balancer service, +associated virtual servers, associated pools, associated profiles such as +persistence, SSL, application, associated monitors and associated rules.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • application_profiles (list of vmware.vapi.struct.VapiStruct or None) – The application profiles are associated to virtual servers +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +LbAppProfile. When methods return a value of this class as +a return value, the attribute will contain all the attributes +defined in LbAppProfile. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • client_ssl_profiles (list of LbClientSslProfile or None) – The client SSL profiles are associated to virtual servers +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • monitors (list of vmware.vapi.struct.VapiStruct or None) – The load balancer monitors are associated to pools. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +LbMonitor. When methods return a value of this class as a +return value, the attribute will contain all the attributes defined +in LbMonitor. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • persistence_profiles (list of vmware.vapi.struct.VapiStruct or None) – The persistence profiles are associated to virtual servers +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +LbPersistenceProfile. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in LbPersistenceProfile. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • pools (list of LbPool or None) – The pools which are associated to the given load balancer service +would be included. The pools could be defined in virtual server +default pool, sorry pool or load balancer rule action. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • rules (list of LbRule or None) – The load balancer rules are associated to virtual servers +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • server_ssl_profiles (list of LbServerSslProfile or None) – The server SSL profiles are associated to virtual servers +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • service (LbService or None) – Load balancer service setting for a given load balancer service +identifier.
    • +
  • tcp_profiles (list of LbTcpProfile or None) – The TCP profiles are associated to virtual servers +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • virtual_servers (list of LbVirtualServer or None) – The virtual servers which are associated to the given load balancer +service would be included. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LbServiceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of LbService) – paginated list of load balancer services
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LbServiceStatistics(last_update_timestamp=None, pools=None, service_id=None, statistics=None, virtual_servers=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • last_update_timestamp (long or None) – Timestamp when the data was last updated format: int64
    • +
  • pools (list of LbPoolStatistics or None) – Statistics of load balancer pools
    • +
  • service_id (str) – load balancer service identifier
    • +
  • statistics (LbServiceStatisticsCounter or None) – Load balancer service statistics counter
    • +
  • virtual_servers (list of LbVirtualServerStatistics or None) – Statistics of load balancer virtual servers
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LbServiceStatisticsCounter(l4_current_session_rate=None, l4_current_sessions=None, l4_max_sessions=None, l4_total_sessions=None, l7_current_session_rate=None, l7_current_sessions=None, l7_max_sessions=None, l7_total_sessions=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • l4_current_session_rate (float or None) – The average number of l4 current sessions per second, the number is +averaged over the last 5 one-second intervals.
    • +
  • l4_current_sessions (long or None) – Number of l4 current sessions format: int64
    • +
  • l4_max_sessions (long or None) – L4 max sessions is used to show the peak L4 max session data since +load balancer starts to provide service. format: int64
    • +
  • l4_total_sessions (long or None) – Number of l4 total sessions format: int64
    • +
  • l7_current_session_rate (float or None) – The average number of l7 current requests per second, the number is +averaged over the last 5 one-second intervals.
    • +
  • l7_current_sessions (long or None) – Number of l7 current sessions format: int64
    • +
  • l7_max_sessions (long or None) – L7 max sessions is used to show the peak L7 max session data since +load balancer starts to provide service. format: int64
    • +
  • l7_total_sessions (long or None) – Number of l7 total sessions format: int64
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LbServiceStatus(active_transport_nodes=None, cpu_usage=None, error_message=None, last_update_timestamp=None, memory_usage=None, pools=None, service_id=None, service_status=None, standby_transport_nodes=None, virtual_servers=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • active_transport_nodes (list of str or None) – Ids of load balancer service related active transport nodes
    • +
  • cpu_usage (long or None) – Cpu usage in percentage format: int64
    • +
  • error_message (str or None) – Error message, if available
    • +
  • last_update_timestamp (long or None) – Timestamp when the data was last updated format: int64
    • +
  • memory_usage (long or None) – Memory usage in percentage format: int64
    • +
  • pools (list of LbPoolStatus or None) – status of load balancer pools
    • +
  • service_id (str) – Load balancer service identifier
    • +
  • service_status (str or None) –

    Possible values are:

    + +

    UP means the load balancer service is working fine on both +transport-nodes(if have); DOWN means the load balancer service is +down on both transport-nodes (if have), hence the load balancer +will not respond to any requests; ERROR means error happens on +transport-node(s) or no status is reported from transport-node(s). +The load balancer service may be working (or not working); +NO_STANDBY means load balancer service is working in one of the +transport node while not in the other transport-node (if have). +Hence if the load balancer service in the working transport-node +goes down, the load balancer service will go down; DETACHED means +that the load balancer service has no attachment setting and is not +instantiated in any transport nodes; DISABLED means that admin +state of load balancer service is DISABLED; UNKNOWN means that no +status reported from transport-nodes.The load balancer service may +be working(or not working).

    +
    • +
  • standby_transport_nodes (list of str or None) – Ids of load balancer service related standby transport nodes
    • +
  • virtual_servers (list of LbVirtualServerStatus or None) – status of load balancer virtual servers
    • +
+
+
+
+SERVICE_STATUS_DETACHED = 'DETACHED'
+
+ +
+
+SERVICE_STATUS_DISABLED = 'DISABLED'
+
+ +
+
+SERVICE_STATUS_DOWN = 'DOWN'
+
+ +
+
+SERVICE_STATUS_ERROR = 'ERROR'
+
+ +
+
+SERVICE_STATUS_NO_STANDBY = 'NO_STANDBY'
+
+ +
+
+SERVICE_STATUS_UNKNOWN = 'UNKNOWN'
+
+ +
+
+SERVICE_STATUS_UP = 'UP'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LbServiceUsage(current_pool_count=None, current_pool_member_count=None, current_virtual_server_count=None, pool_capacity=None, pool_member_capacity=None, service_id=None, service_size=None, virtual_server_capacity=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Describes the capacity and current usage of virtual servers, pools and pool +members for the given load balancer service.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • current_pool_count (long or None) – The current number of pools which has been configured in the given +load balancer service. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • current_pool_member_count (long or None) – The current number of pool members which has been configured in the +given load balancer service. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • current_virtual_server_count (long or None) – The current number of virtual servers which has been configured in +the given load balancer service. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • pool_capacity (long or None) – Pool capacity means maximum number of pools which could be +configured in the given load balancer service. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • pool_member_capacity (long or None) – Pool member capacity means maximum number of pool members which +could be configured in the given load balancer service. format: +int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • service_id (str or None) – UUID of load balancer service +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • service_size (str or None) –

    Possible values are:

    + +
    +
    The size of load balancer service
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • virtual_server_capacity (long or None) – Virtual server capacity means maximum number of virtual servers +which could be configured in the given load balancer service. +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+
+SERVICE_SIZE_LARGE = 'LARGE'
+
+ +
+
+SERVICE_SIZE_MEDIUM = 'MEDIUM'
+
+ +
+
+SERVICE_SIZE_SMALL = 'SMALL'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LbSessionCookieTime(cookie_max_idle=None, cookie_max_life=None, type='LbSessionCookieTime')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • cookie_max_idle (long or None) – Instead of using HTTP Cookie max-age and relying on client to +expire the cookie, max idle time and/or max lifetime of the cookie +can be used. Max idle time, if configured, specifies the maximum +interval the cookie is valid for from the last time it was seen in +a request. It is available for insert mode. format: int64
    • +
  • cookie_max_life (long or None) – Max life time, if configured, specifies the maximum interval the +cookie is valid for from the first time the cookie was seen in a +request. It is available for insert mode. format: int64
    • +
  • type (str) –

    Possible values are:

    + +

    Both session cookie and persistence cookie are supported, Use +LbSessionCookieTime for session cookie time setting, Use +LbPersistenceCookieTime for persistence cookie time setting

    +
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LbSnatAutoMap(port_overload=None, type='LbSnatAutoMap')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • port_overload (long or None) – Both SNAT automap and SNAT IP list modes support port overloading +which allows the same SNAT IP and port to be used for multiple +backend connections as long as the tuple (source IP, source port, +destination IP, destination port, IP protocol) after SNAT is +performed is unique. The valid number is 1, 2, 4, 8, 16, 32. +format: int64
    • +
  • type (str) –

    Possible values are:

    + +

    Load balancers may need to perform SNAT to ensure reverse traffic +from the server can be received and processed by them. There are +two modes: LbSnatAutoMap uses the load balancer interface IP and an +ephemeral port as the source IP and port of the server side +connection. LbSnatIpPool allows user to specify one or more IP +addresses along with their subnet masks that should be used for +SNAT while connecting to any of the servers in the pool.

    +
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LbSnatIpElement(ip_address=None, prefix_length=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • ip_address (str) – Ip address or ip range such as 1.1.1.1 or 1.1.1.101-1.1.1.160 +format: address-or-block-or-range
    • +
  • prefix_length (long or None) – Subnet prefix length should be not specified if there is only one +single IP address or IP range. format: int64
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LbSnatIpPool(ip_addresses=None, port_overload=None, type='LbSnatIpPool')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • ip_addresses (list of LbSnatIpElement) – If an IP range is specified, the range may contain no more than 64 +IP addresses.
    • +
  • port_overload (long or None) – Both SNAT automap and SNAT IP list modes support port overloading +which allows the same SNAT IP and port to be used for multiple +backend connections as long as the tuple (source IP, source port, +destination IP, destination port, IP protocol) after SNAT is +performed is unique. The valid number is 1, 2, 4, 8, 16, 32. +format: int64
    • +
  • type (str) –

    Possible values are:

    + +

    Load balancers may need to perform SNAT to ensure reverse traffic +from the server can be received and processed by them. There are +two modes: LbSnatAutoMap uses the load balancer interface IP and an +ephemeral port as the source IP and port of the server side +connection. LbSnatIpPool allows user to specify one or more IP +addresses along with their subnet masks that should be used for +SNAT while connecting to any of the servers in the pool.

    +
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LbSnatTranslation(port_overload=None, type='LbSnatTranslation')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • port_overload (long or None) – Both SNAT automap and SNAT IP list modes support port overloading +which allows the same SNAT IP and port to be used for multiple +backend connections as long as the tuple (source IP, source port, +destination IP, destination port, IP protocol) after SNAT is +performed is unique. The valid number is 1, 2, 4, 8, 16, 32. +format: int64
    • +
  • type (str) –

    Possible values are:

    + +

    Load balancers may need to perform SNAT to ensure reverse traffic +from the server can be received and processed by them. There are +two modes: LbSnatAutoMap uses the load balancer interface IP and an +ephemeral port as the source IP and port of the server side +connection. LbSnatIpPool allows user to specify one or more IP +addresses along with their subnet masks that should be used for +SNAT while connecting to any of the servers in the pool.

    +
    • +
+
+
+
+TYPE_LBSNATAUTOMAP = 'LbSnatAutoMap'
+
+ +
+
+TYPE_LBSNATIPPOOL = 'LbSnatIpPool'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LbSourceIpPersistenceProfile(ha_persistence_mirroring_enabled=None, purge=None, timeout=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LbSourceIpPersistenceProfile', tags=None, persistence_shared=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • ha_persistence_mirroring_enabled (bool or None) – Persistence entries are not synchronized to the HA peer by default.
    • +
  • purge (str or None) –

    Possible values are:

    + +
    +
    persistence purge setting
    +
    • +
  • timeout (long or None) – When all connections complete (reference count reaches 0), +persistence entry timer is started with the expiration time. +format: int64
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +

    Source-ip persistence ensures all connections from a client +(identified by IP address) are sent to the same backend server for +a specified period. Cookie persistence allows related client +connections, identified by the same cookie in HTTP requests, to be +redirected to the same server.

    +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • persistence_shared (bool or None) – If persistence shared flag is not set in the cookie persistence +profile bound to a virtual server, it defaults to cookie +persistence that is private to each virtual server and is qualified +by the pool. This is accomplished by load balancer inserting a +cookie with name in the format +<name>.<virtual_server_id>.<pool_id>. If persistence shared flag is +set in the cookie persistence profile, in cookie insert mode, +cookie persistence could be shared across multiple virtual servers +that are bound to the same pools. The cookie name would be changed +to <name>.<profile-id>.<pool-id>. If persistence shared flag is not +set in the sourceIp persistence profile bound to a virtual server, +each virtual server that the profile is bound to maintains its own +private persistence table. If persistence shared flag is set in the +sourceIp persistence profile, all virtual servers the profile is +bound to share the same persistence table.
    • +
+
+
+
+PURGE_FULL = 'FULL'
+
+ +
+
+PURGE_NO_PURGE = 'NO_PURGE'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LbSslCipherAndProtocolListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, ciphers=None, protocols=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • ciphers (list of LbSslCipherInfo) – List of SSL ciphers
    • +
  • protocols (list of LbSslProtocolInfo) – List of SSL protocols
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LbSslCipherInfo(cipher=None, cipher_group_labels=None, is_default=None, is_secure=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

SSL cipher

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+CIPHER_ECDHE_ECDSA_WITH_AES_128_CBC_SHA = 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA'
+
+ +
+
+CIPHER_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256'
+
+ +
+
+CIPHER_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256'
+
+ +
+
+CIPHER_ECDHE_ECDSA_WITH_AES_256_CBC_SHA = 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA'
+
+ +
+
+CIPHER_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384'
+
+ +
+
+CIPHER_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384'
+
+ +
+
+CIPHER_ECDHE_RSA_WITH_AES_128_CBC_SHA = 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA'
+
+ +
+
+CIPHER_ECDHE_RSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256'
+
+ +
+
+CIPHER_ECDHE_RSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256'
+
+ +
+
+CIPHER_ECDHE_RSA_WITH_AES_256_CBC_SHA = 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA'
+
+ +
+
+CIPHER_ECDHE_RSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384'
+
+ +
+
+CIPHER_ECDHE_RSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384'
+
+ +
+
+CIPHER_ECDH_ECDSA_WITH_AES_128_CBC_SHA = 'TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA'
+
+ +
+
+CIPHER_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256'
+
+ +
+
+CIPHER_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256'
+
+ +
+
+CIPHER_ECDH_ECDSA_WITH_AES_256_CBC_SHA = 'TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA'
+
+ +
+
+CIPHER_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384'
+
+ +
+
+CIPHER_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384'
+
+ +
+
+CIPHER_ECDH_RSA_WITH_AES_128_CBC_SHA = 'TLS_ECDH_RSA_WITH_AES_128_CBC_SHA'
+
+ +
+
+CIPHER_ECDH_RSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256'
+
+ +
+
+CIPHER_ECDH_RSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256'
+
+ +
+
+CIPHER_ECDH_RSA_WITH_AES_256_CBC_SHA = 'TLS_ECDH_RSA_WITH_AES_256_CBC_SHA'
+
+ +
+
+CIPHER_ECDH_RSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384'
+
+ +
+
+CIPHER_ECDH_RSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384'
+
+ +
+
+CIPHER_GROUP_LABELS_BALANCED = 'BALANCED'
+
+ +
+
+CIPHER_GROUP_LABELS_CUSTOM = 'CUSTOM'
+
+ +
+
+CIPHER_GROUP_LABELS_HIGH_COMPATIBILITY = 'HIGH_COMPATIBILITY'
+
+ +
+
+CIPHER_GROUP_LABELS_HIGH_SECURITY = 'HIGH_SECURITY'
+
+ +
+
+CIPHER_RSA_WITH_3DES_EDE_CBC_SHA = 'TLS_RSA_WITH_3DES_EDE_CBC_SHA'
+
+ +
+
+CIPHER_RSA_WITH_AES_128_CBC_SHA = 'TLS_RSA_WITH_AES_128_CBC_SHA'
+
+ +
+
+CIPHER_RSA_WITH_AES_128_CBC_SHA256 = 'TLS_RSA_WITH_AES_128_CBC_SHA256'
+
+ +
+
+CIPHER_RSA_WITH_AES_128_GCM_SHA256 = 'TLS_RSA_WITH_AES_128_GCM_SHA256'
+
+ +
+
+CIPHER_RSA_WITH_AES_256_CBC_SHA = 'TLS_RSA_WITH_AES_256_CBC_SHA'
+
+ +
+
+CIPHER_RSA_WITH_AES_256_CBC_SHA256 = 'TLS_RSA_WITH_AES_256_CBC_SHA256'
+
+ +
+
+CIPHER_RSA_WITH_AES_256_GCM_SHA384 = 'TLS_RSA_WITH_AES_256_GCM_SHA384'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LbSslProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Load balancer abstract SSL profile

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LbSslProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of LbSslProfile) – paginated list of load balancer SSL profiles
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LbSslProtocolInfo(is_default=None, is_secure=None, protocol=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

SSL protocol

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+PROTOCOL_SSL_V2 = 'SSL_V2'
+
+ +
+
+PROTOCOL_SSL_V3 = 'SSL_V3'
+
+ +
+
+PROTOCOL_TLS_V1 = 'TLS_V1'
+
+ +
+
+PROTOCOL_TLS_V1_1 = 'TLS_V1_1'
+
+ +
+
+PROTOCOL_TLS_V1_2 = 'TLS_V1_2'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LbStatisticsCounter(bytes_in=None, bytes_in_rate=None, bytes_out=None, bytes_out_rate=None, current_session_rate=None, current_sessions=None, http_request_rate=None, http_requests=None, max_sessions=None, packets_in=None, packets_in_rate=None, packets_out=None, packets_out_rate=None, source_ip_persistence_entry_size=None, total_sessions=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • bytes_in (long) – Number of bytes in format: int64
    • +
  • bytes_in_rate (float or None) – The average number of inbound bytes per second, the number is +averaged over the last 5 one-second intervals.
    • +
  • bytes_out (long) – Number of bytes out format: int64
    • +
  • bytes_out_rate (float or None) – The average number of outbound bytes per second, the number is +averaged over the last 5 one-second intervals.
    • +
  • current_session_rate (float or None) – The average number of current sessions per second, the number is +averaged over the last 5 one-second intervals.
    • +
  • current_sessions (long) – Number of current sessions format: int64
    • +
  • http_request_rate (float or None) – The average number of http requests per second, the number is +averaged over the last 5 one-second intervals.
    • +
  • http_requests (long or None) – The total number of http requests. format: int64
    • +
  • max_sessions (long) – Number of maximum sessions format: int64
    • +
  • packets_in (long or None) – Number of packets in format: int64
    • +
  • packets_in_rate (float or None) – The average number of inbound packets per second, the number is +averaged over the last 5 one-second intervals.
    • +
  • packets_out (long or None) – Number of packets out format: int64
    • +
  • packets_out_rate (float or None) – The average number of outbound packets per second, the number is +averaged over the last 5 one-second intervals.
    • +
  • source_ip_persistence_entry_size (long or None) – Number of source IP persistence entries format: int64
    • +
  • total_sessions (long) – Number of total sessions format: int64
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LbTcpHeaderCondition(source_port=None, inverse=None, type='LbTcpHeaderCondition')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This condition is used to match TCP header fields of HTTP messages. +Currently, only the TCP source port is supported. Ports can be expressed as +a single port number like 80, or a port range like 1024-1030.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+ +
+
+class com.vmware.nsx.model_client.LbTcpMonitor(receive=None, send=None, fall_count=None, interval=None, monitor_port=None, rise_count=None, timeout=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • receive (str or None) – Expected data, if specified, can be anywhere in the response and it +has to be a string, regular expressions are not supported.
    • +
  • send (str or None) – If both send and receive are not specified, then just a TCP +connection is established (3-way handshake) to validate server is +healthy, no data is sent.
    • +
  • fall_count (long or None) – num of consecutive checks must fail before marking it down format: +int64
    • +
  • interval (long or None) – the frequency at which the system issues the monitor check (in +second) format: int64
    • +
  • monitor_port (str or None) – If the monitor port is specified, it would override pool member +port setting for healthcheck. A port range is not supported. +format: port-or-range
    • +
  • rise_count (long or None) – num of consecutive checks must pass before marking it up format: +int64
    • +
  • timeout (long or None) – the number of seconds the target has in which to respond to the +monitor request format: int64
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +

    Load balancers monitor the health of backend servers to ensure +traffic is not black holed. There are two types of healthchecks: +active and passive. Passive healthchecks depend on failures in +actual client traffic (e.g. RST from server in response to a client +connection) to detect that the server or the application is down. +In case of active healthchecks, load balancer itself initiates new +connections (or sends ICMP ping) to the servers periodically to +check their health, completely independent of any data traffic. +Currently, active health monitors are supported for HTTP, HTTPS, +TCP, UDP and ICMP protocols.

    +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LbTcpProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, fin_wait2_timeout=None, max_syn_retransmissions=None, nagle_algorithm_enabled=None, receive_window_size=None, transmit_window_size=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

TCP profile allows customization of TCP stack behavior for each +application. As TCP connections are terminated (or initiated) on the load +balancer only for L7 virtual servers, TCP profiles are applicable only to +them. As the desired TCP characteristics (e.g. Rx/Tx buffers) may be +different for client (typically on WAN) and server (typically on LAN) +sides, two separate profiles can be bound to virtual server, one for +client-side (LbVirtualServer.client_tcp_profile_id) and another for +server-side (LbVirtualServer.server_tcp_profile_id).

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • fin_wait2_timeout (long or None) – If the field is not specified, the load balancer will use the +default setting per load balancer service flavor. format: int64
    • +
  • max_syn_retransmissions (long or None) – If the field is not specified, the load balancer will use the +default setting per load balancer service flavor. format: int64
    • +
  • nagle_algorithm_enabled (bool or None) – Setting this option to enable or disable Nagle’s algorithm.
    • +
  • receive_window_size (long or None) – If the field is not specified, the load balancer will use the +default setting per load balancer service flavor. format: int64
    • +
  • transmit_window_size (long or None) – If the field is not specified, the load balancer will use the +default setting per load balancer service flavor. format: int64
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LbTcpProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of LbTcpProfile) – Paginated list of load balancer TCP profiles
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LbUdpMonitor(receive=None, send=None, fall_count=None, interval=None, monitor_port=None, rise_count=None, timeout=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • receive (str) – Expected data, can be anywhere in the response and it has to be a +string, regular expressions are not supported. UDP healthcheck is +considered failed if there is no server response within the timeout +period.
    • +
  • send (str) – The data to be sent to the monitored server.
    • +
  • fall_count (long or None) – num of consecutive checks must fail before marking it down format: +int64
    • +
  • interval (long or None) – the frequency at which the system issues the monitor check (in +second) format: int64
    • +
  • monitor_port (str or None) – If the monitor port is specified, it would override pool member +port setting for healthcheck. A port range is not supported. +format: port-or-range
    • +
  • rise_count (long or None) – num of consecutive checks must pass before marking it up format: +int64
    • +
  • timeout (long or None) – the number of seconds the target has in which to respond to the +monitor request format: int64
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +

    Load balancers monitor the health of backend servers to ensure +traffic is not black holed. There are two types of healthchecks: +active and passive. Passive healthchecks depend on failures in +actual client traffic (e.g. RST from server in response to a client +connection) to detect that the server or the application is down. +In case of active healthchecks, load balancer itself initiates new +connections (or sends ICMP ping) to the servers periodically to +check their health, completely independent of any data traffic. +Currently, active health monitors are supported for HTTP, HTTPS, +TCP, UDP and ICMP protocols.

    +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LbVariableAssignmentAction(variable_name=None, variable_value=None, type='LbVariableAssignmentAction')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This action is used to create a new variable and assign value to it. One +action can be used to create one variable. To create multiple variables, +multiple actions must be defined. The variables can be used by +LbVariableCondition, etc.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+ +
+
+class com.vmware.nsx.model_client.LbVariableCondition(case_sensitive=None, match_type=None, variable_name=None, variable_value=None, inverse=None, type='LbVariableCondition')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This condition is used to match variable’s name and value at all phases. +The variables could be captured from REGEX or assigned by +LbVariableAssignmentAction or system embedded variable. Varialbe_name and +variable_value should be matched at the same time.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+MATCH_TYPE_CONTAINS = 'CONTAINS'
+
+ +
+
+MATCH_TYPE_ENDS_WITH = 'ENDS_WITH'
+
+ +
+
+MATCH_TYPE_EQUALS = 'EQUALS'
+
+ +
+
+MATCH_TYPE_REGEX = 'REGEX'
+
+ +
+
+MATCH_TYPE_STARTS_WITH = 'STARTS_WITH'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LbVirtualServer(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, access_log_enabled=None, application_profile_id=None, client_ssl_profile_binding=None, client_tcp_profile_id=None, default_pool_member_port=None, default_pool_member_ports=None, enabled=None, ip_address=None, ip_protocol=None, max_concurrent_connections=None, max_new_connection_rate=None, persistence_profile_id=None, pool_id=None, port=None, ports=None, rule_ids=None, server_ssl_profile_binding=None, server_tcp_profile_id=None, sorry_pool_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • access_log_enabled (bool or None) – Whether access log is enabled
    • +
  • application_profile_id (str) – The application profile defines the application protocol +characteristics. It is used to influence how load balancing is +performed. Currently, LbFastTCPProfile, LbFastUDPProfile and +LbHttpProfile, etc are supported.
    • +
  • client_ssl_profile_binding (ClientSslProfileBinding or None) – The setting is used when load balancer acts as an SSL server and +terminating the client SSL connection
    • +
  • client_tcp_profile_id (str or None) – Only L7 virtual server could be configured with customized client +side TCP profile.
    • +
  • default_pool_member_port (str or None) – This is a deprecated property, please use +‘default_pool_member_ports’ instead. If default_pool_member_port is +configured and default_pool_member_ports are not specified, both +default_pool_member_port and default_pool_member_ports in response +payload would return the same port value. If both are specified, +default_pool_member_ports setting would take effect with higher +priority. format: port-or-range
    • +
  • default_pool_member_ports (list of str or None) – If default_pool_member_ports are configured, both +default_pool_member_port and default_pool_member_ports in the +response payload would include port settings, notice that the value +of default_pool_member_port is the first element of +default_pool_member_ports. format: port-or-range
    • +
  • enabled (bool or None) – whether the virtual server is enabled
    • +
  • ip_address (str) – virtual server IP address format: ip
    • +
  • ip_protocol (str or None) –

    Possible values are:

    + +
    +
    Assigned Internet Protocol in IP header, TCP, UDP are supported.
    +
    • +
  • max_concurrent_connections (long or None) – To ensure one virtual server does not over consume resources, +affecting other applications hosted on the same LBS, connections to +a virtual server can be capped. If it is not specified, it means +that connections are unlimited. format: int64
    • +
  • max_new_connection_rate (long or None) – To ensure one virtual server does not over consume resources, +connections to a member can be rate limited. If it is not +specified, it means that connection rate is unlimited. format: +int64
    • +
  • persistence_profile_id (str or None) – Persistence profile is used to allow related client connections to +be sent to the same backend server.
    • +
  • pool_id (str or None) – The server pool(LbPool) contains backend servers. Server pool +consists of one or more servers, also referred to as pool members, +that are similarly configured and are running the same application.
    • +
  • port (str or None) – This is a deprecated property, please use ‘ports’ instead. Port +setting could be single port for both L7 mode and L4 mode. For L4 +mode, a single port range is also supported. The port setting could +be a single port or port range such as "80", +"1234-1236". If port is configured and ports are not +specified, both port and ports in response payload would return the +same port value. If both port and ports are configured, ports +setting would take effect with higher priority. format: +port-or-range
    • +
  • ports (list of str or None) – Port setting could be a single port for both L7 mode and L4 mode. +For L4 mode, multiple ports or port ranges are also supported such +as "80", "443", "1234-1236". If ports is +configured, both port and ports in the response payload would +include port settings, notice that the port field value is the +first element of ports. format: port-or-range
    • +
  • rule_ids (list of str or None) – Load balancer rules allow customization of load balancing behavior +using match/action rules. Currently, load balancer rules are +supported for only layer 7 virtual servers with LbHttpProfile.
    • +
  • server_ssl_profile_binding (ServerSslProfileBinding or None) – The setting is used when load balancer acts as an SSL client and +establishing a connection to the backend server.
    • +
  • server_tcp_profile_id (str or None) – Only L7 virtual server could be configured with customized server +side TCP profile.
    • +
  • sorry_pool_id (str or None) – When load balancer can not select a backend server to serve the +request in default pool or pool in rules, the request would be +served by sorry server pool.
    • +
+
+
+
+IP_PROTOCOL_TCP = 'TCP'
+
+ +
+
+IP_PROTOCOL_UDP = 'UDP'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LbVirtualServerListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of LbVirtualServer) – paginated list of virtual servers
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LbVirtualServerStatistics(last_update_timestamp=None, statistics=None, virtual_server_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • last_update_timestamp (long or None) – Timestamp when the data was last updated format: int64
    • +
  • statistics (LbStatisticsCounter) – Virtual server statistics counter
    • +
  • virtual_server_id (str) – load balancer virtual server identifier
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LbVirtualServerStatisticsListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of LbVirtualServerStatistics) – paginated statistics list of virtual servers
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LbVirtualServerStatus(last_update_timestamp=None, status=None, virtual_server_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • last_update_timestamp (long or None) – Timestamp when the data was last updated. format: int64
    • +
  • status (str or None) –

    Possible values are:

    + +

    UP means that all primary members in default pool are in UP status. +For L7 virtual server, if there is no default pool, the virtual +server would be treated as UP. PARTIALLY_UP means that some(not +all) primary members in default pool are in UP status. The size of +these active primary members should be larger than or equal to the +certain number(min_active_members) which is defined in LbPool. When +there are no backup members which are in the UP status, the +number(min_active_members) would be ignored. PRIMARY_DOWN means +that less than certain(min_active_members) primary members in +default pool are in UP status but backup members are in UP status, +the connections would be dispatched to backup members. DOWN means +that all primary and backup members are in DOWN status. DETACHED +means that the virtual server is not bound to any service. DISABLED +means that the admin state of the virtual server is disabled. +UNKOWN means that no status reported from transport-nodes. The +associated load balancer service may be working(or not working).

    +
    • +
  • virtual_server_id (str) – load balancer virtual server identifier
    • +
+
+
+
+STATUS_DETACHED = 'DETACHED'
+
+ +
+
+STATUS_DISABLED = 'DISABLED'
+
+ +
+
+STATUS_DOWN = 'DOWN'
+
+ +
+
+STATUS_PARTIALLY_UP = 'PARTIALLY_UP'
+
+ +
+
+STATUS_PRIMARY_DOWN = 'PRIMARY_DOWN'
+
+ +
+
+STATUS_UNKNOWN = 'UNKNOWN'
+
+ +
+
+STATUS_UP = 'UP'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LbVirtualServerStatusListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of LbVirtualServerStatus) – paginated status list of virtual servers
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LbVirtualServerWithRule(rules=None, virtual_server=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • rules (list of LbRule or None) – It is used to add rules, update rules and bind rules to the virtual +server. To add new rules, make sure that the rules have no +identifier specified, the new rules are automatically generated and +associated to the virtual server. If the virtual server need to +consume some existed rules without change, those rules should not +be specified in the list, otherwise, the rules are updated. For +update_with_rules action, it supports rules delete and update. To +delete old rules, the rules should not be configured in new action, +the UUID of deleted rules should be removed from rule_ids. To +update rules, the rules should be specified with new change and +configured with identifier. If there are some rules which are not +modified, those rule should not be specified in the rules list, the +UUID list of rules should be specified in rule_ids of +LbVirtualServer.
    • +
  • virtual_server (LbVirtualServer) – If rules need to be associated to the virtual server, please set +rules properties of LbVirtualServerWithRule with rule list +configuration. For the rules which are not modified but associated +to the virtual server, the rule UUID list should be specified in +rule_ids property of LbVirtualServer and the associated rules +should not be specified in rules of LbVirtualServerWithRule.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.License(links=None, schema=None, self_=None, capacity_type=None, description=None, expiry=None, features=None, is_eval=None, is_expired=None, is_mh=None, license_key=None, product_name=None, product_version=None, quantity=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

license properties

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • capacity_type (str or None) –

    Possible values are:

    + +
    +
    license metric
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • description (str or None) – license edition +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • expiry (long or None) – date that license expires format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • features (str or None) – semicolon delimited feature list +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • is_eval (bool or None) – true for evalution license +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • is_expired (bool or None) – whether the license has expired +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • is_mh (bool or None) – multi-hypervisor support +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • license_key (str or None) – license key
    • +
  • product_name (str or None) – product name +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • product_version (str or None) – product version +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • quantity (long or None) – license capacity; 0 for unlimited format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+
+CAPACITY_TYPE_CPU = 'CPU'
+
+ +
+
+CAPACITY_TYPE_USER = 'USER'
+
+ +
+
+CAPACITY_TYPE_VM = 'VM'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LicensesListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Licenses queries result

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of License or None) – Licenses Results +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Base class for list results from collections

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ListResultQueryParameters(fields=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Parameters that affect how list results are processed

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:fields (str or None) – Comma-separated field names to include in query result
+
+ +
+
+class com.vmware.nsx.model_client.LldpHostSwitchProfile(send_enabled=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LldpHostSwitchProfile', tags=None, required_capabilities=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Host Switch for LLDP

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • send_enabled (bool) – Enabled or disabled sending LLDP packets
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • required_capabilities (list of str or None) –
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LoadBalancerAllocationPool(allocation_size=None, allocation_pool_type='LoadBalancerAllocationPool')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+ALLOCATION_SIZE_LARGE = 'LARGE'
+
+ +
+
+ALLOCATION_SIZE_MEDIUM = 'MEDIUM'
+
+ +
+
+ALLOCATION_SIZE_SMALL = 'SMALL'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LogicalDhcpServer(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, attached_logical_port_id=None, dhcp_profile_id=None, ipv4_dhcp_server=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • attached_logical_port_id (str or None) – id of attached logical port +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • dhcp_profile_id (str) – dhcp profile uuid
    • +
  • ipv4_dhcp_server (IPv4DhcpServer) – dhcp server for ipv4 addresses
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LogicalDhcpServerListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of LogicalDhcpServer) – paginated list of dhcp servers
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LogicalPort(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, address_bindings=None, admin_state=None, attachment=None, extra_configs=None, init_state=None, logical_switch_id=None, switching_profile_ids=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • address_bindings (list of PacketAddressClassifier or None) – Address bindings for logical port
    • +
  • admin_state (str) –

    Possible values are:

    + +
    +
    Represents Desired state of the logical port
    +
    • +
  • attachment (LogicalPortAttachment or None) – Logical port attachment
    • +
  • extra_configs (list of ExtraConfig or None) – This property could be used for vendor specific configuration in +key value string pairs. Logical port setting will override logical +switch setting if the same key was set on both logical switch and +logical port.
    • +
  • init_state (str or None) –

    Possible values are:

    + +

    Set initial state when a new logical port is created. +‘UNBLOCKED_VLAN’ means new port will be unblocked on traffic in +creation, also VLAN will be set with corresponding logical switch +setting.

    +
    • +
  • logical_switch_id (str) – Id of the Logical switch that this port belongs to.
    • +
  • switching_profile_ids (list of SwitchingProfileTypeIdEntry or None) –
    • +
+
+
+
+ADMIN_STATE_DOWN = 'DOWN'
+
+ +
+
+ADMIN_STATE_UP = 'UP'
+
+ +
+
+INIT_STATE_VLAN = 'UNBLOCKED_VLAN'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LogicalPortAttachment(attachment_type=None, context=None, id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Logical port attachment

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+ATTACHMENT_TYPE_BRIDGEENDPOINT = 'BRIDGEENDPOINT'
+
+ +
+
+ATTACHMENT_TYPE_DHCP_SERVICE = 'DHCP_SERVICE'
+
+ +
+
+ATTACHMENT_TYPE_L2VPN_SESSION = 'L2VPN_SESSION'
+
+ +
+
+ATTACHMENT_TYPE_LOGICALROUTER = 'LOGICALROUTER'
+
+ +
+
+ATTACHMENT_TYPE_METADATA_PROXY = 'METADATA_PROXY'
+
+ +
+
+ATTACHMENT_TYPE_VIF = 'VIF'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LogicalPortListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Logical port queries result

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of LogicalPort or None) – LogicalPort Results +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LogicalPortMacAddressCsvListResult(file_name=None, last_update_timestamp=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • file_name (str or None) – File name set by HTTP server if API returns CSV result as a file.
    • +
  • last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has +never updated the data. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of LogicalPortMacTableCsvEntry or None) –
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LogicalPortMacAddressListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, last_update_timestamp=None, logical_port_id=None, results=None, transport_node_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has +never updated the data. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • logical_port_id (str or None) – The id of the logical port +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of LogicalPortMacTableEntry or None) –
    • +
  • transport_node_id (str or None) – Transport node identifier +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LogicalPortMacTableCsvEntry(mac_address=None, mac_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+MAC_TYPE_LEARNED = 'LEARNED'
+
+ +
+
+MAC_TYPE_STATIC = 'STATIC'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LogicalPortMacTableEntry(mac_address=None, mac_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+MAC_TYPE_LEARNED = 'LEARNED'
+
+ +
+
+MAC_TYPE_STATIC = 'STATIC'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LogicalPortMirrorDestination(port_ids=None, resource_type='LogicalPortMirrorDestination')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+ +
+
+class com.vmware.nsx.model_client.LogicalPortMirrorSource(port_ids=None, resource_type='LogicalPortMirrorSource')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+ +
+
+class com.vmware.nsx.model_client.LogicalPortOperationalStatus(last_update_timestamp=None, logical_port_id=None, status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has +never updated the data. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • logical_port_id (str or None) – The id of the logical port +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • status (str) –

    Possible values are:

    + +
    +
    The Operational status of the logical port
    +
    • +
+
+
+
+STATUS_DOWN = 'DOWN'
+
+ +
+
+STATUS_UNKNOWN = 'UNKNOWN'
+
+ +
+
+STATUS_UP = 'UP'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LogicalPortState(discovered_bindings=None, id=None, realized_bindings=None, transport_node_ids=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Contians realized state of the logical port. For example, transport node on +which the port is located, discovered and realized address bindings of the +logical port.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • discovered_bindings (list of AddressBindingEntry or None) – Logical port bindings discovered automatically
    • +
  • id (str) – Id of the logical port
    • +
  • realized_bindings (list of AddressBindingEntry or None) – Realized logical port bindings
    • +
  • transport_node_ids (list of str or None) – Identifiers of the transport node where the port is located
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LogicalPortStatistics(rx_bytes=None, rx_packets=None, tx_bytes=None, tx_packets=None, dropped_by_security_packets=None, mac_learning=None, last_update_timestamp=None, logical_port_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • rx_bytes (DataCounter or None) –
    • +
  • rx_packets (DataCounter or None) –
    • +
  • tx_bytes (DataCounter or None) –
    • +
  • tx_packets (DataCounter or None) –
    • +
  • dropped_by_security_packets (PacketsDroppedBySecurity or None) –
    • +
  • mac_learning (MacLearningCounters or None) –
    • +
  • last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has +never updated the data. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • logical_port_id (str or None) – The id of the logical port +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LogicalPortStatusSummary(filters=None, last_update_timestamp=None, total_ports=None, up_ports=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • filters (list of Filter or None) – The filters used to find the logical ports- TransportZone id, +LogicalSwitch id or LogicalSwitchProfile id
    • +
  • last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has +never updated the data. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • total_ports (long) – The total number of logical ports. format: int64
    • +
  • up_ports (long) – The number of logical ports whose Operational status is UP format: +int64
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LogicalRouter(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, advanced_config=None, allocation_profile=None, edge_cluster_id=None, edge_cluster_member_indices=None, failover_mode=None, firewall_sections=None, high_availability_mode=None, preferred_edge_cluster_member_index=None, router_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • advanced_config (LogicalRouterConfig or None) – Contains config properties for tier0 routers
    • +
  • allocation_profile (EdgeClusterMemberAllocationProfile or None) – Configurations options to auto allocate edge cluster members for +logical router. Auto allocation is supported only for TIER1 and +pick least utilized member post current assignment for next +allocation.
    • +
  • edge_cluster_id (str or None) – Used for tier0 routers
    • +
  • edge_cluster_member_indices (list of long or None) – For stateful services, the logical router should be associated with +edge cluster. For TIER 1 logical router, for manual placement of +service router within the cluster, edge cluster member indices +needs to be provided else same will be auto-allocated. You can +provide maximum two indices for HA ACTIVE_STANDBY. For TIER0 +logical router this property is no use and placement is derived +from logical router uplink or loopback port. format: int64
    • +
  • failover_mode (str or None) –

    Possible values are:

    + +

    Determines the behavior when a logical router instance restarts +after a failure. If set to PREEMPTIVE, the preferred node will take +over, even if it causes another failure. If set to NON_PREEMPTIVE, +then the instance that restarted will remain secondary. This +property must not be populated unless the high_availability_mode +property is set to ACTIVE_STANDBY. If high_availability_mode +property is set to ACTIVE_STANDBY and this property is not +specified then default will be NON_PREEMPTIVE.

    +
    • +
  • firewall_sections (list of ResourceReference or None) – List of Firewall sections related to Logical Router. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • high_availability_mode (str or None) –

    Possible values are:

    + +
    +
    High availability mode
    +
    • +
  • preferred_edge_cluster_member_index (long or None) – Used for tier0 routers only format: int64
    • +
  • router_type (str) –

    Possible values are:

    + +
    +
    Type of Logical Router
    +
    • +
+
+
+
+FAILOVER_MODE_NON_PREEMPTIVE = 'NON_PREEMPTIVE'
+
+ +
+
+FAILOVER_MODE_PREEMPTIVE = 'PREEMPTIVE'
+
+ +
+
+HIGH_AVAILABILITY_MODE_ACTIVE = 'ACTIVE_ACTIVE'
+
+ +
+
+HIGH_AVAILABILITY_MODE_STANDBY = 'ACTIVE_STANDBY'
+
+ +
+
+ROUTER_TYPE_TIER0 = 'TIER0'
+
+ +
+
+ROUTER_TYPE_TIER1 = 'TIER1'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LogicalRouterCentralizedServicePort(enable_netx=None, linked_logical_switch_port_id=None, subnets=None, urpf_mode=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LogicalRouterCentralizedServicePort', tags=None, logical_router_id=None, service_bindings=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This port can be configured on both TIER0 and TIER1 logical router. Port +can be connected to VLAN or overlay logical switch. Unlike downlink port it +does not participate in distributed routing and hosted on all edge cluster +members associated with logical router. Stateful services can be applied on +this port.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • enable_netx (bool or None) – Port is exclusively used for N-S service insertion
    • +
  • linked_logical_switch_port_id (ResourceReference or None) – Reference to the logical switch port to connect to
    • +
  • subnets (list of IPSubnet) – Logical router port subnets
    • +
  • urpf_mode (str or None) –

    Possible values are:

    + +
    +
    Unicast Reverse Path Forwarding mode
    +
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +

    LogicalRouterUpLinkPort is allowed only on TIER0 logical router. It +is the north facing port of the logical router. +LogicalRouterLinkPortOnTIER0 is allowed only on TIER0 logical +router. This is the port where the LogicalRouterLinkPortOnTIER1 of +TIER1 logical router connects to. LogicalRouterLinkPortOnTIER1 is +allowed only on TIER1 logical router. This is the port using which +the user connected to TIER1 logical router for upwards connectivity +via TIER0 logical router. Connect this port to the +LogicalRouterLinkPortOnTIER0 of the TIER0 logical router. +LogicalRouterDownLinkPort is for the connected subnets on the +logical router. LogicalRouterLoopbackPort is a loopback port for +logical router component which is placed on chosen edge cluster +member. LogicalRouterIPTunnelPort is a IPSec VPN tunnel port +created on logical router when route based VPN session configured. +LogicalRouterCentralizedServicePort is allowed only on +Active/Standby TIER0 and TIER1 logical router. Port can be +connected to VLAN or overlay logical switch. Unlike downlink port +it does not participate in distributed routing and hosted on all +edge cluster members associated with logical router. Stateful +services can be applied on this port.

    +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • logical_router_id (str) – Identifier for logical router on which this port is created
    • +
  • service_bindings (list of ServiceBinding or None) – Service Bindings
    • +
+
+
+
+URPF_MODE_NONE = 'NONE'
+
+ +
+
+URPF_MODE_STRICT = 'STRICT'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LogicalRouterConfig(external_transit_networks=None, ha_vip_configs=None, internal_transit_network=None, transport_zone_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • external_transit_networks (list of str or None) – CIDR block defining tier0 to tier1 links format: ipv4-cidr-block
    • +
  • ha_vip_configs (list of HaVipConfig or None) – This configuration can be defined only for Active-Standby +LogicalRouter to provide | redundancy. For mulitple uplink ports, +multiple HaVipConfigs must be defined | and each config will pair +exactly two uplink ports. The VIP will move and will | always be +owned by the Active node. Note - when HaVipConfig[s] are defined, | +configuring dynamic-routing is disallowed.
    • +
  • internal_transit_network (str or None) – CIDR block defining Service router to distributed router links +format: ipv4-cidr-block
    • +
  • transport_zone_id (str or None) – Transport zone of the logical router. If specified then all +downlink switches should belong to this transport zone and an error +will be thrown if transport zone of the downlink switch doesn’t +match with this transport zone. All internal and external transit +switches will be created in this transport zone.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LogicalRouterDownLinkPort(linked_logical_switch_port_id=None, mac_address=None, subnets=None, urpf_mode=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LogicalRouterDownLinkPort', tags=None, logical_router_id=None, service_bindings=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • linked_logical_switch_port_id (ResourceReference or None) – Reference to the logical switch port to connect to
    • +
  • mac_address (str or None) – MAC address +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • subnets (list of IPSubnet) – Logical router port subnets
    • +
  • urpf_mode (str or None) –

    Possible values are:

    + +
    +
    Unicast Reverse Path Forwarding mode
    +
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +

    LogicalRouterUpLinkPort is allowed only on TIER0 logical router. It +is the north facing port of the logical router. +LogicalRouterLinkPortOnTIER0 is allowed only on TIER0 logical +router. This is the port where the LogicalRouterLinkPortOnTIER1 of +TIER1 logical router connects to. LogicalRouterLinkPortOnTIER1 is +allowed only on TIER1 logical router. This is the port using which +the user connected to TIER1 logical router for upwards connectivity +via TIER0 logical router. Connect this port to the +LogicalRouterLinkPortOnTIER0 of the TIER0 logical router. +LogicalRouterDownLinkPort is for the connected subnets on the +logical router. LogicalRouterLoopbackPort is a loopback port for +logical router component which is placed on chosen edge cluster +member. LogicalRouterIPTunnelPort is a IPSec VPN tunnel port +created on logical router when route based VPN session configured. +LogicalRouterCentralizedServicePort is allowed only on +Active/Standby TIER0 and TIER1 logical router. Port can be +connected to VLAN or overlay logical switch. Unlike downlink port +it does not participate in distributed routing and hosted on all +edge cluster members associated with logical router. Stateful +services can be applied on this port.

    +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • logical_router_id (str) – Identifier for logical router on which this port is created
    • +
  • service_bindings (list of ServiceBinding or None) – Service Bindings
    • +
+
+
+
+URPF_MODE_NONE = 'NONE'
+
+ +
+
+URPF_MODE_STRICT = 'STRICT'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LogicalRouterIPTunnelPort(admin_state=None, subnets=None, vpn_session_id=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LogicalRouterIPTunnelPort', tags=None, logical_router_id=None, service_bindings=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Logical router IP tunnel port.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • admin_state (str or None) –

    Possible values are:

    + +
    +
    Admin state of port.
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • subnets (list of IPSubnet or None) – Tunnel port subnets. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • vpn_session_id (str or None) – Associated VPN session identifier. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +

    LogicalRouterUpLinkPort is allowed only on TIER0 logical router. It +is the north facing port of the logical router. +LogicalRouterLinkPortOnTIER0 is allowed only on TIER0 logical +router. This is the port where the LogicalRouterLinkPortOnTIER1 of +TIER1 logical router connects to. LogicalRouterLinkPortOnTIER1 is +allowed only on TIER1 logical router. This is the port using which +the user connected to TIER1 logical router for upwards connectivity +via TIER0 logical router. Connect this port to the +LogicalRouterLinkPortOnTIER0 of the TIER0 logical router. +LogicalRouterDownLinkPort is for the connected subnets on the +logical router. LogicalRouterLoopbackPort is a loopback port for +logical router component which is placed on chosen edge cluster +member. LogicalRouterIPTunnelPort is a IPSec VPN tunnel port +created on logical router when route based VPN session configured. +LogicalRouterCentralizedServicePort is allowed only on +Active/Standby TIER0 and TIER1 logical router. Port can be +connected to VLAN or overlay logical switch. Unlike downlink port +it does not participate in distributed routing and hosted on all +edge cluster members associated with logical router. Stateful +services can be applied on this port.

    +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • logical_router_id (str) – Identifier for logical router on which this port is created
    • +
  • service_bindings (list of ServiceBinding or None) – Service Bindings
    • +
+
+
+
+ADMIN_STATE_DOWN = 'DOWN'
+
+ +
+
+ADMIN_STATE_UP = 'UP'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LogicalRouterLinkPortOnTIER0(linked_logical_router_port_id=None, mac_address=None, subnets=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LogicalRouterLinkPortOnTIER0', tags=None, logical_router_id=None, service_bindings=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This port can be configured only on a TIER0 LogicalRouter. Create an empty +port to generate an id. Use this id in the linked_logical_router_port_id on +LogicalRouterLinkPortOnTIER1 on TIER1 logical router.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • linked_logical_router_port_id (str or None) – Identifier of connected LogicalRouterLinkPortOnTIER1 of TIER1 +logical router +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • mac_address (str or None) – MAC address +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • subnets (list of IPSubnet or None) – Logical router port subnets +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +

    LogicalRouterUpLinkPort is allowed only on TIER0 logical router. It +is the north facing port of the logical router. +LogicalRouterLinkPortOnTIER0 is allowed only on TIER0 logical +router. This is the port where the LogicalRouterLinkPortOnTIER1 of +TIER1 logical router connects to. LogicalRouterLinkPortOnTIER1 is +allowed only on TIER1 logical router. This is the port using which +the user connected to TIER1 logical router for upwards connectivity +via TIER0 logical router. Connect this port to the +LogicalRouterLinkPortOnTIER0 of the TIER0 logical router. +LogicalRouterDownLinkPort is for the connected subnets on the +logical router. LogicalRouterLoopbackPort is a loopback port for +logical router component which is placed on chosen edge cluster +member. LogicalRouterIPTunnelPort is a IPSec VPN tunnel port +created on logical router when route based VPN session configured. +LogicalRouterCentralizedServicePort is allowed only on +Active/Standby TIER0 and TIER1 logical router. Port can be +connected to VLAN or overlay logical switch. Unlike downlink port +it does not participate in distributed routing and hosted on all +edge cluster members associated with logical router. Stateful +services can be applied on this port.

    +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • logical_router_id (str) – Identifier for logical router on which this port is created
    • +
  • service_bindings (list of ServiceBinding or None) – Service Bindings
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LogicalRouterLinkPortOnTIER1(edge_cluster_member_index=None, linked_logical_router_port_id=None, mac_address=None, subnets=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LogicalRouterLinkPortOnTIER1', tags=None, logical_router_id=None, service_bindings=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This port can be configured only on a TIER1 LogicalRouter. Use the id of +the LogicalRouterLinkPortOnTIER0 from TIER0 logical router to set the +linked_logical_router_port_id on the port on TIER1 logical router.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • edge_cluster_member_index (list of long or None) – Please use logical router API to pass edge cluster members indexes +manually. format: int64
    • +
  • linked_logical_router_port_id (ResourceReference or None) – Reference of LogicalRouterLinkPortOnTIER0 of TIER0 logical router +to connect this TIER1 logical router outwards.
    • +
  • mac_address (str or None) – MAC address +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • subnets (list of IPSubnet or None) – Logical router port subnets +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +

    LogicalRouterUpLinkPort is allowed only on TIER0 logical router. It +is the north facing port of the logical router. +LogicalRouterLinkPortOnTIER0 is allowed only on TIER0 logical +router. This is the port where the LogicalRouterLinkPortOnTIER1 of +TIER1 logical router connects to. LogicalRouterLinkPortOnTIER1 is +allowed only on TIER1 logical router. This is the port using which +the user connected to TIER1 logical router for upwards connectivity +via TIER0 logical router. Connect this port to the +LogicalRouterLinkPortOnTIER0 of the TIER0 logical router. +LogicalRouterDownLinkPort is for the connected subnets on the +logical router. LogicalRouterLoopbackPort is a loopback port for +logical router component which is placed on chosen edge cluster +member. LogicalRouterIPTunnelPort is a IPSec VPN tunnel port +created on logical router when route based VPN session configured. +LogicalRouterCentralizedServicePort is allowed only on +Active/Standby TIER0 and TIER1 logical router. Port can be +connected to VLAN or overlay logical switch. Unlike downlink port +it does not participate in distributed routing and hosted on all +edge cluster members associated with logical router. Stateful +services can be applied on this port.

    +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • logical_router_id (str) – Identifier for logical router on which this port is created
    • +
  • service_bindings (list of ServiceBinding or None) – Service Bindings
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LogicalRouterListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of LogicalRouter) – Logical router list results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LogicalRouterLoopbackPort(edge_cluster_member_index=None, subnets=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LogicalRouterLoopbackPort', tags=None, logical_router_id=None, service_bindings=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • edge_cluster_member_index (list of long) – Member index of the edge node on the cluster format: int64
    • +
  • subnets (list of IPSubnet) – Loopback port subnets
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +

    LogicalRouterUpLinkPort is allowed only on TIER0 logical router. It +is the north facing port of the logical router. +LogicalRouterLinkPortOnTIER0 is allowed only on TIER0 logical +router. This is the port where the LogicalRouterLinkPortOnTIER1 of +TIER1 logical router connects to. LogicalRouterLinkPortOnTIER1 is +allowed only on TIER1 logical router. This is the port using which +the user connected to TIER1 logical router for upwards connectivity +via TIER0 logical router. Connect this port to the +LogicalRouterLinkPortOnTIER0 of the TIER0 logical router. +LogicalRouterDownLinkPort is for the connected subnets on the +logical router. LogicalRouterLoopbackPort is a loopback port for +logical router component which is placed on chosen edge cluster +member. LogicalRouterIPTunnelPort is a IPSec VPN tunnel port +created on logical router when route based VPN session configured. +LogicalRouterCentralizedServicePort is allowed only on +Active/Standby TIER0 and TIER1 logical router. Port can be +connected to VLAN or overlay logical switch. Unlike downlink port +it does not participate in distributed routing and hosted on all +edge cluster members associated with logical router. Stateful +services can be applied on this port.

    +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • logical_router_id (str) – Identifier for logical router on which this port is created
    • +
  • service_bindings (list of ServiceBinding or None) – Service Bindings
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LogicalRouterPort(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LogicalRouterPort', tags=None, logical_router_id=None, service_bindings=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +

    LogicalRouterUpLinkPort is allowed only on TIER0 logical router. It +is the north facing port of the logical router. +LogicalRouterLinkPortOnTIER0 is allowed only on TIER0 logical +router. This is the port where the LogicalRouterLinkPortOnTIER1 of +TIER1 logical router connects to. LogicalRouterLinkPortOnTIER1 is +allowed only on TIER1 logical router. This is the port using which +the user connected to TIER1 logical router for upwards connectivity +via TIER0 logical router. Connect this port to the +LogicalRouterLinkPortOnTIER0 of the TIER0 logical router. +LogicalRouterDownLinkPort is for the connected subnets on the +logical router. LogicalRouterLoopbackPort is a loopback port for +logical router component which is placed on chosen edge cluster +member. LogicalRouterIPTunnelPort is a IPSec VPN tunnel port +created on logical router when route based VPN session configured. +LogicalRouterCentralizedServicePort is allowed only on +Active/Standby TIER0 and TIER1 logical router. Port can be +connected to VLAN or overlay logical switch. Unlike downlink port +it does not participate in distributed routing and hosted on all +edge cluster members associated with logical router. Stateful +services can be applied on this port.

    +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • logical_router_id (str) – Identifier for logical router on which this port is created
    • +
  • service_bindings (list of ServiceBinding or None) – Service Bindings
    • +
+
+
+
+RESOURCE_TYPE_LOGICALROUTERCENTRALIZEDSERVICEPORT = 'LogicalRouterCentralizedServicePort'
+
+ +
+
+RESOURCE_TYPE_LOGICALROUTERDOWNLINKPORT = 'LogicalRouterDownLinkPort'
+
+ +
+
+RESOURCE_TYPE_LOGICALROUTERIPTUNNELPORT = 'LogicalRouterIPTunnelPort'
+
+ +
+
+RESOURCE_TYPE_LOGICALROUTERLINKPORTONTIER0 = 'LogicalRouterLinkPortOnTIER0'
+
+ +
+
+RESOURCE_TYPE_LOGICALROUTERLINKPORTONTIER1 = 'LogicalRouterLinkPortOnTIER1'
+
+ +
+
+RESOURCE_TYPE_LOGICALROUTERLOOPBACKPORT = 'LogicalRouterLoopbackPort'
+
+ +
+
+RESOURCE_TYPE_LOGICALROUTERUPLINKPORT = 'LogicalRouterUpLinkPort'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LogicalRouterPortArpCsvRecord(ip=None, mac_address=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • ip (str) – The IP address format: ip
    • +
  • mac_address (str) – The MAC address
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LogicalRouterPortArpEntry(ip=None, mac_address=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • ip (str) – The IP address format: ip
    • +
  • mac_address (str) – The MAC address
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LogicalRouterPortArpTable(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, last_update_timestamp=None, logical_router_port_id=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has +never updated the data. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • logical_router_port_id (str) – The ID of the logical router port
    • +
  • results (list of LogicalRouterPortArpEntry or None) –
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LogicalRouterPortArpTableInCsvFormat(file_name=None, last_update_timestamp=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • file_name (str or None) – File name set by HTTP server if API returns CSV result as a file.
    • +
  • last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has +never updated the data. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of LogicalRouterPortArpCsvRecord or None) –
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LogicalRouterPortCounters(dropped_packets=None, total_bytes=None, total_packets=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • dropped_packets (long or None) – The number of dropped packets format: int64
    • +
  • total_bytes (long or None) – The total number of bytes format: int64
    • +
  • total_packets (long or None) – The total number of packets format: int64
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LogicalRouterPortListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of vmware.vapi.struct.VapiStruct) – Logical router port list results +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +LogicalRouterPort. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in LogicalRouterPort.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LogicalRouterPortStatistics(logical_router_port_id=None, per_node_statistics=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • logical_router_port_id (str) – The ID of the logical router port
    • +
  • per_node_statistics (list of LogicalRouterPortStatisticsPerNode or None) – Per Node Statistics +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LogicalRouterPortStatisticsPerNode(last_update_timestamp=None, rx=None, tx=None, transport_node_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has +never updated the data. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • rx (LogicalRouterPortCounters or None) –
    • +
  • tx (LogicalRouterPortCounters or None) –
    • +
  • transport_node_id (str or None) – The ID of the TransportNode +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LogicalRouterPortStatisticsSummary(last_update_timestamp=None, rx=None, tx=None, logical_router_port_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has +never updated the data. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • rx (LogicalRouterPortCounters or None) –
    • +
  • tx (LogicalRouterPortCounters or None) –
    • +
  • logical_router_port_id (str) – The ID of the logical router port
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LogicalRouterRouteCsvRecord(admin_distance=None, logical_router_port_id=None, lr_component_id=None, lr_component_type=None, network=None, next_hop=None, route_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • admin_distance (long or None) – The admin distance of the next hop format: int64
    • +
  • logical_router_port_id (str or None) – The id of the logical router port which is used as the next hop
    • +
  • lr_component_id (str or None) – Logical router component(Service Router/Distributed Router) id
    • +
  • lr_component_type (str or None) – Logical router component(Service Router/Distributed Router) type
    • +
  • network (str) – CIDR network address format: ipv4-cidr-block
    • +
  • next_hop (str or None) – The IP of the next hop format: ip
    • +
  • route_type (str) – Route type (USER, CONNECTED, NSX_INTERNAL,..)
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LogicalRouterRouteEntry(admin_distance=None, logical_router_port_id=None, lr_component_id=None, lr_component_type=None, network=None, next_hop=None, route_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • admin_distance (long or None) – The admin distance of the next hop format: int64
    • +
  • logical_router_port_id (str or None) – The id of the logical router port which is used as the next hop
    • +
  • lr_component_id (str or None) – Logical router component(Service Router/Distributed Router) id
    • +
  • lr_component_type (str or None) – Logical router component(Service Router/Distributed Router) type
    • +
  • network (str) – CIDR network address format: ipv4-cidr-block
    • +
  • next_hop (str or None) – The IP address of the next hop format: ip
    • +
  • route_type (str) – Route type (USER, CONNECTED, NSX_INTERNAL,..)
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LogicalRouterRouteTable(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, last_update_timestamp=None, logical_router_id=None, logical_router_name=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has +never updated the data. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • logical_router_id (str) – The id of the logical router
    • +
  • logical_router_name (str or None) – Name of the logical router +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of LogicalRouterRouteEntry or None) –
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LogicalRouterRouteTableInCsvFormat(file_name=None, last_update_timestamp=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • file_name (str or None) – File name set by HTTP server if API returns CSV result as a file.
    • +
  • last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has +never updated the data. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of LogicalRouterRouteCsvRecord or None) –
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LogicalRouterStatus(last_update_timestamp=None, logical_router_id=None, per_node_status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has +never updated the data. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • logical_router_id (str) – The id of the logical router
    • +
  • per_node_status (list of LogicalRouterStatusPerNode or None) – Per Node Status +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LogicalRouterStatusPerNode(high_availability_status=None, service_router_id=None, transport_node_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+HIGH_AVAILABILITY_STATUS_ACTIVE = 'ACTIVE'
+
+ +
+
+HIGH_AVAILABILITY_STATUS_DOWN = 'DOWN'
+
+ +
+
+HIGH_AVAILABILITY_STATUS_STANDBY = 'STANDBY'
+
+ +
+
+HIGH_AVAILABILITY_STATUS_SYNC = 'SYNC'
+
+ +
+
+HIGH_AVAILABILITY_STATUS_UNKNOWN = 'UNKNOWN'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LogicalRouterUpLinkPort(edge_cluster_member_index=None, linked_logical_switch_port_id=None, mac_address=None, mtu=None, subnets=None, urpf_mode=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LogicalRouterUpLinkPort', tags=None, logical_router_id=None, service_bindings=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • edge_cluster_member_index (list of long) – Member index of the edge node on the cluster format: int64
    • +
  • linked_logical_switch_port_id (ResourceReference or None) – Reference to the logical switch port to connect to
    • +
  • mac_address (str or None) – MAC address +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • mtu (long or None) – Maximum transmission unit specifies the size of the largest packet +that a network protocol can transmit. format: int64
    • +
  • subnets (list of IPSubnet) – Logical router port subnets
    • +
  • urpf_mode (str or None) –

    Possible values are:

    + +
    +
    Unicast Reverse Path Forwarding mode
    +
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +

    LogicalRouterUpLinkPort is allowed only on TIER0 logical router. It +is the north facing port of the logical router. +LogicalRouterLinkPortOnTIER0 is allowed only on TIER0 logical +router. This is the port where the LogicalRouterLinkPortOnTIER1 of +TIER1 logical router connects to. LogicalRouterLinkPortOnTIER1 is +allowed only on TIER1 logical router. This is the port using which +the user connected to TIER1 logical router for upwards connectivity +via TIER0 logical router. Connect this port to the +LogicalRouterLinkPortOnTIER0 of the TIER0 logical router. +LogicalRouterDownLinkPort is for the connected subnets on the +logical router. LogicalRouterLoopbackPort is a loopback port for +logical router component which is placed on chosen edge cluster +member. LogicalRouterIPTunnelPort is a IPSec VPN tunnel port +created on logical router when route based VPN session configured. +LogicalRouterCentralizedServicePort is allowed only on +Active/Standby TIER0 and TIER1 logical router. Port can be +connected to VLAN or overlay logical switch. Unlike downlink port +it does not participate in distributed routing and hosted on all +edge cluster members associated with logical router. Stateful +services can be applied on this port.

    +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • logical_router_id (str) – Identifier for logical router on which this port is created
    • +
  • service_bindings (list of ServiceBinding or None) – Service Bindings
    • +
+
+
+
+URPF_MODE_NONE = 'NONE'
+
+ +
+
+URPF_MODE_STRICT = 'STRICT'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LogicalService(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, dhcp_relay_profile_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +
    +
    Resource type of the logical service
    +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • dhcp_relay_profile_id (str) – dhcp relay profile referenced by the dhcp relay service
    • +
+
+
+
+RESOURCE_TYPE_DHCPRELAYSERVICE = 'DhcpRelayService'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LogicalServiceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of LogicalService) – Logical router service list results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LogicalSwitch(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, address_bindings=None, admin_state=None, extra_configs=None, ip_pool_id=None, mac_pool_id=None, replication_mode=None, switching_profile_ids=None, transport_zone_id=None, uplink_teaming_policy_name=None, vlan=None, vlan_trunk_spec=None, vni=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • address_bindings (list of PacketAddressClassifier or None) – Address bindings for the Logical switch
    • +
  • admin_state (str) –

    Possible values are:

    + +
    +
    Represents Desired state of the Logical Switch
    +
    • +
  • extra_configs (list of ExtraConfig or None) – This property could be used for vendor specific configuration in +key value string pairs, the setting in extra_configs will be +automatically inheritted by logical ports in the logical switch.
    • +
  • ip_pool_id (str or None) – IP pool id that associated with a LogicalSwitch.
    • +
  • mac_pool_id (str or None) – Mac pool id that associated with a LogicalSwitch.
    • +
  • replication_mode (str or None) –

    Possible values are:

    + +
    +
    Replication mode of the Logical Switch
    +
    • +
  • switching_profile_ids (list of SwitchingProfileTypeIdEntry or None) –
    • +
  • transport_zone_id (str) – Id of the TransportZone to which this LogicalSwitch is associated
    • +
  • uplink_teaming_policy_name (str or None) – This name has to be one of the switching uplink teaming policy +names listed inside the logical switch’s TransportZone. If this +field is not specified, the logical switch will not have a teaming +policy associated with it and the host switch’s default teaming +policy will be used.
    • +
  • vlan (long or None) – This property is dedicated to VLAN based network, to set VLAN of +logical network. It is mutually exclusive with ‘vlan_trunk_spec’. +format: int64
    • +
  • vlan_trunk_spec (VlanTrunkSpec or None) – This property is used for VLAN trunk specification of logical +switch. It’s mutually exclusive with ‘vlan’. Also it could be set +to do guest VLAN tagging in overlay network.
    • +
  • vni (long or None) – Only for OVERLAY network. A VNI will be auto-allocated from the +default VNI pool if not given; otherwise the given VNI has to be +inside the default pool and not used by any other LogicalSwitch. +format: int32
    • +
+
+
+
+ADMIN_STATE_DOWN = 'DOWN'
+
+ +
+
+ADMIN_STATE_UP = 'UP'
+
+ +
+
+REPLICATION_MODE_MTEP = 'MTEP'
+
+ +
+
+REPLICATION_MODE_SOURCE = 'SOURCE'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LogicalSwitchListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Logical Switch queries result

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of LogicalSwitch or None) – Logical Switch Results +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LogicalSwitchMirrorSource(switch_id=None, resource_type='LogicalSwitchMirrorSource')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+ +
+
+class com.vmware.nsx.model_client.LogicalSwitchState(details=None, failure_code=None, failure_message=None, state=None, logical_switch_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+STATE_FAILED = 'failed'
+
+ +
+
+STATE_IN_PROGRESS = 'in_progress'
+
+ +
+
+STATE_ORPHANED = 'orphaned'
+
+ +
+
+STATE_PARTIAL_SUCCESS = 'partial_success'
+
+ +
+
+STATE_PENDING = 'pending'
+
+ +
+
+STATE_SUCCESS = 'success'
+
+ +
+
+STATE_UNKNOWN = 'unknown'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.LogicalSwitchStateListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Logical Switch state queries result

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of LogicalSwitchState or None) – Logical Switch State Results +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LogicalSwitchStatistics(rx_bytes=None, rx_packets=None, tx_bytes=None, tx_packets=None, dropped_by_security_packets=None, mac_learning=None, last_update_timestamp=None, logical_switch_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • rx_bytes (DataCounter or None) –
    • +
  • rx_packets (DataCounter or None) –
    • +
  • tx_bytes (DataCounter or None) –
    • +
  • tx_packets (DataCounter or None) –
    • +
  • dropped_by_security_packets (PacketsDroppedBySecurity or None) –
    • +
  • mac_learning (MacLearningCounters or None) –
    • +
  • last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has +never updated the data. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • logical_switch_id (str or None) – The id of the logical Switch +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LogicalSwitchStatus(logical_switch_id=None, num_logical_ports=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • logical_switch_id (str or None) – Unique ID identifying the the Logical Switch +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • num_logical_ports (long or None) – Count of Logical Ports belonging to this switch format: int32 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LogicalSwitchStatusListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Logical Switch runtime status queries result

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of LogicalSwitchStatus or None) – LogicalSwitchStatus Results +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LogicalSwitchStatusSummary(filters=None, fully_realized_switches=None, last_update_timestamp=None, total_switches=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • filters (list of Filter or None) – The filters used to find the logical switches- TransportZone id, +LogicalSwitchProfile id or TransportType
    • +
  • fully_realized_switches (long) – The number of logical switches that are realized in all transport +nodes. format: int64
    • +
  • last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has +never updated the data. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • total_switches (long) – The total number of logical switches. format: int64
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.LoginCredential(credential_type='LoginCredential')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Base type for various login credential types

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:credential_type (str) – Possible values are ‘UsernamePasswordLoginCredential’, +‘VerifiableAsymmetricLoginCredential’.
+
+ +
+
+class com.vmware.nsx.model_client.MACAddressElement(links=None, schema=None, self_=None, revision=None, mac_address=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

MAC Address

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • mac_address (str) – A MAC address. Must be 6 pairs of hexadecimal digits, upper or +lower case, separated by colons or dashes. Examples: +01:23:45:67:89:ab, 01-23-45-67-89-AB.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.MACAddressElementListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Collection of MAC address elements

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of MACAddressElement) – MAC address element list
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.MACSet(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, mac_addresses=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

MACSet is used to group individual MAC addresses. MACSets can be used as +sources and destinations in layer2 firewall rules. These can also be used +as members of NSGroups.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • mac_addresses (list of str or None) – MAC addresses
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.MACSetListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of MACSet) – Paged collection of MACSets
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.MacAddressCsvListResult(file_name=None, last_update_timestamp=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • file_name (str or None) – File name set by HTTP server if API returns CSV result as a file.
    • +
  • last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has +never updated the data. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of MacTableCsvRecord or None) –
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.MacAddressListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, last_update_timestamp=None, logical_switch_id=None, results=None, transport_node_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has +never updated the data. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • logical_switch_id (str or None) – The id of the logical Switch +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of MacTableEntry or None) –
    • +
  • transport_node_id (str or None) – Transport node identifier +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.MacLearningCounters(mac_not_learned_packets_allowed=None, mac_not_learned_packets_dropped=None, macs_learned=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • mac_not_learned_packets_allowed (long or None) – The number of packets with unknown source MAC address that are +dispatched without learning the source MAC address. Applicable only +when the MAC limit is reached and MAC Limit policy is +MAC_LEARNING_LIMIT_POLICY_ALLOW. format: int64
    • +
  • mac_not_learned_packets_dropped (long or None) – The number of packets with unknown source MAC address that are +dropped without learning the source MAC address. Applicable only +when the MAC limit is reached and MAC Limit policy is +MAC_LEARNING_LIMIT_POLICY_DROP. format: int64
    • +
  • macs_learned (long or None) – Number of MACs learned format: int64
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.MacLearningSpec(aging_time=None, enabled=None, limit=None, limit_policy=None, unicast_flooding_allowed=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

MAC learning configuration

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • aging_time (long or None) – Aging time in sec for learned MAC address format: int32 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • enabled (bool) – Allowing source MAC address learning
    • +
  • limit (long or None) – The maximum number of MAC addresses that can be learned on this +port format: int32
    • +
  • limit_policy (str or None) –

    Possible values are:

    + +
    +
    The policy after MAC Limit is exceeded
    +
    • +
  • unicast_flooding_allowed (bool or None) – Allowing flooding for unlearned MAC for ingress traffic
    • +
+
+
+
+LIMIT_POLICY_ALLOW = 'ALLOW'
+
+ +
+
+LIMIT_POLICY_DROP = 'DROP'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.MacManagementSwitchingProfile(mac_change_allowed=None, mac_learning=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='MacManagementSwitchingProfile', tags=None, required_capabilities=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • mac_change_allowed (bool or None) – Allowing source MAC address change
    • +
  • mac_learning (MacLearningSpec or None) – MAC learning configuration
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • required_capabilities (list of str or None) –
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.MacPool(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, ranges=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

A collection of ranges of MAC addresses

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • ranges (list of MacRange) – Array of ranges for MAC addresses
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.MacPoolListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of MacPool) – MAC pool list results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.MacRange(end=None, start=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

A range of MAC addresses with a start and end value

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • end (str) – End value for MAC address range
    • +
  • start (str) – Start value for MAC address range
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.MacTableCsvRecord(mac_address=None, vtep_ip=None, vtep_mac_address=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • mac_address (str) – The MAC address
    • +
  • vtep_ip (str or None) – The virtual tunnel endpoint IP address format: ip
    • +
  • vtep_mac_address (str or None) – The virtual tunnel endpoint MAC address
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.MacTableEntry(mac_address=None, vtep_ip=None, vtep_mac_address=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • mac_address (str) – The MAC address
    • +
  • vtep_ip (str or None) – The virtual tunnel endpoint IP address format: ip
    • +
  • vtep_mac_address (str or None) – The virtual tunnel endpoint MAC address
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ManagedResource(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Base type for resources that are managed by API clients

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ManagementClusterNodeStatus(mgmt_cluster_status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:mgmt_cluster_status (str or None) –

Possible values are:

+ +
+
Status of this node’s connection to the management cluster
+

This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

+
+
+
+MGMT_CLUSTER_STATUS_CONNECTED = 'CONNECTED'
+
+ +
+
+MGMT_CLUSTER_STATUS_DISCONNECTED = 'DISCONNECTED'
+
+ +
+
+MGMT_CLUSTER_STATUS_UNKNOWN = 'UNKNOWN'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.ManagementClusterRoleConfig(type=None, api_listen_addr=None, mgmt_cluster_listen_addr=None, mgmt_plane_listen_addr=None, mpa_msg_client_info=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+TYPE_CONTROLLERCLUSTERROLECONFIG = 'ControllerClusterRoleConfig'
+
+ +
+
+TYPE_MANAGEMENTCLUSTERROLECONFIG = 'ManagementClusterRoleConfig'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.ManagementClusterStatus(offline_nodes=None, online_nodes=None, required_members_for_initialization=None, status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+STATUS_INITIALIZING = 'INITIALIZING'
+
+ +
+
+STATUS_STABLE = 'STABLE'
+
+ +
+
+STATUS_UNKNOWN = 'UNKNOWN'
+
+ +
+
+STATUS_UNSTABLE = 'UNSTABLE'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.ManagementConfig(links=None, schema=None, self_=None, revision=None, publish_fqdns=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • publish_fqdns (bool) – True if Management nodes publish their fqdns(instead of default IP +addresses) across NSX for its reachability.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ManagementNodeAggregateInfo(display_name=None, id=None, node_interface_properties=None, node_interface_statistics=None, node_status=None, node_status_properties=None, role_config=None, transport_nodes_connected=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • node_interface_properties (list of NodeInterfaceProperties or None) – Array of Node interface statistic properties +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • node_interface_statistics (list of NodeInterfaceStatisticsProperties or None) – Array of Node network interface statistic properties +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • node_status (ClusterNodeStatus or None) –
    • +
  • node_status_properties (list of NodeStatusProperties or None) – Time series of the node’s system properties
    • +
  • role_config (ManagementClusterRoleConfig or None) –
    • +
  • transport_nodes_connected (long or None) –
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ManagementPlaneBaseNodeInfo(mgmt_cluster_listen_ip_address=None, uuid=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The basic node info of management plane node

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • mgmt_cluster_listen_ip_address (str or None) – The IP address of MP node +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • uuid (str or None) – Management plane node UUID +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.MandatoryAccessControlProperties(links=None, schema=None, self_=None, enabled=None, status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Information about mandatory access control

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • enabled (bool or None) – Enabled can be True/False
    • +
  • status (str or None) –

    Possible values are:

    + +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
+
+
+
+STATUS_DISABLED = 'DISABLED'
+
+ +
+
+STATUS_ENABLED = 'ENABLED'
+
+ +
+
+STATUS_ENABLED_PENDING_REBOOT = 'ENABLED_PENDING_REBOOT'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.MetadataProxy(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, attached_logical_port_id=None, crypto_protocols=None, edge_cluster_id=None, edge_cluster_member_indexes=None, metadata_server_ca_ids=None, metadata_server_url=None, secret=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • attached_logical_port_id (str or None) – id of attached logical port +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • crypto_protocols (list of str or None) –

    Possible values are:

    + +

    The cryptographic protocols listed here are supported by the +metadata proxy. The TLSv1.1 and TLSv1.2 are supported by default.

    +
    • +
  • edge_cluster_id (str) – edge cluster uuid
    • +
  • edge_cluster_member_indexes (list of long or None) – If none is provided, the NSX will auto-select two edge-nodes from +the given edge cluster. If user provides only one edge node, there +will be no HA support. format: int64
    • +
  • metadata_server_ca_ids (list of str or None) – The CAs referenced here must be uploaded to the truststore using +the API POST /api/v1/trust-management/certificates?action=import. +User needs to ensure a correct CA for this metedata server is used. +The REST API can not detect a wrong CA which was used to verify a +different server. If the Metadata Proxy reports an ERROR or +NO_BACKUP status, user can check the metadata proxy log at +transport node for a possible CA issue.
    • +
  • metadata_server_url (str) – The URL in format scheme://host:port/path. Please note, the scheme +supports only http and https as of now, port supports range 3000 - +9000, inclusive.
    • +
  • secret (str or None) – secret to access metadata server
    • +
+
+
+
+CRYPTO_PROTOCOLS_V1 = 'TLS_V1'
+
+ +
+
+CRYPTO_PROTOCOLS_V1_1 = 'TLS_V1_1'
+
+ +
+
+CRYPTO_PROTOCOLS_V1_2 = 'TLS_V1_2'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.MetadataProxyListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of MetadataProxy) – paginated list of metadata proxies
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.MetadataProxyStatistics(metadata_proxy_id=None, statistics=None, timestamp=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • metadata_proxy_id (str) – metadata proxy uuid
    • +
  • statistics (list of MetadataProxyStatisticsPerLogicalSwitch or None) – metadata proxy statistics per logical switch
    • +
  • timestamp (long) – timestamp of the statistics format: int64
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.MetadataProxyStatisticsPerLogicalSwitch(error_responses_from_nova_server=None, logical_switch_id=None, requests_from_clients=None, requests_to_nova_server=None, responses_to_clients=None, succeeded_responses_from_nova_server=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • error_responses_from_nova_server (long) – error responses from nova server format: int64
    • +
  • logical_switch_id (str) – uuid of attached logical switch
    • +
  • requests_from_clients (long) – requests from clients format: int64
    • +
  • requests_to_nova_server (long) – requests to nova server format: int64
    • +
  • responses_to_clients (long) – responses to clients format: int64
    • +
  • succeeded_responses_from_nova_server (long) – succeeded responses from nova server format: int64
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.MetadataProxyStatus(error_message=None, proxy_status=None, transport_nodes=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • error_message (str or None) – Error message, if available
    • +
  • proxy_status (str) –

    Possible values are:

    + +

    UP means the metadata proxy is working fine on both +transport-nodes(if have); DOWN means the metadata proxy is is down +on both transport-nodes(if have), hence the metadata proxy will not +repsonse any metadata request; Error means error happens on +transport-node(s) or no status is reported from transport-node(s). +The metadata proxy may be working (or not working); NO_BACK means +metadata proxy is working in one of the transport node while not in +the other transport-node (if have). Hence if the metadata proxy in +the working transport-node goes down, the metadata proxy will go +down.

    +
    • +
  • transport_nodes (list of str) – Order of the transport nodes is insensitive because Metadata Proxy +is running in Active-Active mode among target transport nodes.
    • +
+
+
+
+PROXY_STATUS_DOWN = 'DOWN'
+
+ +
+
+PROXY_STATUS_ERROR = 'ERROR'
+
+ +
+
+PROXY_STATUS_NO_BACKUP = 'NO_BACKUP'
+
+ +
+
+PROXY_STATUS_UP = 'UP'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.MgmtConnStatus(connectivity_status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:connectivity_status (str or None) –

Possible values are:

+ +
+
Indicates the controller node’s MP channel connectivity status
+

This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

+
+
+
+CONNECTIVITY_STATUS_CONNECTED = 'CONNECTED'
+
+ +
+
+CONNECTIVITY_STATUS_DISCONNECTED = 'DISCONNECTED'
+
+ +
+
+CONNECTIVITY_STATUS_UNKNOWN = 'UNKNOWN'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.MigrationBundleFetchRequest(url=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

URL and other fetch requests of migration bundle

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:url (str) – URL for uploading migration bundle
+
+ +
+
+class com.vmware.nsx.model_client.MigrationBundleId(bundle_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Identifier of the migration bundle

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:bundle_id (str or None) – Identifier of bundle upload +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
+
+ +
+
+class com.vmware.nsx.model_client.MigrationBundleInfo(bundle_size=None, url=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Information about the migration bundle

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • bundle_size (str or None) – size of migration bundle +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • url (str or None) – URL for uploading migration bundle +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.MigrationBundleUploadStatus(detailed_status=None, percent=None, status=None, url=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Upload status of migration bundle uploaded from url

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • detailed_status (str or None) – Detailed status of migration bundle upload +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • percent (float or None) – Percent of bundle uploaded from URL +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • status (str or None) –

    Possible values are:

    + +
    +
    Current status of migration bundle upload
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • url (str or None) – URL for uploading migration bundle +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+
+STATUS_FAILED = 'FAILED'
+
+ +
+
+STATUS_SUCCESS = 'SUCCESS'
+
+ +
+
+STATUS_UPLOADING = 'UPLOADING'
+
+ +
+
+STATUS_VERIFYING = 'VERIFYING'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.MigrationFeedbackRequest(accepted_actions=None, accepted_values=None, id=None, message=None, object_id=None, sub_vertical=None, suggested_action=None, suggested_value=None, vertical=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Detailed feedback requests from the migration tool where user input is +required.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • accepted_actions (list of str or None) – List of acceptable actions for this feedback request. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • accepted_values (list of str or None) – List of acceptable values for this feedback request. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • id (str or None) – Identifier of the feedback request. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • message (str or None) – Detailed feedback request with options. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • object_id (str or None) – Identifier of the object for which feedback is requested. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sub_vertical (str or None) – Functional sub-area that this query falls into. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • suggested_action (str or None) – The suggested action to resolve this feedback request. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • suggested_value (str or None) – The suggested value to resolve this feedback request. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • vertical (str or None) – Functional area that this query falls into. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.MigrationFeedbackRequestListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

List of detailed feedback requests from the migration tool where user input +is required.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of MigrationFeedbackRequest) – Paged Collection of feedback requests
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.MigrationFeedbackResponse(action=None, id=None, value=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Detailed feedback requests from the migration tool where user input is +required.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • action (str) – Action selected in response to the feedback request.
    • +
  • id (str) – Identifier of the feedback request.
    • +
  • value (str) – User input provided inresponse to the feedback request.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.MigrationFeedbackResponseList(response_list=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

List of detailed feedback response for the migration tool.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:response_list (list of MigrationFeedbackResponse) – List of feedback responses.
+
+ +
+
+class com.vmware.nsx.model_client.MigrationPlanSettings(parallel=None, pause_after_each_group=None, pause_on_error=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • parallel (bool or None) – Migration Method to specify whether the migration is to be +performed serially or in parallel
    • +
  • pause_after_each_group (bool or None) – Flag to indicate whether to pause the migration after migration of +each group is completed
    • +
  • pause_on_error (bool or None) – Flag to indicate whether to pause the migration plan execution when +an error occurs
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.MigrationSetupInfo(destination_nsx=None, source_nsx=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Details about source and destination NSX setup to be migrated

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+ +
+
+class com.vmware.nsx.model_client.MigrationStatus(component_status=None, overall_migration_status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+OVERALL_MIGRATION_STATUS_FAILED = 'FAILED'
+
+ +
+
+OVERALL_MIGRATION_STATUS_IN_PROGRESS = 'IN_PROGRESS'
+
+ +
+
+OVERALL_MIGRATION_STATUS_NOT_STARTED = 'NOT_STARTED'
+
+ +
+
+OVERALL_MIGRATION_STATUS_PAUSED = 'PAUSED'
+
+ +
+
+OVERALL_MIGRATION_STATUS_SUCCESS = 'SUCCESS'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.MigrationSummary(component_target_versions=None, migration_bundle_file_name=None, migration_coordinator_version=None, migration_status=None, system_version=None, target_version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • component_target_versions (list of ComponentTargetVersion or None) –
    • +
  • migration_bundle_file_name (str or None) – Name of the last successfully uploaded migration bundle file +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • migration_coordinator_version (str or None) – Current version of migration coordinator +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • migration_status (str or None) –

    Possible values are:

    + +
    +
    Status of migration
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • system_version (str or None) – Current system version +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • target_version (str or None) – Target system version +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+
+MIGRATION_STATUS_FAILED = 'FAILED'
+
+ +
+
+MIGRATION_STATUS_IN_PROGRESS = 'IN_PROGRESS'
+
+ +
+
+MIGRATION_STATUS_NOT_STARTED = 'NOT_STARTED'
+
+ +
+
+MIGRATION_STATUS_PAUSED = 'PAUSED'
+
+ +
+
+MIGRATION_STATUS_SUCCESS = 'SUCCESS'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.MigrationUnit(links=None, schema=None, self_=None, current_version=None, display_name=None, group=None, id=None, metadata=None, type=None, warnings=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • current_version (str or None) – This is component version e.g. if migration unit is of type +INFRASTRUCTURE, then this is host version. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • display_name (str or None) – Name of the migration unit
    • +
  • group (ResourceReference or None) – Info of the group to which this migration unit belongs
    • +
  • id (str or None) – Identifier of the migration unit +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • metadata (list of KeyValuePair or None) – Metadata about migration unit +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • type (str or None) – Migration unit type
    • +
  • warnings (list of str or None) – List of warnings indicating issues with the migration unit that may +result in migration failure +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.MigrationUnitAggregateInfo(links=None, schema=None, self_=None, errors=None, percent_complete=None, status=None, unit=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • errors (list of str or None) – List of errors occurred during migration of this migration unit +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • percent_complete (float or None) – Indicator of migration progress in percentage +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • status (str or None) –

    Possible values are:

    + +
    +
    Status of migration unit
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • unit (MigrationUnit or None) – Details of the migration unit
    • +
+
+
+
+STATUS_FAILED = 'FAILED'
+
+ +
+
+STATUS_IN_PROGRESS = 'IN_PROGRESS'
+
+ +
+
+STATUS_NOT_STARTED = 'NOT_STARTED'
+
+ +
+
+STATUS_PAUSED = 'PAUSED'
+
+ +
+
+STATUS_SUCCESS = 'SUCCESS'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.MigrationUnitAggregateInfoListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of MigrationUnitAggregateInfo or None) – Paged collection of MigrationUnit AggregateInfo +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.MigrationUnitGroup(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, enabled=None, extended_configuration=None, migration_unit_count=None, migration_units=None, parallel=None, type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • enabled (bool or None) – Flag to indicate whether migration of this group is enabled or not
    • +
  • extended_configuration (list of KeyValuePair or None) – Extended configuration for the group
    • +
  • migration_unit_count (long or None) – Number of migration units in the group format: int32 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • migration_units (list of MigrationUnit or None) – List of migration units in the group
    • +
  • parallel (bool or None) – Migration method to specify whether the migration is to be +performed in parallel or serially
    • +
  • type (str) – Component type
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.MigrationUnitGroupAggregateInfo(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, failed_count=None, group=None, percent_complete=None, status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • failed_count (long or None) – Number of nodes in the migration unit group that failed migration +format: int32 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • group (MigrationUnitGroup) – Migration unit group details
    • +
  • percent_complete (float or None) – Indicator of migration progress in percentage +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • status (str or None) –

    Possible values are:

    + +
    +
    Migration status of migration unit group
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
+
+
+
+STATUS_FAILED = 'FAILED'
+
+ +
+
+STATUS_IN_PROGRESS = 'IN_PROGRESS'
+
+ +
+
+STATUS_NOT_STARTED = 'NOT_STARTED'
+
+ +
+
+STATUS_PAUSED = 'PAUSED'
+
+ +
+
+STATUS_SUCCESS = 'SUCCESS'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.MigrationUnitGroupAggregateInfoListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of MigrationUnitGroupAggregateInfo or None) – Paged collection of migration status for migration unit groups +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.MigrationUnitGroupListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of MigrationUnitGroup) – Paged Collection of Migration unit groups
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.MigrationUnitGroupStatus(failed_count=None, group_id=None, group_name=None, migration_unit_count=None, percent_complete=None, status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • failed_count (long or None) – Number of nodes in the migration unit group that failed migration +format: int32 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • group_id (str or None) – Identifier for migration unit group +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • group_name (str or None) – Name of the migration unit group +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • migration_unit_count (long or None) – Number of migration units in the group format: int32 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • percent_complete (float or None) – Indicator of migration progress in percentage +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • status (str or None) –

    Possible values are:

    + +
    +
    Migration status of migration unit group
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
+
+
+
+STATUS_FAILED = 'FAILED'
+
+ +
+
+STATUS_IN_PROGRESS = 'IN_PROGRESS'
+
+ +
+
+STATUS_NOT_STARTED = 'NOT_STARTED'
+
+ +
+
+STATUS_PAUSED = 'PAUSED'
+
+ +
+
+STATUS_SUCCESS = 'SUCCESS'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.MigrationUnitGroupStatusListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of MigrationUnitGroupStatus or None) – Paged collection of migration status for migration unit groups +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.MigrationUnitList(list=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:list (list of MigrationUnit) – Collection of Migration units
+
+ +
+
+class com.vmware.nsx.model_client.MigrationUnitListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of MigrationUnit) – Paged Collection of Migration units
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.MigrationUnitStatus(display_name=None, errors=None, id=None, percent_complete=None, status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • display_name (str or None) – Name of migration unit +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • errors (list of str or None) – List of errors occurred during migration of this migration unit +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • id (str or None) – Identifier of migration unit +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • percent_complete (float or None) – Indicator of migration progress in percentage +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • status (str or None) –

    Possible values are:

    + +
    +
    Status of migration unit
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
+
+
+
+STATUS_FAILED = 'FAILED'
+
+ +
+
+STATUS_IN_PROGRESS = 'IN_PROGRESS'
+
+ +
+
+STATUS_NOT_STARTED = 'NOT_STARTED'
+
+ +
+
+STATUS_PAUSED = 'PAUSED'
+
+ +
+
+STATUS_SUCCESS = 'SUCCESS'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.MigrationUnitStatusListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of MigrationUnitStatus) – Paged Collection of migration units status
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.MigrationUnitTypeStats(node_count=None, node_with_issues_count=None, type=None, version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • node_count (long or None) – Number of nodes format: int32 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • node_with_issues_count (long or None) – Number of nodes with issues that may cause migration failure +format: int32 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • type (str or None) – Type of migration unit +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • version (str or None) – Version of the migration unit +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.MigrationUnitTypeStatsList(results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:results (list of MigrationUnitTypeStats or None) – List of migration unit type stats +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
+
+ +
+
+class com.vmware.nsx.model_client.MirrorDestination(resource_type='MirrorDestination')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:resource_type (str) –

Possible values are:

+ +
+
Resource types of mirror destination
+
+
+
+RESOURCE_TYPE_IPMIRRORDESTINATION = 'IPMirrorDestination'
+
+ +
+
+RESOURCE_TYPE_LOGICALPORTMIRRORDESTINATION = 'LogicalPortMirrorDestination'
+
+ +
+
+RESOURCE_TYPE_PNICMIRRORDESTINATION = 'PnicMirrorDestination'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.MirrorSource(resource_type='MirrorSource')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:resource_type (str) –

Possible values are:

+ +
+
Resource types of mirror source
+
+
+
+RESOURCE_TYPE_LOGICALPORTMIRRORSOURCE = 'LogicalPortMirrorSource'
+
+ +
+
+RESOURCE_TYPE_LOGICALSWITCHMIRRORSOURCE = 'LogicalSwitchMirrorSource'
+
+ +
+
+RESOURCE_TYPE_PNICMIRRORSOURCE = 'PnicMirrorSource'
+
+ +
+
+RESOURCE_TYPE_VLANMIRRORSOURCE = 'VlanMirrorSource'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.MonthlyTelemetrySchedule(day_of_month=None, hour_of_day=None, minutes=None, frequency_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • day_of_month (long) – Day of month on which data will be collected. Specify a value +between 1 through 31. format: int64
    • +
  • hour_of_day (long) – Hour at which data will be collected. Specify a value between 0 +through 23. format: int64
    • +
  • minutes (long or None) – Minute at which data will be collected. Specify a value between 0 +through 59. format: int64
    • +
  • frequency_type (str) – Specify one of DailyTelemetrySchedule, WeeklyTelemetrySchedule, or +MonthlyTelemetrySchedule.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.MsgClientInfo(account_name=None, certificate=None, shared_secret=None, software_version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Information about a messaging client

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • account_name (str or None) – Account name for the messaging client. Identifies the client on the +management plane message bus.
    • +
  • certificate (str or None) – Messaging client’s certificate. Used to authenticate to the control +plane messaging endpoint.
    • +
  • shared_secret (str or None) – Messaging client’s secret. Used to authenticate to the management +plane messaging broker.
    • +
  • software_version (str or None) – Software version of the node. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.MultiWidgetConfiguration(navigation=None, widgets=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='MultiWidgetConfiguration', tags=None, datasources=None, drilldown_id=None, footer=None, is_drilldown=None, shared=None, weight=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Combines two or more widgetconfigurations into a multi-widget

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • navigation (str or None) – Hyperlink of the specified UI page that provides details.
    • +
  • widgets (list of WidgetItem) – Array of widgets that are part of the multi-widget.
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str) – Title of the widget.
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +

    Supported visualization types are LabelValueConfiguration, +DonutConfiguration, GridConfiguration, StatsConfiguration, +MultiWidgetConfiguration and ContainerConfiguration.

    +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • datasources (list of Datasource or None) – The ‘datasources’ represent the sources from which data will be +fetched. Currently, only NSX-API is supported as a ‘default’ +datasource. An example of specifying ‘default’ datasource along +with the urls to fetch data from is given at ‘example_request’ +section of ‘CreateWidgetConfiguration’ API.
    • +
  • drilldown_id (str or None) – Id of drilldown widget, if any. Id should be a valid id of an +existing widget. A widget is considered as drilldown widget when it +is associated with any other widget and provides more detailed +information about any data item from the parent widget.
    • +
  • footer (Footer or None) –
    • +
  • is_drilldown (bool or None) – Set to true if this widget should be used as a drilldown.
    • +
  • shared (bool or None) – Please use the property ‘shared’ of View instead of this. The +widgets of a shared view are visible to other users.
    • +
  • weight (long or None) – Specify relavite weight in WidgetItem for placement in a view. +Please see WidgetItem for details. format: int32
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NSGroup(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, member_count=None, members=None, membership_criteria=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

NSGroups are recursive groupings of different NSX elements (logical and +physical), typically used in policy definitions.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • member_count (long or None) – Count of the members added to this NSGroup format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • members (list of NSGroupSimpleExpression or None) – Reference to the direct/static members of the NSGroup. Can be ID +based expressions only. VirtualMachine cannot be added as a static +member.
    • +
  • membership_criteria (list of vmware.vapi.struct.VapiStruct or None) – List of tag or name based expressions which define the dynamic +membership criteria for this NSGroup. An object must satisfy +atleast one of these expressions to qualify as a member of this +group. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +NSGroupExpression. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in NSGroupExpression.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NSGroupComplexExpression(expressions=None, resource_type='NSGroupComplexExpression')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Complex expressions to represent NSGroup membership

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+ +
+
+class com.vmware.nsx.model_client.NSGroupExpression(resource_type='NSGroupExpression')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Policy expression for NSGroup membership

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:resource_type (str) –

Possible values are:

+ +
+
+
+RESOURCE_TYPE_NSGROUPCOMPLEXEXPRESSION = 'NSGroupComplexExpression'
+
+ +
+
+RESOURCE_TYPE_NSGROUPSIMPLEEXPRESSION = 'NSGroupSimpleExpression'
+
+ +
+
+RESOURCE_TYPE_NSGROUPTAGEXPRESSION = 'NSGroupTagExpression'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.NSGroupExpressionList(members=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

List of NSGroupExpressions

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:members (list of vmware.vapi.struct.VapiStruct) – List of NSGroupExpressions to be passed to add and remove APIs +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +NSGroupExpression. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in NSGroupExpression.
+
+ +
+
+class com.vmware.nsx.model_client.NSGroupListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Paged Collection of NSGroups

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of NSGroup) – NSGroup list results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NSGroupMetaInfo(links=None, schema=None, self_=None, no_of_vms=None, ns_group_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Contains the metadata of a NSGroup when the application discovery session +was started

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • no_of_vms (long or None) – Number of VMs discovered for this NSGroup when session was started +format: int64
    • +
  • ns_group_id (str) – ID of the NS Group
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NSGroupMetaInfoListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

NSGroupMetaInfo list

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of NSGroupMetaInfo) – list of NSGroupMetaInfos
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NSGroupSimpleExpression(op=None, target_property=None, target_resource=None, target_type=None, value=None, resource_type='NSGroupSimpleExpression')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Simple expressions to represent NSGroup membership

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+OP_CONTAINS = 'CONTAINS'
+
+ +
+
+OP_EQUALS = 'EQUALS'
+
+ +
+
+OP_STARTSWITH = 'STARTSWITH'
+
+ +
+
+TARGET_TYPE_DIRECTORYGROUP = 'DirectoryGroup'
+
+ +
+
+TARGET_TYPE_IPSET = 'IPSet'
+
+ +
+
+TARGET_TYPE_LOGICALPORT = 'LogicalPort'
+
+ +
+
+TARGET_TYPE_LOGICALSWITCH = 'LogicalSwitch'
+
+ +
+
+TARGET_TYPE_MACSET = 'MACSet'
+
+ +
+
+TARGET_TYPE_NSGROUP = 'NSGroup'
+
+ +
+
+TARGET_TYPE_VIRTUALMACHINE = 'VirtualMachine'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.NSGroupTagExpression(scope=None, scope_op=None, tag=None, tag_op=None, target_type=None, resource_type='NSGroupTagExpression')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Includes both scope and tag attribute of Tag. The scope and tag expressions +are logically ‘AND’ with each other. eg- tag.scope = "S1" AND +tag.tag = ‘T1’

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+SCOPE_OP_EQUALS = 'EQUALS'
+
+ +
+
+TAG_OP_EQUALS = 'EQUALS'
+
+ +
+
+TARGET_TYPE_LOGICALPORT = 'LogicalPort'
+
+ +
+
+TARGET_TYPE_LOGICALSWITCH = 'LogicalSwitch'
+
+ +
+
+TARGET_TYPE_VIRTUALMACHINE = 'VirtualMachine'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.NSService(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, default_service=None, nsservice_element=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

A Networking and Security Service allows users to specify characteristics +to use for matching network traffic. For example the user can specify port +and protocol pair.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • default_service (bool or None) – The default NSServices are created in the system by default. These +NSServices can’t be modified/deleted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • nsservice_element (vmware.vapi.struct.VapiStruct) – An NSService Element that describes traffic corresponding to this +NSService +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +NSServiceElement. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in NSServiceElement.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NSServiceElement(resource_type='NSServiceElement')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

An NSService element that describes traffic corresponding to an NSService

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:resource_type (str) –

Possible values are:

+ +
+
The specific type of NSServiceElement
+
+
+
+RESOURCE_TYPE_ALGTYPENSSERVICE = 'ALGTypeNSService'
+
+ +
+
+RESOURCE_TYPE_ETHERTYPENSSERVICE = 'EtherTypeNSService'
+
+ +
+
+RESOURCE_TYPE_ICMPTYPENSSERVICE = 'ICMPTypeNSService'
+
+ +
+
+RESOURCE_TYPE_IGMPTYPENSSERVICE = 'IGMPTypeNSService'
+
+ +
+
+RESOURCE_TYPE_IPPROTOCOLNSSERVICE = 'IPProtocolNSService'
+
+ +
+
+RESOURCE_TYPE_L4PORTSETNSSERVICE = 'L4PortSetNSService'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.NSServiceGroup(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, default_service=None, members=None, service_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

A Networking and Security Service Group that represents a group of +NSServices

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • default_service (bool or None) – The default NSServiceGroups are created in the system by default. +These NSServiceGroups can’t be modified/deleted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • members (list of ResourceReference) – List of NSService or NSServiceGroup resources that can be added as +members to an NSServiceGroup.
    • +
  • service_type (str or None) –

    Possible values are:

    + +
    +
    Type of the NSServiceGroup
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
+
+
+
+SERVICE_TYPE_ETHER = 'ETHER'
+
+ +
+
+SERVICE_TYPE_NON_ETHER = 'NON_ETHER'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.NSServiceGroupListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

List result of NSServiceGroups

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of NSServiceGroup) – Paged collection of NSServiceGroups
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NSServiceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

List result of NSservices

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of NSService) – Paged collection of NSServices
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NamedTeamingPolicy(active_list=None, policy=None, standby_list=None, name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Uplink Teaming Policy with a name that can be referenced by logical +switches

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • active_list (list of Uplink) – List of Uplinks used in active list
    • +
  • policy (str) –

    Possible values are:

    + +
    +
    Teaming policy
    +
    • +
  • standby_list (list of Uplink or None) – List of Uplinks used in standby list
    • +
  • name (str) – An uplink teaming policy of a given name defined in +UplinkHostSwitchProfile. The names of all NamedTeamingPolicies in +an UplinkHostSwitchProfile must be different, but a name can be +shared by different UplinkHostSwitchProfiles. Different +TransportNodes can use different NamedTeamingPolicies having the +same name in different UplinkHostSwitchProfiles to realize an +uplink teaming policy on a logical switch. An uplink teaming policy +on a logical switch can be any policy defined by a user; it does +not have to be a single type of FAILOVER or LOADBALANCE. It can be +a combination of types, for instance, a user can define a policy +with name "MyHybridTeamingPolicy" as "FAILOVER on all +ESX TransportNodes and LOADBALANCE on all KVM TransportNodes". +The name is the key of the teaming policy and can not be changed +once assigned.
    • +
+
+
+
+POLICY_FAILOVER_ORDER = 'FAILOVER_ORDER'
+
+ +
+
+POLICY_LOADBALANCE_SRCID = 'LOADBALANCE_SRCID'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.NatCounters(active_sessions=None, total_bytes=None, total_packets=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • active_sessions (long or None) – The number of active sessions format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • total_bytes (long or None) – The number of bytes format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • total_packets (long or None) – The number of packets format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NatRule(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, action=None, applied_tos=None, enabled=None, logging=None, logical_router_id=None, match_destination_network=None, match_service=None, match_source_network=None, nat_pass=None, rule_priority=None, translated_network=None, translated_ports=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • action (str) –

    Possible values are:

    + +

    valid actions: SNAT, DNAT, NO_SNAT, NO_DNAT, REFLEXIVE. All rules +in a logical router are either stateless or stateful. Mix is not +supported. SNAT and DNAT are stateful, can NOT be supported when +the logical router is running at active-active HA mode; REFLEXIVE +is stateless. NO_SNAT and NO_DNAT have no translated_fields, only +match fields are supported.

    +
    • +
  • applied_tos (list of ResourceReference or None) – Holds the list of LogicalRouterPort Ids that a NAT rule can be +applied to. The LogicalRouterPort used must belong to the same +LogicalRouter for which the NAT Rule is created. As of now a NAT +rule can only have a single LogicalRouterPort as applied_tos. When +applied_tos is not set, the NAT rule is applied to all +LogicalRouterPorts beloging to the LogicalRouter.
    • +
  • enabled (bool or None) – enable/disable the rule
    • +
  • logging (bool or None) – enable/disable the logging of rule
    • +
  • logical_router_id (str or None) – Logical router id +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • match_destination_network (str or None) – IP Address | CIDR | (null implies Any)
    • +
  • match_service (vmware.vapi.struct.VapiStruct or None) – A NSServiceElement that specifies the matching services of source +ports, destination ports, ip protocol version and number, sub +protocol version and number, ICMP type and code, etc. The +match_service can be one of IPProtocolNSService,L4PortSetNSService +or ICMPTypeNSService. REFLEXIVE NAT does not support match_service. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +NSServiceElement. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in NSServiceElement.
    • +
  • match_source_network (str or None) – IP Address | CIDR | (null implies Any)
    • +
  • nat_pass (bool or None) – Default is true. If the nat_pass is set to true, the following +firewall stage will be skipped. Please note, if action is NO_NAT, +then nat_pass must be set to true or omitted.
    • +
  • rule_priority (long or None) – Ascending, valid range [0-2147483647]. If multiple rules have the +same priority, evaluation sequence is undefined. format: int64
    • +
  • translated_network (str or None) – IP Address | IP Range | CIDR
    • +
  • translated_ports (str or None) – port number or port range. DNAT only
    • +
+
+
+
+ACTION_DNAT = 'DNAT'
+
+ +
+
+ACTION_NO_DNAT = 'NO_DNAT'
+
+ +
+
+ACTION_NO_NAT = 'NO_NAT'
+
+ +
+
+ACTION_NO_SNAT = 'NO_SNAT'
+
+ +
+
+ACTION_REFLEXIVE = 'REFLEXIVE'
+
+ +
+
+ACTION_SNAT = 'SNAT'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.NatRuleListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of NatRule) – NAT rule list results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NatStatisticsPerLogicalRouter(last_update_timestamp=None, logical_router_id=None, per_transport_node_statistics=None, statistics_across_all_nodes=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has +never updated the data. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • logical_router_id (str or None) – Id for the logical router +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • per_transport_node_statistics (list of NatStatisticsPerTransportNode or None) – Detailed per node statistics +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • statistics_across_all_nodes (NatCounters or None) – Rolled-up statistics for all rules on the logical router across all +the nodes
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NatStatisticsPerRule(active_sessions=None, total_bytes=None, total_packets=None, id=None, last_update_timestamp=None, logical_router_id=None, warning_message=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • active_sessions (long or None) – The number of active sessions format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • total_bytes (long or None) – The number of bytes format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • total_packets (long or None) – The number of packets format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • id (str or None) – The id of the NAT rule. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has +never updated the data. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • logical_router_id (str or None) – The id of the logical router which owns the NAT rule. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • warning_message (str or None) – The warning message about the NAT Rule statistics. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NatStatisticsPerTransportNode(active_sessions=None, total_bytes=None, total_packets=None, last_update_timestamp=None, transport_node_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • active_sessions (long or None) – The number of active sessions format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • total_bytes (long or None) – The number of bytes format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • total_packets (long or None) – The number of packets format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has +never updated the data. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • transport_node_id (str or None) – Id for the transport node +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NeighborProperties(capabilities=None, enabled_capabilities=None, ifindex=None, link_aggregation_capable=None, link_aggregation_port_id=None, link_aggregation_status=None, mac=None, mgmt_addr=None, name=None, oid=None, port_desc=None, system_desc=None, system_name=None, system_port_number=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Neighbor properties

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • capabilities (str or None) – Capabilities +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • enabled_capabilities (str or None) – Enabled capabilities +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • ifindex (long or None) – Interface index format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • link_aggregation_capable (bool or None) – Aggregation Capability +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • link_aggregation_port_id (str or None) – Aggregation port id +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • link_aggregation_status (bool or None) – True if currently in aggregation +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • mac (str or None) – Interface MAC address +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • mgmt_addr (str or None) – Management address +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • name (str or None) – Interface name +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • oid (str or None) – Object identifier +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • port_desc (str or None) – Port description +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_desc (str or None) – System description +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_name (str or None) – System name +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_port_number (long or None) – System port number format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NetworkMigrationSpec(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='NetworkMigrationSpec', tags=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The NetworkMigrationSpec is the base class for any types of network +migration specifications to be handled by transport node.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
+
+
+
+RESOURCE_TYPE_HOSTPROFILENETWORKMIGRATIONSPEC = 'HostProfileNetworkMigrationSpec'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.NetworkMigrationSpecListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Network migration specification template list result

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of vmware.vapi.struct.VapiStruct or None) – Network migration specification template results +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +NetworkMigrationSpec. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in NetworkMigrationSpec. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NetworkMigrationSpecTypeIdEntry(key=None, value=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • key (str or None) –

    Possible values are:

    + +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • value (str) – the id of the NetworkMigrationSpec
    • +
+
+
+
+KEY_HOSTPROFILENETWORKMIGRATIONSPEC = 'HostProfileNetworkMigrationSpec'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.NicInfo(gateway_address=None, ip_address=None, network_id=None, nic_metadata=None, subnet_mask=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Information of a network interface present on the partner appliance that +needs to be configured by the NSX Manager.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • gateway_address (str or None) – Gateway address associated with the NIC metadata.
    • +
  • ip_address (str or None) – IP address associated with the NIC metadata.
    • +
  • network_id (str or None) – Network Id associated with the NIC metadata.
    • +
  • nic_metadata (NicMetadata or None) – NIC metadata information.
    • +
  • subnet_mask (str or None) – Subnet mask associated with the NIC metadata.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NicMetadata(interface_index=None, interface_label=None, interface_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Information on the Network interfaces present on the partner appliance that +needs to be configured by the NSX Manager.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+INTERFACE_TYPE_DATA1 = 'DATA1'
+
+ +
+
+INTERFACE_TYPE_DATA2 = 'DATA2'
+
+ +
+
+INTERFACE_TYPE_HA1 = 'HA1'
+
+ +
+
+INTERFACE_TYPE_HA2 = 'HA2'
+
+ +
+
+INTERFACE_TYPE_MANAGEMENT = 'MANAGEMENT'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.NiocProfile(enabled=None, host_infra_traffic_res=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='NiocProfile', tags=None, required_capabilities=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This profile is created for Network I/O Control(NIOC).

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • enabled (bool or None) – The enabled property specifies the status of NIOC feature. When +enabled is set to true, NIOC feature is turned on and the bandwidth +allocations specified for the traffic resources are enforced. When +enabled is set to false, NIOC feature is turned off and no +bandwidth allocation is guaranteed. By default, enabled will be set +to true.
    • +
  • host_infra_traffic_res (list of ResourceAllocation or None) – host_infra_traffic_res specifies bandwidth allocation for various +traffic resources.
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • required_capabilities (list of str or None) –
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.Node(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='Node', tags=None, discovered_ip_addresses=None, external_id=None, fqdn=None, ip_addresses=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) – Fabric node type, for example ‘HostNode’, ‘EdgeNode’ or +‘PublicCloudGatewayNode’
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • discovered_ip_addresses (list of str or None) – Discovered IP Addresses of the fabric node, version 4 or 6 format: +ip +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • external_id (str or None) – ID of the Node maintained on the Node and used to recognize the +Node
    • +
  • fqdn (str or None) – Fully qualified domain name of the fabric node +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • ip_addresses (list of str or None) – IP Addresses of the Node, version 4 or 6. This property is +mandatory for all nodes except for automatic deployment of edge +virtual machine node. For automatic deployment, the ip address from +management_port_subnets property will be considered. format: ip
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NodeAggregateInfo(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, node=None, status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Aggregation of desired and runtime status of fabric node

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • node (vmware.vapi.struct.VapiStruct or None) – Node attributes +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in Node. +When methods return a value of this class as a return value, the +attribute will contain all the attributes defined in Node.
    • +
  • status (NodeStatus or None) – Node status
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NodeAggregateInfoListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Node aggregate state list result

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of NodeAggregateInfo) – Node Aggregate Info Results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NodeAuthProviderVidmProperties(client_id=None, client_secret=None, host_name=None, node_host_name=None, thumbprint=None, vidm_enable=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Node AAA provider vIDM properties

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • client_id (str) – vIDM client id
    • +
  • client_secret (str or None) – vIDM client secret
    • +
  • host_name (str) – Fully Qualified Domain Name(FQDN) of vIDM
    • +
  • node_host_name (str) – host name to use when creating the redirect URL for clients to +follow after authenticating to vIDM
    • +
  • thumbprint (str) – Hexadecimal SHA256 hash of the vIDM server’s X.509 certificate
    • +
  • vidm_enable (bool or None) – vIDM enable flag
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NodeAuthProviderVidmStatus(runtime_state=None, vidm_enable=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Node AAA provider vIDM status

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • runtime_state (str) – AAA provider vIDM status
    • +
  • vidm_enable (bool) – vIDM enable flag
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NodeCapabilitiesResult(capabilities=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

List of capabilities of a fabric node

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:capabilities (list of NodeCapability) – Node capability results
+
+ +
+
+class com.vmware.nsx.model_client.NodeCapability(description=None, key=None, provider=None, value=None, version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Capability of a fabric node

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • description (str or None) – Description of this capability that can be displayed in UI +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • key (str or None) – String that identifies the base capability for all nodes +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • provider (str or None) – Provider of this capability for the node +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • value (str or None) – Value of this capability +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • version (long or None) – Version of the capability format: int32 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NodeFileSystemProperties(file_system=None, mount=None, total=None, type=None, used=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

File system properties

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • file_system (str or None) – File system id +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • mount (str or None) – File system mount +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • total (long or None) – File system size in kilobytes format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • type (str or None) – File system type +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • used (long or None) – Amount of file system used in kilobytes format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NodeHttpServiceProperties(links=None, schema=None, self_=None, service_name=None, service_properties=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Node HTTP service properties

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • service_name (str) – Service name
    • +
  • service_properties (HttpServiceProperties or None) – HTTP Service properties
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NodeIdServicesMap(node_id=None, service_types=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+SERVICE_TYPES_API = 'API'
+
+ +
+
+SERVICE_TYPES_MGMT_CLUSTER = 'MGMT_CLUSTER'
+
+ +
+
+SERVICE_TYPES_MGMT_PLANE = 'MGMT_PLANE'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.NodeInfo(links=None, schema=None, self_=None, component_version=None, display_name=None, id=None, type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • component_version (str or None) – Component version of the node +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • display_name (str or None) – Name of the node +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • id (str or None) – Identifier of the node +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • type (str or None) – Node type +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NodeInfoListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of NodeInfo) – Paged Collection of Nodes
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NodeInstallUpgradeServiceProperties(links=None, schema=None, self_=None, service_name=None, service_properties=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Node install-upgrade service properties

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • service_name (str) – Service name
    • +
  • service_properties (InstallUpgradeServiceProperties or None) – install-upgrade Service properties
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NodeInterfaceAlias(broadcast_address=None, ip_address=None, ip_configuration=None, netmask=None, physical_address=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Node network interface alias

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+IP_CONFIGURATION_DHCP = 'dhcp'
+
+ +
+
+IP_CONFIGURATION_NOT_CONFIGURED = 'not configured'
+
+ +
+
+IP_CONFIGURATION_STATIC = 'static'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.NodeInterfaceProperties(admin_status=None, connected_switch=None, ens_capable=None, ens_enabled=None, interface_alias=None, interface_id=None, interface_type=None, link_status=None, mtu=None, source=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Node network interface properties

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+ADMIN_STATUS_DOWN = 'DOWN'
+
+ +
+
+ADMIN_STATUS_UP = 'UP'
+
+ +
+
+INTERFACE_TYPE_PHYSICAL = 'PHYSICAL'
+
+ +
+
+INTERFACE_TYPE_VIRTUAL = 'VIRTUAL'
+
+ +
+ +
+ +
+ +
+ +
+
+SOURCE_CACHED = 'cached'
+
+ +
+
+SOURCE_REALTIME = 'realtime'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.NodeInterfacePropertiesListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Node network interface properties list results

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of NodeInterfaceProperties) – Node interface property results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NodeInterfaceStatisticsProperties(links=None, schema=None, self_=None, interface_id=None, rx_bytes=None, rx_dropped=None, rx_errors=None, rx_frame=None, rx_packets=None, source=None, tx_bytes=None, tx_carrier=None, tx_colls=None, tx_dropped=None, tx_errors=None, tx_packets=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Node network interface statistic properties

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • interface_id (str or None) – Interface ID
    • +
  • rx_bytes (long or None) – Number of bytes received format: int64
    • +
  • rx_dropped (long or None) – Number of packets dropped format: int64
    • +
  • rx_errors (long or None) – Number of receive errors format: int64
    • +
  • rx_frame (long or None) – Number of framing errors format: int64
    • +
  • rx_packets (long or None) – Number of packets received format: int64
    • +
  • source (str or None) –

    Possible values are:

    + +
    +
    Source of status data.
    +
    • +
  • tx_bytes (long or None) – Number of bytes transmitted format: int64
    • +
  • tx_carrier (long or None) – Number of carrier losses detected format: int64
    • +
  • tx_colls (long or None) – Number of collisions detected format: int64
    • +
  • tx_dropped (long or None) – Number of packets dropped format: int64
    • +
  • tx_errors (long or None) – Number of transmit errors format: int64
    • +
  • tx_packets (long or None) – Number of packets transmitted format: int64
    • +
+
+
+
+SOURCE_CACHED = 'cached'
+
+ +
+
+SOURCE_REALTIME = 'realtime'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.NodeListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Node list result

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of vmware.vapi.struct.VapiStruct) – Node list results +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in Node. +When methods return a value of this class as a return value, the +attribute will contain all the attributes defined in Node.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NodeLogProperties(links=None, schema=None, self_=None, last_modified_time=None, log_name=None, log_size=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Node log properties

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • last_modified_time (long or None) – Last modified time expressed in milliseconds since epoch format: +int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • log_name (str or None) – Name of log file +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • log_size (long or None) – Size of log file in bytes format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NodeLogPropertiesListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Node log property query results

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of NodeLogProperties) – Node log property results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NodeMode(mode_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Possible values of a mode in a "/config/nsx_appliance_mode" file

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:mode_id (str) –

Possible values are:

+ +

Possible enum values in a "/config/nsx_appliance_mode" file

+
+
+
+MODE_ID_ON_PREM = 'ON_PREM'
+
+ +
+
+MODE_ID_SERVICE = 'SERVICE'
+
+ +
+
+MODE_ID_VMC = 'VMC'
+
+ +
+
+MODE_ID_VMC_LOCAL = 'VMC_LOCAL'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.NodeNameServersProperties(links=None, schema=None, self_=None, name_servers=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Node network name servers properties

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • name_servers (list of str) – Name servers
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NodeNetworkInterfaceProperties(links=None, schema=None, self_=None, admin_status=None, bond_mode=None, bond_primary=None, bond_slaves=None, broadcast_address=None, default_gateway=None, interface_id=None, ip_addresses=None, ip_configuration=None, link_status=None, mtu=None, physical_address=None, plane=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Node network interface properties

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+ADMIN_STATUS_DOWN = 'down'
+
+ +
+
+ADMIN_STATUS_UP = 'up'
+
+ +
+
+BOND_MODE_802_3AD = '802_3AD'
+
+ +
+
+BOND_MODE_ACTIVE_BACKUP = 'ACTIVE_BACKUP'
+
+ +
+
+IP_CONFIGURATION_DHCP = 'dhcp'
+
+ +
+
+IP_CONFIGURATION_NOT_CONFIGURED = 'not configured'
+
+ +
+
+IP_CONFIGURATION_STATIC = 'static'
+
+ +
+ +
+ +
+ +
+ +
+
+PLANE_DEBUG = 'debug'
+
+ +
+
+PLANE_MGMT = 'mgmt'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.NodeNetworkInterfacePropertiesListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Node network interface properties list results

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of NodeNetworkInterfaceProperties) – Node network interface property results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NodeNetworkProperties(links=None, schema=None, self_=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Network configuration properties

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NodeNtpServiceProperties(links=None, schema=None, self_=None, service_name=None, service_properties=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Node NTP service properties

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • service_name (str) – Service name
    • +
  • service_properties (NtpServiceProperties or None) – NTP Service properties
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NodeProcessProperties(links=None, schema=None, self_=None, cpu_time=None, mem_resident=None, mem_used=None, pid=None, ppid=None, process_name=None, start_time=None, uptime=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Node process properties

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cpu_time (long or None) – CPU time (user and system) consumed by process in milliseconds +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • mem_resident (long or None) – Resident set size of process in bytes format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • mem_used (long or None) – Virtual memory used by process in bytes format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • pid (long or None) – Process id format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • ppid (long or None) – Parent process id format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • process_name (str or None) – Process name +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • start_time (long or None) – Process start time expressed in milliseconds since epoch format: +int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • uptime (long or None) – Milliseconds since process started format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NodeProcessPropertiesListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Node process property query results

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of NodeProcessProperties) – Node process property results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NodeProperties(links=None, schema=None, self_=None, bios_uuid=None, cli_timeout=None, export_type=None, hostname=None, kernel_version=None, node_uuid=None, node_version=None, product_version=None, system_time=None, timezone=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Node properties

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • bios_uuid (str or None) – Node BIOS Unique Indentifier +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • cli_timeout (long or None) – NSX CLI inactivity timeout, set to 0 to configure no timeout +format: int64
    • +
  • export_type (str or None) –

    Possible values are:

    + +
    +
    Export restrictions in effect, if any
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • hostname (str or None) – Host name or fully qualified domain name of node
    • +
  • kernel_version (str or None) – Kernel version +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • node_uuid (str or None) – Node Unique Identifier
    • +
  • node_version (str or None) – Node version +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • product_version (str or None) – Product version +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_time (long or None) – Current time expressed in milliseconds since epoch format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • timezone (str or None) – Timezone
    • +
+
+
+
+EXPORT_TYPE_RESTRICTED = 'RESTRICTED'
+
+ +
+
+EXPORT_TYPE_UNRESTRICTED = 'UNRESTRICTED'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.NodeProtonServiceProperties(links=None, schema=None, self_=None, service_name=None, service_properties=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Node service properties

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • service_name (str) – Service name
    • +
  • service_properties (ProtonServiceProperties or None) – Service properties
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NodeRouteProperties(links=None, schema=None, self_=None, destination=None, from_address=None, gateway=None, interface_id=None, metric=None, netmask=None, proto=None, route_id=None, route_type=None, scope=None, src=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Node network route properties

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+PROTO_BIRD = 'bird'
+
+ +
+
+PROTO_BOOT = 'boot'
+
+ +
+
+PROTO_DHCP = 'dhcp'
+
+ +
+
+PROTO_DNROUTED = 'dnrouted'
+
+ +
+
+PROTO_GATED = 'gated'
+
+ +
+
+PROTO_KERNEL = 'kernel'
+
+ +
+
+PROTO_MRT = 'mrt'
+
+ +
+
+PROTO_NTK = 'ntk'
+
+ +
+
+PROTO_RA = 'ra'
+
+ +
+
+PROTO_REDIRECT = 'redirect'
+
+ +
+
+PROTO_STATIC = 'static'
+
+ +
+
+PROTO_UNSPEC = 'unspec'
+
+ +
+
+PROTO_XORP = 'xorp'
+
+ +
+
+PROTO_ZEBRA = 'zebra'
+
+ +
+
+ROUTE_TYPE_BLACKHOLE = 'blackhole'
+
+ +
+
+ROUTE_TYPE_DEFAULT = 'default'
+
+ +
+
+ROUTE_TYPE_PROHIBIT = 'prohibit'
+
+ +
+
+ROUTE_TYPE_STATIC = 'static'
+
+ +
+
+ROUTE_TYPE_THROW = 'throw'
+
+ +
+
+ROUTE_TYPE_UNREACHABLE = 'unreachable'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.NodeRoutePropertiesListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Node network route properties list results

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of NodeRouteProperties) – Node route property results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NodeSearchDomainsProperties(links=None, schema=None, self_=None, search_domains=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Node network search domains properties

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • search_domains (list of str) – Search domains
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NodeServiceProperties(links=None, schema=None, self_=None, service_name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Node service properties

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • service_name (str) – Service name
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NodeServicePropertiesListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Node service property query results

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of NodeServiceProperties) – Node service property results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NodeServiceStatusProperties(links=None, schema=None, self_=None, monitor_pid=None, monitor_runtime_state=None, pids=None, runtime_state=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Node service status properties

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • monitor_pid (long or None) – Service monitor process id format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • monitor_runtime_state (str or None) –

    Possible values are:

    + +
    +
    Service monitor runtime state
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • pids (list of long or None) – Service process ids format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • runtime_state (str or None) –

    Possible values are:

    + +
    +
    Service runtime state
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
+
+
+
+MONITOR_RUNTIME_STATE_RUNNING = 'running'
+
+ +
+
+MONITOR_RUNTIME_STATE_STOPPED = 'stopped'
+
+ +
+
+RUNTIME_STATE_RUNNING = 'running'
+
+ +
+
+RUNTIME_STATE_STOPPED = 'stopped'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.NodeSnmpServiceProperties(links=None, schema=None, self_=None, service_name=None, service_properties=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Node SNMP service properties

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • service_name (str) – Service name
    • +
  • service_properties (SnmpServiceProperties) – SNMP Service properties
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NodeSshServiceProperties(links=None, schema=None, self_=None, service_name=None, service_properties=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Node SSH service properties

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • service_name (str) – Service name
    • +
  • service_properties (SshServiceProperties or None) – SSH Service properties
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NodeStatus(external_id=None, host_node_deployment_status=None, inventory_sync_paused=None, inventory_sync_reenable_time=None, last_heartbeat_timestamp=None, last_sync_time=None, lcp_connectivity_status=None, lcp_connectivity_status_details=None, maintenance_mode=None, mpa_connectivity_status=None, mpa_connectivity_status_details=None, software_version=None, system_status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Runtime status information of the fabric node.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+HOST_NODE_DEPLOYMENT_STATUS_EDGE_CONFIG_ERROR = 'EDGE_CONFIG_ERROR'
+
+ +
+
+HOST_NODE_DEPLOYMENT_STATUS_INSTALL_FAILED = 'INSTALL_FAILED'
+
+ +
+
+HOST_NODE_DEPLOYMENT_STATUS_INSTALL_IN_PROGRESS = 'INSTALL_IN_PROGRESS'
+
+ +
+
+HOST_NODE_DEPLOYMENT_STATUS_INSTALL_SUCCESSFUL = 'INSTALL_SUCCESSFUL'
+
+ +
+
+HOST_NODE_DEPLOYMENT_STATUS_NODE_NOT_READY = 'NODE_NOT_READY'
+
+ +
+
+HOST_NODE_DEPLOYMENT_STATUS_NODE_READY = 'NODE_READY'
+
+ +
+
+HOST_NODE_DEPLOYMENT_STATUS_NOT_AVAILABLE = 'NOT_AVAILABLE'
+
+ +
+
+HOST_NODE_DEPLOYMENT_STATUS_NOT_PREPARED = 'NOT_PREPARED'
+
+ +
+
+HOST_NODE_DEPLOYMENT_STATUS_PENDING_UPGRADE = 'PENDING_UPGRADE'
+
+ +
+
+HOST_NODE_DEPLOYMENT_STATUS_REGISTRATION_FAILED = 'REGISTRATION_FAILED'
+
+ +
+
+HOST_NODE_DEPLOYMENT_STATUS_REGISTRATION_PENDING = 'REGISTRATION_PENDING'
+
+ +
+
+HOST_NODE_DEPLOYMENT_STATUS_UNINSTALL_FAILED = 'UNINSTALL_FAILED'
+
+ +
+
+HOST_NODE_DEPLOYMENT_STATUS_UNINSTALL_IN_PROGRESS = 'UNINSTALL_IN_PROGRESS'
+
+ +
+
+HOST_NODE_DEPLOYMENT_STATUS_UNINSTALL_SUCCESSFUL = 'UNINSTALL_SUCCESSFUL'
+
+ +
+
+HOST_NODE_DEPLOYMENT_STATUS_UPGRADE_FAILED = 'UPGRADE_FAILED'
+
+ +
+
+HOST_NODE_DEPLOYMENT_STATUS_UPGRADE_IN_PROGRESS = 'UPGRADE_IN_PROGRESS'
+
+ +
+
+HOST_NODE_DEPLOYMENT_STATUS_VM_DEPLOYMENT_FAILED = 'VM_DEPLOYMENT_FAILED'
+
+ +
+
+HOST_NODE_DEPLOYMENT_STATUS_VM_DEPLOYMENT_IN_PROGRESS = 'VM_DEPLOYMENT_IN_PROGRESS'
+
+ +
+
+HOST_NODE_DEPLOYMENT_STATUS_VM_DEPLOYMENT_QUEUED = 'VM_DEPLOYMENT_QUEUED'
+
+ +
+
+HOST_NODE_DEPLOYMENT_STATUS_VM_DEPLOYMENT_RESTARTED = 'VM_DEPLOYMENT_RESTARTED'
+
+ +
+
+HOST_NODE_DEPLOYMENT_STATUS_VM_POWER_OFF_FAILED = 'VM_POWER_OFF_FAILED'
+
+ +
+
+HOST_NODE_DEPLOYMENT_STATUS_VM_POWER_OFF_IN_PROGRESS = 'VM_POWER_OFF_IN_PROGRESS'
+
+ +
+
+HOST_NODE_DEPLOYMENT_STATUS_VM_POWER_ON_FAILED = 'VM_POWER_ON_FAILED'
+
+ +
+
+HOST_NODE_DEPLOYMENT_STATUS_VM_POWER_ON_IN_PROGRESS = 'VM_POWER_ON_IN_PROGRESS'
+
+ +
+
+HOST_NODE_DEPLOYMENT_STATUS_VM_UNDEPLOY_FAILED = 'VM_UNDEPLOY_FAILED'
+
+ +
+
+HOST_NODE_DEPLOYMENT_STATUS_VM_UNDEPLOY_IN_PROGRESS = 'VM_UNDEPLOY_IN_PROGRESS'
+
+ +
+
+HOST_NODE_DEPLOYMENT_STATUS_VM_UNDEPLOY_SUCCESSFUL = 'VM_UNDEPLOY_SUCCESSFUL'
+
+ +
+
+LCP_CONNECTIVITY_STATUS_DEGRADED = 'DEGRADED'
+
+ +
+
+LCP_CONNECTIVITY_STATUS_DOWN = 'DOWN'
+
+ +
+
+LCP_CONNECTIVITY_STATUS_UNKNOWN = 'UNKNOWN'
+
+ +
+
+LCP_CONNECTIVITY_STATUS_UP = 'UP'
+
+ +
+
+MAINTENANCE_MODE_ENTERING = 'ENTERING'
+
+ +
+
+MAINTENANCE_MODE_EXITING = 'EXITING'
+
+ +
+
+MAINTENANCE_MODE_OFF = 'OFF'
+
+ +
+
+MAINTENANCE_MODE_ON = 'ON'
+
+ +
+
+MPA_CONNECTIVITY_STATUS_DOWN = 'DOWN'
+
+ +
+
+MPA_CONNECTIVITY_STATUS_UNKNOWN = 'UNKNOWN'
+
+ +
+
+MPA_CONNECTIVITY_STATUS_UP = 'UP'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.NodeStatusListResult(results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Node Status list result

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:results (list of NodeStatus) – Node Status list results
+
+ +
+
+class com.vmware.nsx.model_client.NodeStatusProperties(links=None, schema=None, self_=None, cpu_cores=None, file_systems=None, load_average=None, mem_cache=None, mem_total=None, mem_used=None, source=None, swap_total=None, swap_used=None, system_time=None, uptime=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Node status properties

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cpu_cores (long or None) – Number of CPU cores on the system format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • file_systems (list of NodeFileSystemProperties or None) – File systems configured on the system +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • load_average (list of float or None) – One, five, and fifteen minute load averages for the system +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • mem_cache (long or None) – Amount of RAM on the system that can be flushed out to disk, in +kilobytes format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • mem_total (long or None) – Amount of RAM allocated to the system, in kilobytes format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • mem_used (long or None) – Amount of RAM in use on the system, in kilobytes format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • source (str or None) –

    Possible values are:

    + +
    +
    Source of status data.
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • swap_total (long or None) – Amount of disk available for swap, in kilobytes format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • swap_used (long or None) – Amount of swap disk in use, in kilobytes format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_time (long or None) – Current time expressed in milliseconds since epoch format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • uptime (long or None) – Milliseconds since system start format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+
+SOURCE_CACHED = 'cached'
+
+ +
+
+SOURCE_REALTIME = 'realtime'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.NodeSummary(links=None, schema=None, self_=None, component_version=None, node_count=None, type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • component_version (str or None) – Component version +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • node_count (long or None) – Number of nodes of the type and at the component version format: +int32 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • type (str or None) – Node type +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NodeSummaryList(results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:results (list of NodeSummary) – List of Node Summary
+
+ +
+
+class com.vmware.nsx.model_client.NodeSyslogExporterProperties(links=None, schema=None, self_=None, exporter_name=None, facilities=None, level=None, msgids=None, port=None, protocol=None, server=None, structured_data=None, tls_ca_pem=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Node syslog exporter properties

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+FACILITIES_AUTH = 'AUTH'
+
+ +
+
+FACILITIES_AUTHPRIV = 'AUTHPRIV'
+
+ +
+
+FACILITIES_CRON = 'CRON'
+
+ +
+
+FACILITIES_DAEMON = 'DAEMON'
+
+ +
+
+FACILITIES_FTP = 'FTP'
+
+ +
+
+FACILITIES_KERN = 'KERN'
+
+ +
+
+FACILITIES_LOCAL0 = 'LOCAL0'
+
+ +
+
+FACILITIES_LOCAL1 = 'LOCAL1'
+
+ +
+
+FACILITIES_LOCAL2 = 'LOCAL2'
+
+ +
+
+FACILITIES_LOCAL3 = 'LOCAL3'
+
+ +
+
+FACILITIES_LOCAL4 = 'LOCAL4'
+
+ +
+
+FACILITIES_LOCAL5 = 'LOCAL5'
+
+ +
+
+FACILITIES_LOCAL6 = 'LOCAL6'
+
+ +
+
+FACILITIES_LOCAL7 = 'LOCAL7'
+
+ +
+
+FACILITIES_LOGALERT = 'LOGALERT'
+
+ +
+
+FACILITIES_LPR = 'LPR'
+
+ +
+
+FACILITIES_MAIL = 'MAIL'
+
+ +
+
+FACILITIES_NEWS = 'NEWS'
+
+ +
+
+FACILITIES_SYSLOG = 'SYSLOG'
+
+ +
+
+FACILITIES_USER = 'USER'
+
+ +
+
+FACILITIES_UUCP = 'UUCP'
+
+ +
+
+LEVEL_ALERT = 'ALERT'
+
+ +
+
+LEVEL_CRIT = 'CRIT'
+
+ +
+
+LEVEL_DEBUG = 'DEBUG'
+
+ +
+
+LEVEL_EMERG = 'EMERG'
+
+ +
+
+LEVEL_ERR = 'ERR'
+
+ +
+
+LEVEL_INFO = 'INFO'
+
+ +
+
+LEVEL_NOTICE = 'NOTICE'
+
+ +
+
+LEVEL_WARNING = 'WARNING'
+
+ +
+
+PROTOCOL_LI = 'LI'
+
+ +
+
+PROTOCOL_LI_TLS = 'LI-TLS'
+
+ +
+
+PROTOCOL_TCP = 'TCP'
+
+ +
+
+PROTOCOL_TLS = 'TLS'
+
+ +
+
+PROTOCOL_UDP = 'UDP'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.NodeSyslogExporterPropertiesListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Node syslog exporter list results

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of NodeSyslogExporterProperties) – Node syslog exporter results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NodeUserProperties(links=None, schema=None, self_=None, full_name=None, old_password=None, password=None, userid=None, username=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Node user properties

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • full_name (str or None) – Full name for the user
    • +
  • old_password (str or None) – Old password for the user (required on PUT if password specified)
    • +
  • password (str or None) – Password for the user (optionally specified on PUT, unspecified on +GET)
    • +
  • userid (long or None) – Numeric id for the user format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • username (str or None) – User login name (must be "root" if userid is 0)
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NodeUserPropertiesListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Node users list results

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of NodeUserProperties) – List of node users
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NodeUserSettings(audit_password=None, audit_username=None, cli_password=None, cli_username=None, root_password=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • audit_password (str or None) – Password for the node audit user. For deployment, this property is +required. After deployment, this property is ignored, and the node +cli must be used to change the password. The password specified +must be at least 8 characters in length and must contain at least +one lowercase, one uppercase, one numeric character and one special +character (except quotes).
    • +
  • audit_username (str or None) – The default username is "audit". To configure username, you +must provide this property together with audit_password.
    • +
  • cli_password (str or None) – Password for the node cli user. For deployment, this property is +required. After deployment, this property is ignored, and the node +cli must be used to change the password. The password specified +must be at least 8 characters in length and must contain at least +one lowercase, one uppercase, one numeric character and one special +character (except quotes).
    • +
  • cli_username (str or None) – To configure username, you must provide this property together with +cli_password.
    • +
  • root_password (str or None) – Password for the node root user. For deployment, this property is +required. After deployment, this property is ignored, and the node +cli must be used to change the password. The password specified +must be at least 8 characters in length and must contain at least +one lowercase, one uppercase, one numeric character and one special +character (except quotes).
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NodeVersion(node_version=None, product_version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • node_version (str or None) – Node version +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • product_version (str or None) – Product version +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NormalizedResourceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Paged Collection of normalized resources

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of ResourceReference) – Normalized resource list results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.NsxRole(permissions=None, role=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Role

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+PERMISSIONS_CRUD = 'crud'
+
+ +
+
+PERMISSIONS_EXECUTE = 'execute'
+
+ +
+
+PERMISSIONS_NONE = 'none'
+
+ +
+
+PERMISSIONS_READ = 'read'
+
+ +
+
+PERMISSIONS_READ_API = 'read-api'
+
+ +
+
+PERMISSIONS_READ_WRITE_API = 'read-write-api'
+
+ +
+
+ROLE_AUDITOR = 'auditor'
+
+ +
+
+ROLE_CLOUD_ADMIN = 'cloud_admin'
+
+ +
+
+ROLE_CLOUD_AUDITOR = 'cloud_auditor'
+
+ +
+
+ROLE_CLOUD_SERVICE_ADMIN = 'cloud_service_admin'
+
+ +
+
+ROLE_CLOUD_SERVICE_AUDITOR = 'cloud_service_auditor'
+
+ +
+
+ROLE_ENTERPRISE_ADMIN = 'enterprise_admin'
+
+ +
+
+ROLE_LB_ADMIN = 'lb_admin'
+
+ +
+
+ROLE_LB_AUDITOR = 'lb_auditor'
+
+ +
+
+ROLE_NETWORK_ENGINEER = 'network_engineer'
+
+ +
+
+ROLE_NETWORK_OP = 'network_op'
+
+ +
+
+ROLE_READ_ONLY_API_USERS = 'read_only_api_users'
+
+ +
+
+ROLE_READ_WRITE_API_USERS = 'read_write_api_users'
+
+ +
+
+ROLE_SECURITY_ENGINEER = 'security_engineer'
+
+ +
+
+ROLE_SECURITY_OP = 'security_op'
+
+ +
+
+ROLE_SITE_RELIABILITY_AUDITOR = 'site_reliability_auditor'
+
+ +
+
+ROLE_SITE_RELIABILITY_ENGINEER = 'site_reliability_engineer'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.NtpServiceProperties(servers=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

NTP Service properties

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:servers (list of str) – NTP servers format: hostname-or-ipv4
+
+ +
+
+class com.vmware.nsx.model_client.Oauth2Credentials(client_id=None, client_secret=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Oauth2 Account Credentials

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • client_id (str) – Client ID, that will be used for authentication in AWS environment,
    • +
  • client_secret (str or None) – Client secret, that will be used for authentication in AWS +environment. Can be some passphrase.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.OrgInfo(org_id=None, org_role=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Organization ID and role, predefined for a particular type of VMware +support.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • org_id (str) – Organization ID, connected to a predefined role of a VMware +support.
    • +
  • org_role (str) – Predefined role of a VMware support.
    • +
+
+
+ +
+ +

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The server will populate this field when returing the resource. Ignored on +PUT and POST.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • action (str or None) – Optional action +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • href (str or None) – Link to resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • rel (str or None) – Custom relation type (follows RFC 5988 where appropriate +definitions exist) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.PBRInsertParameters(id=None, operation=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Parameters that indicate where rule/section need to be added All the params +take rule/section Id

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+OPERATION_AFTER = 'insert_after'
+
+ +
+
+OPERATION_BEFORE = 'insert_before'
+
+ +
+
+OPERATION_BOTTOM = 'insert_bottom'
+
+ +
+
+OPERATION_TOP = 'insert_top'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.PBRRule(links=None, schema=None, self_=None, revision=None, owner=None, description=None, display_name=None, id=None, resource_type=None, action=None, applied_tos=None, destinations=None, disabled=None, logged=None, notes=None, rule_tag=None, services=None, sources=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • owner (OwnerResourceLink or None) – Owner of this resource
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Identifier of the resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • action (str) –

    Possible values are:

    + +
    +
    Action enforced on the packets which matches the PBR rule.
    +
    • +
  • applied_tos (list of ResourceReference or None) – List of object where rule will be enforced. field overrides this +one. Null will be treated as any.
    • +
  • destinations (list of ResourceReference or None) – List of the destinations. Null will be treated as any.
    • +
  • disabled (bool or None) – Flag to disable rule. Disabled will only be persisted but never +provisioned/realized.
    • +
  • logged (bool or None) – Flag to enable packet logging. Default is disabled.
    • +
  • notes (str or None) – User notes specific to the rule.
    • +
  • rule_tag (str or None) – User level field which will be printed in CLI and packet logs.
    • +
  • services (list of PBRService or None) – List of the services. Null will be treated as any.
    • +
  • sources (list of ResourceReference or None) – List of sources. Null will be treated as any.
    • +
+
+
+
+ACTION_OVERLAY = 'ROUTE_TO_OVERLAY'
+
+ +
+
+ACTION_OVERLAY_NAT = 'ROUTE_TO_OVERLAY_NAT'
+
+ +
+
+ACTION_UNDERLAY = 'ROUTE_TO_UNDERLAY'
+
+ +
+
+ACTION_UNDERLAY_NAT = 'ROUTE_TO_UNDERLAY_NAT'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.PBRRuleListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of PBRRule or None) – PBR rule list result with pagination support. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.PBRSection(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, rule_count=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • rule_count (long or None) – Number of rules in this section. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.PBRSectionListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of PBRSection or None) – List of the PBR sections. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.PBRSectionQueryParameters(cascade=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Section query parameters

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:cascade (bool or None) – Flag to cascade delete of this object to all it’s child objects.
+
+ +
+
+class com.vmware.nsx.model_client.PBRSectionRuleList(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, rule_count=None, rules=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • rule_count (long or None) – Number of rules in this section. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • rules (list of PBRRule) – List of PBR rules in the section.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.PBRService(is_valid=None, target_display_name=None, target_id=None, target_type=None, service=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Type to define services associated with every rule

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • is_valid (bool or None) – Will be set to false if the referenced NSX resource has been +deleted. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • target_display_name (str or None) – Display name of the NSX resource. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • target_id (str or None) – Identifier of the NSX resource.
    • +
  • target_type (str or None) – Type of the NSX resource.
    • +
  • service (vmware.vapi.struct.VapiStruct or None) – Distributed Service API accepts raw protocol and ports as part of +NS service element in Distributed Service Rule that describes +traffic corresponding to an NSService. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +NSServiceElement. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in NSServiceElement.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.PackageStore(bulletin_ids=None, package_url=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Contains package information

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • bulletin_ids (list of str) – List of bulletin ids
    • +
  • package_url (str) – url of the package
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.PacketAddressClassifier(ip_address=None, mac_address=None, vlan=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

A packet is classified to have an address binding, if its address +configuration matches with all user specified properties.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • ip_address (str or None) – A single IP address or a subnet, e.g. x.x.x.x or x.x.x.x/y format: +address-or-block-or-range
    • +
  • mac_address (str or None) – A single MAC address
    • +
  • vlan (long or None) – Virtual Local Area Network Identifier format: int64
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.PacketCaptureOption(name=None, value=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The option is used to filter data on given node.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+NAME_DSTIP = 'DSTIP'
+
+ +
+
+NAME_DSTMAC = 'DSTMAC'
+
+ +
+
+NAME_DSTPORT = 'DSTPORT'
+
+ +
+
+NAME_ETHTYPE = 'ETHTYPE'
+
+ +
+
+NAME_IP = 'IP'
+
+ +
+
+NAME_IPPROTO = 'IPPROTO'
+
+ +
+
+NAME_MAC = 'MAC'
+
+ +
+
+NAME_PORT = 'PORT'
+
+ +
+
+NAME_SRCIP = 'SRCIP'
+
+ +
+
+NAME_SRCMAC = 'SRCMAC'
+
+ +
+
+NAME_SRCPORT = 'SRCPORT'
+
+ +
+
+NAME_VLAN = 'VLAN'
+
+ +
+
+NAME_VNI = 'VNI'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.PacketCaptureOptionList(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, values=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

List of packet capture options to filter data in capture process.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • values (list of PacketCaptureOption or None) – Packet capture option collection
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.PacketCaptureRequest(capamount=None, capduration=None, capfilesize=None, capmode=None, cappoint=None, caprate=None, capsource=None, capvalue=None, direction=None, filtertype=None, node=None, options=None, streamaddress=None, streamport=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This type is used to create packet request on give node. Need to specify +related parameters according to the capture point.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+CAPMODE_STANDALONE = 'STANDALONE'
+
+ +
+
+CAPMODE_STREAM = 'STREAM'
+
+ +
+
+CAPPOINT_DVFILTER = 'DVFILTER'
+
+ +
+
+CAPPOINT_LOGICALPORT = 'LOGICALPORT'
+
+ +
+
+CAPPOINT_VDRPORT = 'VDRPORT'
+
+ +
+
+CAPPOINT_VIF = 'VIF'
+
+ +
+
+CAPPOINT_VMKNIC = 'VMKNIC'
+
+ +
+
+CAPPOINT_VMNIC = 'VMNIC'
+
+ +
+
+CAPPOINT_VNIC = 'VNIC'
+
+ +
+
+CAPSOURCE_CLI = 'CLI'
+
+ +
+
+CAPSOURCE_UI = 'UI'
+
+ +
+
+DIRECTION_DUAL = 'DUAL'
+
+ +
+
+DIRECTION_INPUT = 'INPUT'
+
+ +
+
+DIRECTION_OUTPUT = 'OUTPUT'
+
+ +
+
+FILTERTYPE_POST = 'POST'
+
+ +
+
+FILTERTYPE_PRE = 'PRE'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.PacketCaptureSession(endtime=None, errormsg=None, filelocation=None, filesize=None, request=None, sessionid=None, sessionname=None, sessionstatus=None, starttime=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Packet capture response information

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+SESSIONSTATUS_CREATED = 'CREATED'
+
+ +
+
+SESSIONSTATUS_ERROR = 'ERROR'
+
+ +
+
+SESSIONSTATUS_FINISHED = 'FINISHED'
+
+ +
+
+SESSIONSTATUS_STARTED = 'STARTED'
+
+ +
+
+SESSIONSTATUS_STOPPED = 'STOPPED'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.PacketCaptureSessionList(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long) – Total capture session count format: int64
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of PacketCaptureSession or None) – Packet capture list for all sessoins
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.PacketData(frame_size=None, resource_type=None, routed=None, transport_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+RESOURCE_TYPE_BINARYPACKETDATA = 'BinaryPacketData'
+
+ +
+
+RESOURCE_TYPE_FIELDSPACKETDATA = 'FieldsPacketData'
+
+ +
+
+TRANSPORT_TYPE_BROADCAST = 'BROADCAST'
+
+ +
+
+TRANSPORT_TYPE_MULTICAST = 'MULTICAST'
+
+ +
+
+TRANSPORT_TYPE_UNICAST = 'UNICAST'
+
+ +
+
+TRANSPORT_TYPE_UNKNOWN = 'UNKNOWN'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.PacketTypeAndCounter(counter=None, packet_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • counter (long) – The number of packets. format: int64
    • +
  • packet_type (str) – The type of the packets
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.PacketsDroppedBySecurity(bpdu_filter_dropped=None, dhcp_client_dropped_ipv4=None, dhcp_client_dropped_ipv6=None, dhcp_server_dropped_ipv4=None, dhcp_server_dropped_ipv6=None, spoof_guard_dropped=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • bpdu_filter_dropped (long or None) – The number of packets dropped by "BPDU filter". format: +int64
    • +
  • dhcp_client_dropped_ipv4 (long or None) – The number of IPv4 packets dropped by "DHCP client block". +format: int64
    • +
  • dhcp_client_dropped_ipv6 (long or None) – The number of IPv6 packets dropped by "DHCP client block". +format: int64
    • +
  • dhcp_server_dropped_ipv4 (long or None) – The number of IPv4 packets dropped by "DHCP server block". +format: int64
    • +
  • dhcp_server_dropped_ipv6 (long or None) – The number of IPv6 packets dropped by "DHCP server block". +format: int64
    • +
  • spoof_guard_dropped (list of PacketTypeAndCounter or None) – The packets dropped by "Spoof Guard"; supported packet +types are IPv4, IPv6, ARP, ND, non-IP.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.PasswordAuthenticationScheme(scheme_name=None, password=None, username=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+SCHEME_NAME_PASSWORD = 'password'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.PerStepRestoreStatus(description=None, value=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Restore step status

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+VALUE_FAILED = 'FAILED'
+
+ +
+
+VALUE_INITIAL = 'INITIAL'
+
+ +
+
+VALUE_RUNNING = 'RUNNING'
+
+ +
+
+VALUE_SUCCESS = 'SUCCESS'
+
+ +
+
+VALUE_SUSPENDED_BY_USER = 'SUSPENDED_BY_USER'
+
+ +
+
+VALUE_SUSPENDED_FOR_USER_ACTION = 'SUSPENDED_FOR_USER_ACTION'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.Pnic(device_name=None, uplink_name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Physical NIC specification

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • device_name (str) – device name or key
    • +
  • uplink_name (str) – Uplink name for this Pnic. This name will be used to reference this +Pnic in other configurations.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.PnicBondStatus(name=None, status=None, type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

pNIC/bond statuses

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+
+STATUS_DEGRADED = 'DEGRADED'
+
+ +
+
+STATUS_DOWN = 'DOWN'
+
+ +
+
+STATUS_UNKNOWN = 'UNKNOWN'
+
+ +
+
+STATUS_UP = 'UP'
+
+ +
+
+TYPE_BOND = 'BOND'
+
+ +
+
+TYPE_PNIC = 'PNIC'
+
+ +
+
+TYPE_UNKNOWN_TYPE = 'UNKNOWN_TYPE'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.PnicBondStatusListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This object contains reference to list of pNIC/bond statuses

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of PnicBondStatus or None) – List of pNIC statuses belonging to the transport node
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.PnicMirrorDestination(dest_pnics=None, node_id=None, resource_type='PnicMirrorDestination')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+ +
+
+class com.vmware.nsx.model_client.PnicMirrorSource(encapsulated=None, node_id=None, source_pnics=None, resource_type='PnicMirrorSource')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+ +
+
+class com.vmware.nsx.model_client.PolicyBasedIPSecVPNSession(policy_rules=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='PolicyBasedIPSecVPNSession', tags=None, enabled=None, ipsec_vpn_service_id=None, local_endpoint_id=None, peer_endpoint_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

A Policy Based VPN requires to define protect rules that match local and +peer subnets. IPSec security associations is negotiated for each pair of +local and peer subnet.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • policy_rules (list of IPSecVPNPolicyRule) – Policy rules
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +

    A Policy Based VPN requires to define protect rules that match +local and peer subnets. IPSec security associations is negotiated +for each pair of local and peer subnet. A Route Based VPN is more +flexible, more powerful and recommended over policy based VPN. IP +Tunnel port is created and all traffic routed via tunnel port is +protected. Routes can be configured statically or can be learned +through BGP. A route based VPN is must for establishing redundant +VPN session to remote site.

    +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • enabled (bool or None) – Enable/Disable IPSec VPN session.
    • +
  • ipsec_vpn_service_id (str or None) – Identifier of VPN Service linked with local endpoint. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • local_endpoint_id (str) – Local endpoint identifier.
    • +
  • peer_endpoint_id (str) – Peer endpoint identifier.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.PoolMember(admin_state=None, backup_member=None, display_name=None, ip_address=None, max_concurrent_connections=None, port=None, weight=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • admin_state (str or None) –

    Possible values are:

    + +
    +
    member admin state
    +
    • +
  • backup_member (bool or None) – Backup servers are typically configured with a sorry page +indicating to the user that the application is currently +unavailable. While the pool is active (a specified minimum number +of pool members are active) BACKUP members are skipped during +server selection. When the pool is inactive, incoming connections +are sent to only the BACKUP member(s).
    • +
  • display_name (str or None) – pool member name
    • +
  • ip_address (str) – pool member IP address format: ip
    • +
  • max_concurrent_connections (long or None) – To ensure members are not overloaded, connections to a member can +be capped by the load balancer. When a member reaches this limit, +it is skipped during server selection. If it is not specified, it +means that connections are unlimited. format: int64
    • +
  • port (str or None) – If port is specified, all connections will be sent to this port. +Only single port is supported. If unset, the same port the client +connected to will be used, it could be overrode by +default_pool_member_port setting in virtual server. The port should +not specified for port range case. format: port-or-range
    • +
  • weight (long or None) – Pool member weight is used for WEIGHTED_ROUND_ROBIN balancing +algorithm. The weight value would be ignored in other algorithms. +format: int64
    • +
+
+
+
+ADMIN_STATE_DISABLED = 'DISABLED'
+
+ +
+
+ADMIN_STATE_ENABLED = 'ENABLED'
+
+ +
+
+ADMIN_STATE_GRACEFUL_DISABLED = 'GRACEFUL_DISABLED'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.PoolMemberGroup(customized_members=None, grouping_object=None, ip_revision_filter=None, max_ip_list_size=None, port=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • customized_members (list of PoolMemberSetting or None) – The list is used to show the customized pool member settings. User +can only user pool member action API to update the admin state for +a specific IP address.
    • +
  • grouping_object (ResourceReference) – Load balancer pool support grouping object as dynamic pool members. +The IP list of the grouping object such as NSGroup would be used as +pool member IP setting.
    • +
  • ip_revision_filter (str or None) –

    Possible values are:

    + +

    Ip revision filter is used to filter IPv4 or IPv6 addresses from +the grouping object. If the filter is not specified, both IPv4 and +IPv6 addresses would be used as server IPs. The link local and +loopback addresses would be always filtered out.

    +
    • +
  • max_ip_list_size (long or None) – The size is used to define the maximum number of grouping object IP +address list. These IP addresses would be used as pool members. If +the grouping object includes more than certain number of IP +addresses, the redundant parts would be ignored and those IP +addresses would not be treated as pool members. If the size is not +specified, one member is budgeted for this dynamic pool so that the +pool has at least one member even if some other dynamic pools grow +beyond the capacity of load balancer service. Other members are +picked according to available dynamic capacity. The unused members +would be set to DISABLED so that the load balancer system itself is +not overloaded during runtime. format: int64
    • +
  • port (long or None) – If port is specified, all connections will be sent to this port. If +unset, the same port the client connected to will be used, it could +be overridden by default_pool_member_ports setting in virtual +server. The port should not specified for multiple ports case. +format: int32
    • +
+
+
+
+IP_REVISION_FILTER_IPV4 = 'IPV4'
+
+ +
+
+IP_REVISION_FILTER_IPV4_IPV6 = 'IPV4_IPV6'
+
+ +
+
+IP_REVISION_FILTER_IPV6 = 'IPV6'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.PoolMemberSetting(admin_state=None, display_name=None, ip_address=None, port=None, weight=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The setting is used to add, update or remove pool members from pool. For +static pool members, admin_state, display_name and weight can be updated. +For dynamic pool members, only admin_state can be updated.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • admin_state (str or None) –

    Possible values are:

    + +
    +
    Member admin state
    +
    • +
  • display_name (str or None) – Only applicable to static pool members. If supplied for a pool +defined by a grouping object, update API would fail.
    • +
  • ip_address (str) – Pool member IP address format: ip
    • +
  • port (str or None) – Pool member port number format: port-or-range
    • +
  • weight (long or None) – Only applicable to static pool members. If supplied for a pool +defined by a grouping object, update API would fail. format: int64
    • +
+
+
+
+ADMIN_STATE_DISABLED = 'DISABLED'
+
+ +
+
+ADMIN_STATE_ENABLED = 'ENABLED'
+
+ +
+
+ADMIN_STATE_GRACEFUL_DISABLED = 'GRACEFUL_DISABLED'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.PoolMemberSettingList(members=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

List of PoolMemberSetting

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:members (list of PoolMemberSetting) – List of pool member settings to be passed to add, update and remove +APIs
+
+ +
+
+class com.vmware.nsx.model_client.PoolUsage(allocated_ids=None, free_ids=None, total_ids=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Pool usage statistics in a pool.

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • allocated_ids (long or None) – Total number of allocated IDs in a pool format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • free_ids (long or None) – Total number of free IDs in a pool format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • total_ids (long or None) – Total number of IDs in a pool format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.PortConnectionBMEntities(dst_port=None, src_port=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Port Connection Bare Metal Entities

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+ +
+
+class com.vmware.nsx.model_client.PortConnectionContainersEntities(logical_ports=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Port Connection Containers Entities

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:logical_ports (list of LogicalPort or None) –
+
+ +
+
+class com.vmware.nsx.model_client.PortConnectionEdgeNodeGroup(id=None, resource=None, edge_nodes=None, logical_router_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Collection of edge nodes backing a logical router

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • id (str or None) – Resource ID is mapped to this. (ID is Generated for Edge node +groups, since resource will be null) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource (ManagedResource or None) – Resource reference with details of the entity
    • +
  • edge_nodes (list of TransportNode or None) –
    • +
  • logical_router_id (str) – Id of the logical router
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.PortConnectionEntities(containers=None, edge_node_groups=None, errors=None, hypervisors=None, logical_switches=None, physical_hosts=None, routers=None, tunnels=None, vms=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Port Connection Entities (to help draw a visual picture of entities between +two ports)

+
+

Tip

+

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

+
+ +++ + + + +
Parameters: +
+
+ +
+
+class com.vmware.nsx.model_client.PortConnectionEntity(id=None, resource=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Port Connection Entity

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • id (str or None) – Resource ID is mapped to this. (ID is Generated for Edge node +groups, since resource will be null) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource (ManagedResource or None) – Resource reference with details of the entity
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.PortConnectionError(entity_type=None, error_details=None, error_summary=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Errors encountered while fetching entities in the forwarding path

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • entity_type (str or None) –
    • +
  • error_details (vmware.vapi.struct.VapiStruct or None) –
    • +
  • error_summary (str or None) –
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.PortConnectionHypervisor(id=None, resource=None, neighbors_list=None, pnics=None, pnics_list=None, profiles=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Port Connection Hypervisor/Transport Node Entity

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • id (str or None) – Resource ID is mapped to this. (ID is Generated for Edge node +groups, since resource will be null) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource (ManagedResource or None) – Resource reference with details of the entity
    • +
  • neighbors_list (list of InterfaceNeighborProperties or None) –
    • +
  • pnics (list of Pnic or None) –
    • +
  • pnics_list (list of NodeInterfaceProperties or None) –
    • +
  • profiles (list of vmware.vapi.struct.VapiStruct or None) – When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +BaseHostSwitchProfile. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in BaseHostSwitchProfile.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.PortConnectionLogicalSwitch(id=None, resource=None, router_ports=None, vm_ports=None, vm_ports_states=None, vm_vnics=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Port Connection Logical Switch Entity

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • id (str or None) – Resource ID is mapped to this. (ID is Generated for Edge node +groups, since resource will be null) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource (ManagedResource or None) – Resource reference with details of the entity
    • +
  • router_ports (list of LogicalPort or None) – Logical Ports that are attached to a router +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • vm_ports (list of LogicalPort or None) – Logical Ports that are attached to a VIF/VM +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • vm_ports_states (list of LogicalPortState or None) – States of Logical Ports that are attached to a VIF/VM +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • vm_vnics (list of VirtualNetworkInterface or None) – Virutal Network Interfaces that are attached to the Logical Ports +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.PortConnectionRouter(id=None, resource=None, downlink_ports=None, uplink_ports=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Port Connection Logical Router Entity

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • id (str or None) – Resource ID is mapped to this. (ID is Generated for Edge node +groups, since resource will be null) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource (ManagedResource or None) – Resource reference with details of the entity
    • +
  • downlink_ports (list of vmware.vapi.struct.VapiStruct or None) – Downlink ports of the Logical Router. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +LogicalRouterPort. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in LogicalRouterPort. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • uplink_ports (list of vmware.vapi.struct.VapiStruct or None) – Uplink ports of the Logical Router. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +LogicalRouterPort. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in LogicalRouterPort. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.PortConnectionTunnel(src_node_id=None, tunnel_properties=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Tunnel information between two given transport nodes

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • src_node_id (str) – Id of the source transport node
    • +
  • tunnel_properties (TunnelProperties) – Tunnel properties between the source and the destination transport +node
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.PortMirroringSession(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, direction=None, encapsulation_vlan_id=None, mirror_destination=None, mirror_sources=None, preserve_original_vlan=None, session_type=None, snap_length=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

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

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • direction (str) –

    Possible values are:

    + +
    +
    Port mirroring session direction
    +
    • +
  • encapsulation_vlan_id (long or None) – Only for Remote SPAN Port Mirror. format: int64
    • +
  • mirror_destination (vmware.vapi.struct.VapiStruct) – Mirror destination +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +MirrorDestination. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in MirrorDestination.
    • +
  • mirror_sources (list of vmware.vapi.struct.VapiStruct) – Mirror sources +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +MirrorSource. When methods return a value of this class as +a return value, the attribute will contain all the attributes +defined in MirrorSource.
    • +
  • preserve_original_vlan (bool or None) – Only for Remote SPAN Port Mirror. Whether to preserve original +VLAN.
    • +
  • session_type (str or None) –

    Possible values are:

    + +

    If this property is unset, this session will be treated as +LocalPortMirrorSession.

    +
    • +
  • snap_length (long or None) – If this property is set, the packet will be truncated to the +provided length. If this property is unset, entire packet will be +mirrored. format: int64
    • +
+
+
+
+DIRECTION_BIDIRECTIONAL = 'BIDIRECTIONAL'
+
+ +
+
+DIRECTION_EGRESS = 'EGRESS'
+
+ +
+
+DIRECTION_INGRESS = 'INGRESS'
+
+ +
+
+SESSION_TYPE_L3PORTMIRRORSESSION = 'L3PortMirrorSession'
+
+ +
+
+SESSION_TYPE_LOCALPORTMIRRORSESSION = 'LocalPortMirrorSession'
+
+ +
+
+SESSION_TYPE_LOGICALLOCALPORTMIRRORSESSION = 'LogicalLocalPortMirrorSession'
+
+ +
+
+SESSION_TYPE_LOGICALPORTMIRRORSESSION = 'LogicalPortMirrorSession'
+
+ +
+
+SESSION_TYPE_RSPANDSTMIRRORSESSION = 'RspanDstMirrorSession'
+
+ +
+
+SESSION_TYPE_RSPANSRCMIRRORSESSION = 'RspanSrcMirrorSession'
+
+ +
+
+SESSION_TYPE_UPLINKPORTMIRRORSESSION = 'UplinkPortMirrorSession'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.PortMirroringSessionListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Mirror session queries result

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of PortMirroringSession or None) – Port mirroring session results +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.PortMirroringSwitchingProfile(destinations=None, direction=None, key=None, snap_length=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='PortMirroringSwitchingProfile', tags=None, required_capabilities=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • destinations (list of str or None) – List of destination addresses format: ip
    • +
  • direction (str or None) –

    Possible values are:

    + +
    +
    port mirroring direction
    +
    • +
  • key (long or None) – User-configurable 32-bit key format: int64
    • +
  • snap_length (long or None) – If this property not set, original package will not be truncated. +format: int64
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • required_capabilities (list of str or None) –
    • +
+
+
+
+DIRECTION_BIDIRECTIONAL = 'BIDIRECTIONAL'
+
+ +
+
+DIRECTION_EGRESS = 'EGRESS'
+
+ +
+
+DIRECTION_INGRESS = 'INGRESS'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.PortStatus(enabled=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

indicates if the RabbitMQ management port is set or not

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:enabled (bool) – indicates if the RabbitMQ management port is set or not
+
+ +
+
+class com.vmware.nsx.model_client.PreconfiguredEndpoint(device_name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Tunnel endpoint configuration of preconfigured host switch

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:device_name (str) – Name of the virtual tunnel endpoint
+
+ +
+
+class com.vmware.nsx.model_client.PreconfiguredHostSwitch(endpoints=None, host_switch_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Preconfigured host switch is used for manually configured transport node.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • endpoints (list of PreconfiguredEndpoint or None) – List of virtual tunnel endpoints which are preconfigured on this +host switch
    • +
  • host_switch_id (str) – External Id of the preconfigured host switch.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.PreconfiguredHostSwitchSpec(host_switches=None, resource_type='PreconfiguredHostSwitchSpec')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Preconfigured host switch specification is used for manually configured +transport node. It is user’s responsibility to ensure correct configuration +is provided to NSX. This type is only valid for supported KVM fabric nodes.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters: +
+
+ +
+
+class com.vmware.nsx.model_client.PrefixConfig(action=None, ge=None, le=None, network=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • action (str) –

    Possible values are:

    + +
    +
    Action for the IPPrefix
    +
    • +
  • ge (long or None) – Greater than or equal to format: int64
    • +
  • le (long or None) – Less than or equal to format: int64
    • +
  • network (str or None) – If absent, the action applies to all addresses. format: +ipv4-cidr-block
    • +
+
+
+
+ACTION_DENY = 'DENY'
+
+ +
+
+ACTION_PERMIT = 'PERMIT'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.Principal(attributes=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:attributes (list of KeyValue) – Certificate list
+
+ +
+
+class com.vmware.nsx.model_client.PrincipalIdentity(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, certificate_id=None, is_protected=None, name=None, node_id=None, permission_group=None, role=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • certificate_id (str) – Id of the stored certificate
    • +
  • is_protected (bool or None) – Indicator whether the entities created by this principal should be +protected
    • +
  • name (str) – Name of the principal
    • +
  • node_id (str) – Unique node-id of a principal
    • +
  • permission_group (str or None) –

    Possible values are:

    + +

    Use the ‘role’ field instead and pass in ‘auditor’ for +read_only_api_users or ‘enterprise_admin’ for the others.

    +
    • +
  • role (str or None) – Role
    • +
+
+
+
+PERMISSION_GROUP_READ_ONLY_API_USERS = 'read_only_api_users'
+
+ +
+
+PERMISSION_GROUP_READ_WRITE_API_USERS = 'read_write_api_users'
+
+ +
+
+PERMISSION_GROUP_SUPERUSERS = 'superusers'
+
+ +
+
+PERMISSION_GROUP_UNDEFINED = 'undefined'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.PrincipalIdentityList(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

PrincipalIdentity query result

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of PrincipalIdentity) – PrincipalIdentity list
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.PropertyItem(condition=None, field=None, heading=None, label=None, render_configuration=None, type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Represents a label-value pair.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • condition (str or None) – If the condition is met then the property will be displayed. +Examples of expression syntax are provided under ‘example_request’ +section of ‘CreateWidgetConfiguration’ API.
    • +
  • field (str) – Represents field value of the property.
    • +
  • heading (bool or None) – Set to true if the field is a heading. Default is false.
    • +
  • label (Label or None) – If a field represents a heading, then label is not needed
    • +
  • render_configuration (list of RenderConfiguration or None) – Render configuration to be applied, if any.
    • +
  • type (str) –

    Possible values are:

    + +
    +
    Data type of the field.
    +
    • +
+
+
+
+TYPE_DATE = 'Date'
+
+ +
+
+TYPE_NUMBER = 'Number'
+
+ +
+
+TYPE_STRING = 'String'
+
+ +
+
+TYPE_URL = 'Url'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.Protocol(name='Protocol')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:name (str) –

Possible values are:

+ +
+
Protocol name
+
+
+
+NAME_HTTP = 'http'
+
+ +
+
+NAME_HTTPS = 'https'
+
+ +
+
+NAME_SCP = 'scp'
+
+ +
+
+NAME_SFTP = 'sftp'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.ProtocolVersion(enabled=None, name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

HTTP protocol version

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • enabled (bool) – Enable status for this protocol version
    • +
  • name (str) – Name of the TLS protocol version
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ProtonPackageLoggingLevels(logging_level=None, package_name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters: +
+
+
+LOGGING_LEVEL_DEBUG = 'DEBUG'
+
+ +
+
+LOGGING_LEVEL_ERROR = 'ERROR'
+
+ +
+
+LOGGING_LEVEL_INFO = 'INFO'
+
+ +
+
+LOGGING_LEVEL_TRACE = 'TRACE'
+
+ +
+
+LOGGING_LEVEL_WARN = 'WARN'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.ProtonServiceProperties(logging_level=None, package_logging_level=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Service properties

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters: +
+
+
+LOGGING_LEVEL_DEBUG = 'DEBUG'
+
+ +
+
+LOGGING_LEVEL_ERROR = 'ERROR'
+
+ +
+
+LOGGING_LEVEL_INFO = 'INFO'
+
+ +
+
+LOGGING_LEVEL_TRACE = 'TRACE'
+
+ +
+
+LOGGING_LEVEL_WARN = 'WARN'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.PublicCloudGatewayNode(allocation_list=None, deployment_config=None, deployment_type=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, discovered_ip_addresses=None, external_id=None, fqdn=None, ip_addresses=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • allocation_list (list of str or None) – List of logical router ids to which this edge node is allocated. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • deployment_config (EdgeNodeDeploymentConfig or None) – When this configuration is specified, edge fabric node of +deployment_type VIRTUAL_MACHINE will be deployed and registered +with MP.
    • +
  • deployment_type (str or None) –

    Possible values are:

    + +
    +
    Supported edge deployment type.
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) – Fabric node type, for example ‘HostNode’, ‘EdgeNode’ or +‘PublicCloudGatewayNode’
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • discovered_ip_addresses (list of str or None) – Discovered IP Addresses of the fabric node, version 4 or 6 format: +ip +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • external_id (str or None) – ID of the Node maintained on the Node and used to recognize the +Node
    • +
  • fqdn (str or None) – Fully qualified domain name of the fabric node +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • ip_addresses (list of str or None) – IP Addresses of the Node, version 4 or 6. This property is +mandatory for all nodes except for automatic deployment of edge +virtual machine node. For automatic deployment, the ip address from +management_port_subnets property will be considered. format: ip
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.QosBaseRateShaper(enabled=None, resource_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

A shaper configuration entry that specifies type and metrics

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters: +
+
+
+RESOURCE_TYPE_EGRESSRATESHAPER = 'EgressRateShaper'
+
+ +
+
+RESOURCE_TYPE_INGRESSBROADCASTRATESHAPER = 'IngressBroadcastRateShaper'
+
+ +
+
+RESOURCE_TYPE_INGRESSRATESHAPER = 'IngressRateShaper'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.QosSwitchingProfile(class_of_service=None, dscp=None, shaper_configuration=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='QosSwitchingProfile', tags=None, required_capabilities=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • class_of_service (long or None) – Class of service format: int32
    • +
  • dscp (Dscp or None) –
    • +
  • shaper_configuration (list of QosBaseRateShaper or None) –
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • required_capabilities (list of str or None) –
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.QuickSearchResponse(links=None, schema=None, self_=None, result_count=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • result_count (long) – Result count format: int64
    • +
  • results (list of TypeGroup) – Search results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.RateLimits(enabled=None, rx_broadcast=None, rx_multicast=None, tx_broadcast=None, tx_multicast=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Enables traffic limit for incoming/outgoing broadcast and multicast +packets. Use 0 to disable rate limiting for a specific traffic type

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • enabled (bool or None) – Whether rate limiting is enabled
    • +
  • rx_broadcast (long or None) – Incoming broadcast traffic limit in packets per second format: +int32
    • +
  • rx_multicast (long or None) – Incoming multicast traffic limit in packets per second format: +int32
    • +
  • tx_broadcast (long or None) – Outgoing broadcast traffic limit in packets per second format: +int32
    • +
  • tx_multicast (long or None) – Outgoing multicast traffic limit in packets per second format: +int32
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.RealizationStateBarrierConfig(links=None, schema=None, self_=None, revision=None, interval=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The configuration data for setting the global realization state barrier

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • interval (long) – The interval in milliseconds used for auto incrementing the barrier +number format: int64
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.RedistributionConfig(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, bgp_enabled=None, logical_router_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • bgp_enabled (bool or None) – Flag to enable redistribution for BGP as destinationProtocol
    • +
  • logical_router_id (str or None) – Logical router id +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.RedistributionRule(description=None, destination=None, display_name=None, route_map_id=None, sources=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters: +
+
+
+DESTINATION_BGP = 'BGP'
+
+ +
+
+DESTINATION_NSX_CONNECTED = 'NSX_CONNECTED'
+
+ +
+
+DESTINATION_NSX_STATIC = 'NSX_STATIC'
+
+ +
+
+DESTINATION_STATIC = 'STATIC'
+
+ +
+
+DESTINATION_TIER0_NAT = 'TIER0_NAT'
+
+ +
+
+DESTINATION_TIER1_LB_SNAT = 'TIER1_LB_SNAT'
+
+ +
+
+DESTINATION_TIER1_LB_VIP = 'TIER1_LB_VIP'
+
+ +
+
+DESTINATION_TIER1_NAT = 'TIER1_NAT'
+
+ +
+
+SOURCES_BGP = 'BGP'
+
+ +
+
+SOURCES_NSX_CONNECTED = 'NSX_CONNECTED'
+
+ +
+
+SOURCES_NSX_STATIC = 'NSX_STATIC'
+
+ +
+
+SOURCES_STATIC = 'STATIC'
+
+ +
+
+SOURCES_TIER0_NAT = 'TIER0_NAT'
+
+ +
+
+SOURCES_TIER1_LB_SNAT = 'TIER1_LB_SNAT'
+
+ +
+
+SOURCES_TIER1_LB_VIP = 'TIER1_LB_VIP'
+
+ +
+
+SOURCES_TIER1_NAT = 'TIER1_NAT'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.RedistributionRuleList(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, logical_router_id=None, rules=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • logical_router_id (str or None) – Logical router id +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • rules (list of RedistributionRule or None) – List of redistribution rules. User needs to re-order rules to +change the priority.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.RegistrationToken(roles=None, token=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Appliance registration access token

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • roles (list of str) – List results
    • +
  • token (str) – Access token
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.RelatedApiError(details=None, error_code=None, error_data=None, error_message=None, module_name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Detailed information about a related API error

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • details (str or None) – Further details about the error
    • +
  • error_code (long or None) – A numeric error code format: int64
    • +
  • error_data (vmware.vapi.struct.VapiStruct or None) – Additional data about the error
    • +
  • error_message (str or None) – A description of the error
    • +
  • module_name (str or None) – The module name where the error occurred
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.RelatedData(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, alias=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The results array will contain all the related objects

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • alias (str or None) – Alias for the related type
    • +
  • results (list of vmware.vapi.struct.VapiStruct) – Array of related objects
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.RelatedDataRequest(included_fields=None, alias=None, filters=None, resource_type=None, join_condition=None, size=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Request parameters for the related types

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result
    • +
  • alias (str or None) – Alias for the response
    • +
  • filters (list of FilterRequest or None) – An array of filter conditions
    • +
  • resource_type (str) – Resource type name
    • +
  • join_condition (str) – Join condition between the parent and the related object. This is +to be specified in +"relatedObjectFieldName:ParentObjectFieldName" format.
    • +
  • size (long or None) – Number of related objects to return. If not specified all the +related objects will be returned. Should be set to 0 if only the +count of related objects is desired. format: int64
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.RemainingSupportBundleNode(node_display_name=None, node_id=None, status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • node_display_name (str or None) – Display name of node +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • node_id (str or None) – UUID of node +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • status (str or None) –

    Possible values are:

    + +
    +
    Status of node
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
+
+
+
+STATUS_PENDING = 'PENDING'
+
+ +
+
+STATUS_PROCESSING = 'PROCESSING'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.RemoteFileServer(directory_path=None, port=None, protocol=None, server=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Remote file server

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • directory_path (str) – Remote server directory to copy bundle files to
    • +
  • port (long or None) – Server port format: int64
    • +
  • protocol (FileTransferProtocol) – Protocol to use to copy file
    • +
  • server (str) – Remote server hostname or IP address format: hostname-or-ip
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.RemoteServerFingerprint(port=None, server=None, ssh_fingerprint=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Remote server

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • port (long or None) – Server port format: int64
    • +
  • server (str) – Remote server hostname or IP address format: hostname-or-ip
    • +
  • ssh_fingerprint (str) – SSH fingerprint of server
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.RemoteServerFingerprintRequest(port=None, server=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Remote server

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • port (long or None) – Server port format: int64
    • +
  • server (str) – Remote server hostname or IP address format: hostname-or-ip
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.RenderConfiguration(color=None, condition=None, display_value=None, icons=None, tooltip=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Render configuration to be applied to the widget.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • color (str or None) –

    Possible values are:

    + +

    The color to use when rendering an entity. For example, set color +as ‘RED’ to render a portion of donut in red.

    +
    • +
  • condition (str or None) – If the condition is met then the rendering specified for the +condition will be applied. Examples of expression syntax are +provided under ‘example_request’ section of +‘CreateWidgetConfiguration’ API.
    • +
  • display_value (str or None) – If specified, overrides the field value. This can be used to +display a meaningful value in situations where field value is not +available or not configured.
    • +
  • icons (list of Icon or None) – Icons to be applied at dashboard for widgets and UI elements.
    • +
  • tooltip (list of Tooltip or None) – Multi-line text to be shown on tooltip while hovering over the UI +element if the condition is met.
    • +
+
+
+
+COLOR_BLUE = 'BLUE'
+
+ +
+
+COLOR_GREEN = 'GREEN'
+
+ +
+
+COLOR_GREY = 'GREY'
+
+ +
+
+COLOR_RED = 'RED'
+
+ +
+
+COLOR_SKY_BLUE = 'SKY_BLUE'
+
+ +
+
+COLOR_YELLOW = 'YELLOW'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.ReorderMigrationRequest(id=None, is_before=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • id (str) – id of the migration unit group/migration unit before/after which +the migration unit group/migration unit is to be placed
    • +
  • is_before (bool or None) – flag indicating whether the migration unit group/migration unit is +to be placed before or after the specified migration unit +group/migration unit
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ReorderRequest(id=None, is_before=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • id (str) – id of the upgrade unit group/upgrade unit before/after which the +upgrade unit group/upgrade unit is to be placed
    • +
  • is_before (bool or None) – flag indicating whether the upgrade unit group/upgrade unit is to +be placed before or after the specified upgrade unit group/upgrade +unit
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.RepoSyncStatusReport(failure_code=None, failure_message=None, status=None, status_message=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters: +
+
+
+STATUS_FAILED = 'FAILED'
+
+ +
+
+STATUS_IN_PROGRESS = 'IN_PROGRESS'
+
+ +
+
+STATUS_NOT_STARTED = 'NOT_STARTED'
+
+ +
+
+STATUS_SUCCESS = 'SUCCESS'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.ReportAppResultsForVmsRequestParameters(vm_ids=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Parameters to query results of an application discovery session. It has a +list of vm ids.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:vm_ids (list of str or None) – Vm external Ids
+
+ +
+
+class com.vmware.nsx.model_client.Resource(links=None, schema=None, self_=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Base class for resources

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ResourceAllocation(limit=None, reservation=None, shares=None, traffic_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Specify limit, shares and reservation for all kinds of traffic. Values for +limit and reservation are expressed in percentage. And for shares, the +value is expressed as a number between 1-100. The overall reservation among +all traffic types should not exceed 75%. Otherwise, the API request will be +rejected.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • limit (float) – The limit property specifies the maximum bandwidth allocation for a +given traffic type and is expressed in percentage. The default +value for this field is set to -1 which means the traffic is +unbounded for the traffic type. All other negative values for this +property is not supported and will be rejected by the API.
    • +
  • reservation (float) – Minimum guaranteed bandwidth percentage
    • +
  • shares (long) – Shares format: int32
    • +
  • traffic_type (HostInfraTrafficType) – Resource allocation traffic type
    • +
+
+
+ +
+ +

Bases: vmware.vapi.bindings.struct.VapiStruct

+

A link to a related resource

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • action (str or None) – Optional action +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • href (str or None) – Link to resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • rel (str or None) – Custom relation type (follows RFC 5988 where appropriate +definitions exist) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ResourceReference(is_valid=None, target_display_name=None, target_id=None, target_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

A weak reference to an NSX resource.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • is_valid (bool or None) – Will be set to false if the referenced NSX resource has been +deleted. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • target_display_name (str or None) – Display name of the NSX resource. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • target_id (str or None) – Identifier of the NSX resource.
    • +
  • target_type (str or None) – Type of the NSX resource.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.RestoreConfiguration(passphrase=None, remote_file_server=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Configuration where backup files are stored for restore

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • passphrase (str or None) – Passphrase used to encrypt backup files.
    • +
  • remote_file_server (RemoteFileServer) – The server from which backup files will be retrieved for restore.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.RestoreStep(description=None, status=None, step_number=None, value=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Restore step info

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • description (str or None) – Restore step description +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • status (PerStepRestoreStatus or None) –
    • +
  • step_number (long or None) – Restore step number format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • value (str or None) – Restore step value +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.RevisionedResource(links=None, schema=None, self_=None, revision=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

A base class for types that track revisions

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.Role(role=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:role (str) – Role name
+
+ +
+
+class com.vmware.nsx.model_client.RoleBinding(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, name=None, roles=None, stale=None, type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

User/Group’s role binding

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • name (str or None) – User/Group’s name +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • roles (list of Role or None) – Roles +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • stale (str or None) –

    Possible values are:

    + +

    Property ‘stale’ can be considered to have these values - absent - +This type of rolebinding does not support stale property TRUE - +Rolebinding is stale in vIDM meaning the user is no longer present +in vIDM FALSE - Rolebinding is available in vIDM UNKNOWN - +Rolebinding’s state of staleness in unknown Once rolebindings +become stale, they can be deleted using the API POST +/aaa/role-bindings?action=delete_stale_bindings +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • type (str or None) –

    Possible values are:

    + +
    +
    Type
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
+
+
+
+STALE_FALSE = 'FALSE'
+
+ +
+
+STALE_TRUE = 'TRUE'
+
+ +
+
+STALE_UNKNOWN = 'UNKNOWN'
+
+ +
+
+TYPE_LOCAL_USER = 'local_user'
+
+ +
+
+TYPE_PRINCIPAL_IDENTITY = 'principal_identity'
+
+ +
+
+TYPE_REMOTE_GROUP = 'remote_group'
+
+ +
+
+TYPE_REMOTE_USER = 'remote_user'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.RoleBindingListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of RoleBinding) – List results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.RoleListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of Role) – List results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.RoleWithFeatures(features=None, role=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Role

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • features (list of FeaturePermission) – Features
    • +
  • role (str or None) – Role name +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.RouteBasedIPSecVPNSession(tunnel_ports=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='RouteBasedIPSecVPNSession', tags=None, enabled=None, ipsec_vpn_service_id=None, local_endpoint_id=None, peer_endpoint_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

A Route Based VPN is more flexible, more powerful and recommended over +policy based VPN. IP Tunnel port is created and all traffic routed via +tunnel port is protected. Routes can be configured statically or can be +learned through BGP. A route based VPN is must for establishing redundant +VPN session to remote site.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • tunnel_ports (list of TunnelPortConfig) – IP Tunnel ports.
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +

    A Policy Based VPN requires to define protect rules that match +local and peer subnets. IPSec security associations is negotiated +for each pair of local and peer subnet. A Route Based VPN is more +flexible, more powerful and recommended over policy based VPN. IP +Tunnel port is created and all traffic routed via tunnel port is +protected. Routes can be configured statically or can be learned +through BGP. A route based VPN is must for establishing redundant +VPN session to remote site.

    +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • enabled (bool or None) – Enable/Disable IPSec VPN session.
    • +
  • ipsec_vpn_service_id (str or None) – Identifier of VPN Service linked with local endpoint. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • local_endpoint_id (str) – Local endpoint identifier.
    • +
  • peer_endpoint_id (str) – Peer endpoint identifier.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.RouteMap(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, logical_router_id=None, sequences=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • logical_router_id (str or None) – Logical router id +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sequences (list of RouteMapSequence) – Ordered list of routeMap sequences
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.RouteMapListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of RouteMap) – Paginated list of RouteMaps
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.RouteMapSequence(action=None, match_criteria=None, set_criteria=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters: +
+
+
+ACTION_DENY = 'DENY'
+
+ +
+
+ACTION_PERMIT = 'PERMIT'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.RouteMapSequenceMatch(ip_prefix_lists=None, match_community_expression=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Match sequence in route map which is used for matching routes. IP prefix +lists and match community expression are mutually exclusive fields, one of +them must be provided.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • ip_prefix_lists (list of str or None) – IPPrefixList Identifiers for RouteMap Sequence Match Criteria
    • +
  • match_community_expression (CommunityMatchExpression or None) – It supports conjunction operator (AND) and five operators within +singular community match expression (MATCH_ANY, MATCH_ALL, +MATCH_EXACT, MATCH_NONE, MATCH_REGEX).
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.RouteMapSequenceSet(as_path_prepend=None, community=None, multi_exit_discriminator=None, weight=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • as_path_prepend (str or None) – As Path Prepending to influence path selection
    • +
  • community (str or None) – Either well-known community name or community value in +aa:nn(2byte:2byte) format
    • +
  • multi_exit_discriminator (long or None) – Multi Exit Discriminator (MED) format: int64
    • +
  • weight (long or None) – Weight used to select certain path format: int32
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.RoutingConfig(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, forwarding_up_timer=None, logical_router_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • forwarding_up_timer (long or None) – Defines the extra time the router must wait before sending the UP +notification after the first BGP session is established. Default +means forward immediately. format: int64
    • +
  • logical_router_id (str or None) – Logical router id +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.RowListField(alias=None, path=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Root of the api result set for forming rows.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • alias (str or None) –
    • +
  • path (str) – JSON path to the root of the api result set for forming rows.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.RuleState(details=None, failure_code=None, failure_message=None, state=None, revision_desired=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • details (list of ConfigurationStateElement or None) – Array of configuration state of various sub systems +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • failure_code (long or None) – Error code format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • failure_message (str or None) – Error message in case of failure +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • state (str or None) –

    Possible values are:

    + +
    +
    Gives details of state of desired configuration
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • revision_desired (long or None) – revision number of the desired state format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+
+STATE_FAILED = 'failed'
+
+ +
+
+STATE_IN_PROGRESS = 'in_progress'
+
+ +
+
+STATE_ORPHANED = 'orphaned'
+
+ +
+
+STATE_PARTIAL_SUCCESS = 'partial_success'
+
+ +
+
+STATE_PENDING = 'pending'
+
+ +
+
+STATE_SUCCESS = 'success'
+
+ +
+
+STATE_UNKNOWN = 'unknown'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.RuntimeInterfaceOperationalStatus(interface_index=None, last_update_timestamp=None, status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • interface_index (long or None) – Index of the interface format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has +never updated the data. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • status (str) –

    Possible values are:

    + +
    +
    The Operational status of the interface
    +
    • +
+
+
+
+STATUS_DOWN = 'DOWN'
+
+ +
+
+STATUS_UNKNOWN = 'UNKNOWN'
+
+ +
+
+STATUS_UP = 'UP'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.RuntimeInterfaceStatistics(rx_bytes=None, rx_packets=None, tx_bytes=None, tx_packets=None, dropped_by_security_packets=None, mac_learning=None, interface_index=None, last_update_timestamp=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • rx_bytes (SIDataCounter or None) –
    • +
  • rx_packets (SIDataCounter or None) –
    • +
  • tx_bytes (SIDataCounter or None) –
    • +
  • tx_packets (SIDataCounter or None) –
    • +
  • dropped_by_security_packets (SIPacketsDroppedBySecurity or None) –
    • +
  • mac_learning (SIMacLearningCounters or None) –
    • +
  • interface_index (long or None) – Index of the interface format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has +never updated the data. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.SIAggregatedDataCounter(rx_bytes=None, rx_packets=None, tx_bytes=None, tx_packets=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters: +
+
+ +
+
+class com.vmware.nsx.model_client.SIAggregatedDataCounterEx(rx_bytes=None, rx_packets=None, tx_bytes=None, tx_packets=None, dropped_by_security_packets=None, mac_learning=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters: +
+
+ +
+
+class com.vmware.nsx.model_client.SIDataCounter(dropped=None, multicast_broadcast=None, total=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • dropped (long or None) – The dropped packets or bytes format: int64
    • +
  • multicast_broadcast (long or None) – The multicast and broadcast packets or bytes format: int64
    • +
  • total (long) – The total packets or bytes format: int64
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.SIMacLearningCounters(mac_not_learned_packets_allowed=None, mac_not_learned_packets_dropped=None, macs_learned=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • mac_not_learned_packets_allowed (long or None) – The number of packets with unknown source MAC address that are +dispatched without learning the source MAC address. Applicable only +when the MAC limit is reached and MAC Limit policy is +MAC_LEARNING_LIMIT_POLICY_ALLOW. format: int64
    • +
  • mac_not_learned_packets_dropped (long or None) – The number of packets with unknown source MAC address that are +dropped without learning the source MAC address. Applicable only +when the MAC limit is reached and MAC Limit policy is +MAC_LEARNING_LIMIT_POLICY_DROP. format: int64
    • +
  • macs_learned (long or None) – Number of MACs learned format: int64
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.SIPacketTypeAndCounter(counter=None, packet_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • counter (long) – The number of packets. format: int64
    • +
  • packet_type (str) – The type of the packets
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.SIPacketsDroppedBySecurity(bpdu_filter_dropped=None, dhcp_client_dropped_ipv4=None, dhcp_client_dropped_ipv6=None, dhcp_server_dropped_ipv4=None, dhcp_server_dropped_ipv6=None, spoof_guard_dropped=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • bpdu_filter_dropped (long or None) – The number of packets dropped by "BPDU filter". format: +int64
    • +
  • dhcp_client_dropped_ipv4 (long or None) – The number of IPv4 packets dropped by "DHCP client block". +format: int64
    • +
  • dhcp_client_dropped_ipv6 (long or None) – The number of IPv6 packets dropped by "DHCP client block". +format: int64
    • +
  • dhcp_server_dropped_ipv4 (long or None) – The number of IPv4 packets dropped by "DHCP server block". +format: int64
    • +
  • dhcp_server_dropped_ipv6 (long or None) – The number of IPv6 packets dropped by "DHCP server block". +format: int64
    • +
  • spoof_guard_dropped (list of SIPacketTypeAndCounter or None) – The packets dropped by "Spoof Guard"; supported packet +types are IPv4, IPv6, ARP, ND, non-IP.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.SVMDeploymentSpec(host_type=None, name=None, ovf_url=None, service_form_factor=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Deployment Specs holds information required to deploy the Service-VMs.i.e. +OVF url where the partner Service-VM OVF is hosted. The host type on which +the OVF(Open Virtualization Format) can be deployed, Form factor to name a +few.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters: +
+
+
+HOST_TYPE_ESXI = 'ESXI'
+
+ +
+
+HOST_TYPE_RHELKVM = 'RHELKVM'
+
+ +
+
+HOST_TYPE_UBUNTUKVM = 'UBUNTUKVM'
+
+ +
+
+SERVICE_FORM_FACTOR_LARGE = 'LARGE'
+
+ +
+
+SERVICE_FORM_FACTOR_MEDIUM = 'MEDIUM'
+
+ +
+
+SERVICE_FORM_FACTOR_SMALL = 'SMALL'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.SavedSearch(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, is_saved=None, query=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • is_saved (bool) – The flag indicates whether the saved query is saved search or +recent search.
    • +
  • query (str) – The search query that is to be saved.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.SavedSearchListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The results array will contain all the saved or recent search objects.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of SavedSearch) – The list of all saved searches by the user.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.SavedSearchRequest(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, is_saved=None, query=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The request will contain the query to be saved and the flag indicating +whether it is recent or saved search.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • is_saved (bool) – The flag indicates whether the query is recent or saved search.
    • +
  • query (str) – The search query that has to be saved.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ScpProtocol(authentication_scheme=None, ssh_fingerprint=None, name='ScpProtocol')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters: +
+
+ +
+
+class com.vmware.nsx.model_client.SearchResponse(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of vmware.vapi.struct.VapiStruct) – Search results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.SelectableResourceReference(is_valid=None, target_display_name=None, target_id=None, target_type=None, selected=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Resources to take action on

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • is_valid (bool or None) – Will be set to false if the referenced NSX resource has been +deleted. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • target_display_name (str or None) – Display name of the NSX resource. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • target_id (str or None) – Identifier of the NSX resource.
    • +
  • target_type (str or None) – Type of the NSX resource.
    • +
  • selected (bool) – Set to true if this resource has been selected to be acted upon
    • +
+
+
+ +
+ +

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The server will populate this field when returing the resource. Ignored on +PUT and POST.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • action (str or None) – Optional action +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • href (str or None) – Link to resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • rel (str or None) – Custom relation type (follows RFC 5988 where appropriate +definitions exist) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ServerSslProfileBinding(certificate_chain_depth=None, client_certificate_id=None, server_auth=None, server_auth_ca_ids=None, server_auth_crl_ids=None, ssl_profile_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • certificate_chain_depth (long or None) – authentication depth is used to set the verification depth in the +server certificates chain. format: int64
    • +
  • client_certificate_id (str or None) – To support client authentication (load balancer acting as a client +authenticating to the backend server), client certificate can be +specified in the server-side SSL profile binding
    • +
  • server_auth (str or None) –

    Possible values are:

    + +
    +
    server authentication mode
    +
    • +
  • server_auth_ca_ids (list of str or None) – If server auth type is REQUIRED, server certificate must be signed +by one of the trusted Certificate Authorities (CAs), also referred +to as root CAs, whose self signed certificates are specified.
    • +
  • server_auth_crl_ids (list of str or None) – A Certificate Revocation List (CRL) can be specified in the +server-side SSL profile binding to disallow compromised server +certificates.
    • +
  • ssl_profile_id (str or None) – Server SSL profile defines reusable, application-independent server +side SSL properties.
    • +
+
+
+
+SERVER_AUTH_IGNORE = 'IGNORE'
+
+ +
+
+SERVER_AUTH_REQUIRED = 'REQUIRED'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.ServiceAssociationListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, service_type='ServiceAssociationListResult')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • service_type (str) –

    Possible values are:

    + +
    • +
+
+
+
+SERVICE_TYPE_FIREWALLSERVICEASSOCIATIONLISTRESULT = 'FireWallServiceAssociationListResult'
+
+ +
+
+SERVICE_TYPE_IPFIXSERVICEASSOCIATIONLISTRESULT = 'IpfixServiceAssociationListResult'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.ServiceAttachment(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, attachment_status=None, deployed_to=None, local_ips=None, logical_switch=None, service_port=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

A ServiceAttachment represents a point on NSX entity (Example - Edge +Router) to which ServiceInstance can be connected through an +InstanceEndpoint. Example - In VMWare Hybric Cloud Extention (HCX) use +case, HCX appliances connect to this Service Attachment Point. We do not +handle the lifecycle of these appliance/s.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • attachment_status (str or None) –

    Possible values are:

    + +

    UP - A Service Attachment will have its Service Port - UP and with +a configured IP address. DOWN - An Inactive ServiceAttachment has +its Service Port - DOWN. It can be used to connect set of +appliances that do not need to exchange traffic to/from/through the +Edge node.

    +
    • +
  • deployed_to (ResourceReference) – NSX Resource where we want to create Service Attachment Point. Ex. +T0 LR Edge in case of HCX-ServiceInsertion.
    • +
  • local_ips (list of IPInfo) – Local IPs associated with this Service Attachment.
    • +
  • logical_switch (ResourceReference or None) – Logical Switch gets created as a part of Service Attachment +creation. If a Logical Switch is provided, then that needs to be +used - instead of creating new one.
    • +
  • service_port (ResourceReference or None) – Service Port gets created as a part of Service Attachment creation. +It is a Logical Router Port of type CentralizedServicePort. It does +not participate in distributed routing. Stateless Policy Based +Routing service can be applied on this port.
    • +
+
+
+
+ATTACHMENT_STATUS_DOWN = 'DOWN'
+
+ +
+
+ATTACHMENT_STATUS_UP = 'UP'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.ServiceAttachmentListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

List of Service Attachments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of ServiceAttachment or None) – List of the Service Attachments. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ServiceBinding(service_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:service_id (ResourceReference) – Identifier of Logical Service
+
+ +
+
+class com.vmware.nsx.model_client.ServiceDefinition(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, attachment_point=None, functionalities=None, implementations=None, on_failure_policy=None, service_deployment_spec=None, transports=None, vendor_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Registering a Service is the first step in the ServiceInsertion mechanism. +A ServiceDefinition is used to create a service.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • attachment_point (list of str) –

    Possible values are:

    + +

    The point at which the service is deployed/attached for redirecting +the traffic to the the partner appliance.

    +
    • +
  • functionalities (list of str) –

    Possible values are:

    + +

    The capabilities provided by the services like NG_FW, IDS_IPS +Hybrid Cloud Exchange(HCX) is specified here.

    +
    • +
  • implementations (list of str) –

    Possible values are:

    + +
    +
    This indicates the insertion point of the service.
    +
    • +
  • on_failure_policy (str or None) –

    Possible values are:

    + +

    Failure policy for the service tells datapath, the action to take +i.e to Allow or Block traffic during failure scenarios.

    +
    • +
  • service_deployment_spec (ServiceDeploymentSpec or None) – Service Deployment Specification defines takes in information +required to deploy and configure a partner appliance/service-vm.
    • +
  • transports (list of str) –

    Possible values are:

    + +

    Transport Type of the service, which is the mechanism of +redirecting the traffic to the the partner appliance.

    +
    • +
  • vendor_id (str) – Id which is unique to a vendor or partner for which the service is +created.
    • +
+
+
+
+ATTACHMENT_POINT_TIER0_LR = 'TIER0_LR'
+
+ +
+
+ATTACHMENT_POINT_TIER1_LR = 'TIER1_LR'
+
+ +
+
+FUNCTIONALITIES_HCX = 'HCX'
+
+ +
+
+FUNCTIONALITIES_IDS_IPS = 'IDS_IPS'
+
+ +
+
+FUNCTIONALITIES_NG_FW = 'NG_FW'
+
+ +
+
+IMPLEMENTATIONS_EAST_WEST = 'EAST_WEST'
+
+ +
+
+IMPLEMENTATIONS_NORTH_SOUTH = 'NORTH_SOUTH'
+
+ +
+
+ON_FAILURE_POLICY_ALLOW = 'ALLOW'
+
+ +
+
+ON_FAILURE_POLICY_BLOCK = 'BLOCK'
+
+ +
+
+TRANSPORTS_L2_BRIDGE = 'L2_BRIDGE'
+
+ +
+
+TRANSPORTS_L3_ROUTED = 'L3_ROUTED'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.ServiceDeploymentSpec(deployment_specs=None, deployment_template=None, nic_metadata_list=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

ServiceDeployment Spec consists of information required to deploy and +configure the partner appliances. viz. Deployment template, deployment spec +and NIC metatdata.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • deployment_specs (list of SVMDeploymentSpec or None) – Deployment Specs holds information required to deploy the +Service-VMs. i.e. OVF url where the partner Service-VM OVF is +hosted. The host type on which the OVF can be deployed, Form factor +to name a few.
    • +
  • deployment_template (list of DeploymentTemplate) – Deployment Template holds the attributes specific to partner for +which the service is created. These attributes are opaque to NSX +Manager.
    • +
  • nic_metadata_list (list of NicMetadata or None) – NIC metadata associated with the deployment spec.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ServiceEndpoint(certificate=None, certificate_sha256_thumbprint=None, fqdn=None, ip_address=None, port=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • certificate (str or None) –
    • +
  • certificate_sha256_thumbprint (str or None) –
    • +
  • fqdn (str or None) –
    • +
  • ip_address (str) – IPv4 or IPv6 address format: ip
    • +
  • port (long) –
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ServiceIP(ip_address=None, is_advertised=None, is_arp_proxy_enabled=None, is_loopback_enabled=None, service=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • ip_address (str or None) – Service IP address registerd by the service. format: ipv4 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • is_advertised (bool or None) – Flag to denote advertisement status of service IP to TIER0 LR. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • is_arp_proxy_enabled (bool or None) – Flag to denote status of ARP Proxy for service IP. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • is_loopback_enabled (bool or None) – Flag to denote loopback status for service IP. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • service (ResourceReference or None) – Service which registered the ip.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ServiceInsertionRule(links=None, schema=None, self_=None, revision=None, owner=None, description=None, display_name=None, id=None, resource_type=None, action=None, applied_tos=None, destinations=None, destinations_excluded=None, direction=None, disabled=None, ip_protocol=None, is_default=None, logged=None, notes=None, rule_tag=None, services=None, sources=None, sources_excluded=None, redirect_tos=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

ServiceInsertion Rule.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • owner (OwnerResourceLink or None) – Owner of this resource
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Identifier of the resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • action (str) –

    Possible values are:

    + +

    Action enforced on the packets which matches the distributed +service rule. Currently DS Layer supports below actions. ALLOW - +Forward any packet when a rule with this action gets a match (Used +by Firewall). DROP - Drop any packet when a rule with this action +gets a match. Packets won’t go further(Used by Firewall). REJECT - +Terminate TCP connection by sending TCP reset for a packet when a +rule with this action gets a match (Used by Firewall). REDIRECT - +Redirect any packet to a partner appliance when a rule with this +action gets a match (Used by Service Insertion). DO_NOT_REDIRECT - +Do not redirect any packet to a partner appliance when a rule with +this action gets a match (Used by Service Insertion).

    +
    • +
  • applied_tos (list of ResourceReference or None) – List of object where rule will be enforced. The section level field +overrides this one. Null will be treated as any.
    • +
  • destinations (list of ResourceReference or None) – List of the destinations. Null will be treated as any.
    • +
  • destinations_excluded (bool or None) – Negation of the destination.
    • +
  • direction (str or None) –

    Possible values are:

    + +

    Rule direction in case of stateless distributed service rules. This +will only considered if section level parameter is set to +stateless. Default to IN_OUT if not specified.

    +
    • +
  • disabled (bool or None) – Flag to disable rule. Disabled will only be persisted but never +provisioned/realized.
    • +
  • ip_protocol (str or None) –

    Possible values are:

    + +
    +
    Type of IP packet that should be matched while enforcing the rule.
    +
    • +
  • is_default (bool or None) – Flag to indicate whether rule is default. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • logged (bool or None) – Flag to enable packet logging. Default is disabled.
    • +
  • notes (str or None) – User notes specific to the rule.
    • +
  • rule_tag (str or None) – User level field which will be printed in CLI and packet logs.
    • +
  • services (list of ServiceInsertionService or None) – List of the services. Null will be treated as any.
    • +
  • sources (list of ResourceReference or None) – List of sources. Null will be treated as any.
    • +
  • sources_excluded (bool or None) – Negation of the source.
    • +
  • redirect_tos (list of ResourceReference) – A rule can be realized on a particular service definition, service +instance or instance endpoint. If a service definition is selected +as a redirect_to target, by default it will take the first deployed +service instance if finds.
    • +
+
+
+
+ACTION_ALLOW = 'ALLOW'
+
+ +
+
+ACTION_DO_NOT_REDIRECT = 'DO_NOT_REDIRECT'
+
+ +
+
+ACTION_DROP = 'DROP'
+
+ +
+
+ACTION_REDIRECT = 'REDIRECT'
+
+ +
+
+ACTION_REJECT = 'REJECT'
+
+ +
+
+DIRECTION_IN = 'IN'
+
+ +
+
+DIRECTION_IN_OUT = 'IN_OUT'
+
+ +
+
+DIRECTION_OUT = 'OUT'
+
+ +
+
+IP_PROTOCOL_IPV4 = 'IPV4'
+
+ +
+
+IP_PROTOCOL_IPV4_IPV6 = 'IPV4_IPV6'
+
+ +
+
+IP_PROTOCOL_IPV6 = 'IPV6'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.ServiceInsertionRuleList(rules=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

List of ServiceInsertion Rules.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:rules (list of ServiceInsertionRule) – List of ServiceInsertion rules in the section. Only homogeneous +rules are supported.
+
+ +
+
+class com.vmware.nsx.model_client.ServiceInsertionRuleListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

List of ServiceInsertion Rules.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of ServiceInsertionRule or None) – ServiceInsertion rule list result with pagination support. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ServiceInsertionSection(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, applied_tos=None, is_default=None, rule_count=None, section_type=None, stateful=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

A ServiceInsertion section composed of ServiceInsertion Rules.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • applied_tos (list of ResourceReference or None) – List of objects where the rules in this section will be enforced. +This will take precedence over rule level appliedTo.
    • +
  • is_default (bool or None) – It is a boolean flag which reflects whether a distributed service +section is default section or not. Each Layer 3 and Layer 2 section +will have at least and at most one default section. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • rule_count (long or None) – Number of rules in this section. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • section_type (str) –

    Possible values are:

    + +

    Type of the rules which a section can contain. Only homogeneous +sections are supported.

    +
    • +
  • stateful (bool) – Stateful or Stateless nature of distributed service section is +enforced on all rules inside the section. Layer3 sections can be +stateful or stateless. Layer2 sections can only be stateless.
    • +
+
+
+
+SECTION_TYPE_L3REDIRECT = 'L3REDIRECT'
+
+ +
+
+SECTION_TYPE_LAYER2 = 'LAYER2'
+
+ +
+
+SECTION_TYPE_LAYER3 = 'LAYER3'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.ServiceInsertionSectionListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

List of ServiceInsertion Sections.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of ServiceInsertionSection or None) – List of the ServiceInsertion sections. The list has to be +homogeneous. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ServiceInsertionSectionRuleList(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, applied_tos=None, is_default=None, rule_count=None, section_type=None, stateful=None, rules=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

List of ServiceInsertion Rules.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • applied_tos (list of ResourceReference or None) – List of objects where the rules in this section will be enforced. +This will take precedence over rule level appliedTo.
    • +
  • is_default (bool or None) – It is a boolean flag which reflects whether a distributed service +section is default section or not. Each Layer 3 and Layer 2 section +will have at least and at most one default section. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • rule_count (long or None) – Number of rules in this section. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • section_type (str) –

    Possible values are:

    + +

    Type of the rules which a section can contain. Only homogeneous +sections are supported.

    +
    • +
  • stateful (bool) – Stateful or Stateless nature of distributed service section is +enforced on all rules inside the section. Layer3 sections can be +stateful or stateless. Layer2 sections can only be stateless.
    • +
  • rules (list of ServiceInsertionRule) – List of Service Insertion rules in the section. Only homogeneous +rules are supported.
    • +
+
+
+
+SECTION_TYPE_L3REDIRECT = 'L3REDIRECT'
+
+ +
+
+SECTION_TYPE_LAYER2 = 'LAYER2'
+
+ +
+
+SECTION_TYPE_LAYER3 = 'LAYER3'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.ServiceInsertionService(is_valid=None, target_display_name=None, target_id=None, target_type=None, service=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Protocol on which a particular ServiceInsertion Rule should apply to.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • is_valid (bool or None) – Will be set to false if the referenced NSX resource has been +deleted. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • target_display_name (str or None) – Display name of the NSX resource. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • target_id (str or None) – Identifier of the NSX resource.
    • +
  • target_type (str or None) – Type of the NSX resource.
    • +
  • service (vmware.vapi.struct.VapiStruct or None) – Distributed Service API accepts raw protocol and ports as part of +NS service element in Distributed Service Rule that describes +traffic corresponding to an NSService. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +NSServiceElement. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in NSServiceElement.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ServiceInsertionServiceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Service List

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of ServiceDefinition or None) – List of the Service-Insertion Services. The list has to be +homogenous. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ServiceInstance(attachment_point=None, deployed_to=None, deployment_mode=None, deployment_spec_name=None, implementation_type=None, instance_deployment_config=None, instance_deployment_template=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ServiceInstance', tags=None, on_failure_policy=None, service_id=None, transport_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The deployment of a registered service. Service instance is instantiation +of service. It is the most used type of instance. It is a default instance +to be used when NSX handles lifecycle of appliance. Deployment and +appliance related all the information is necessary.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • attachment_point (str) –

    Possible values are:

    + +

    Attachment point to be used by this service instance for deploying +the Service-VM.

    +
    • +
  • deployed_to (list of ResourceReference) – List of resource references where service instance be deployed. Ex. +Tier 0 Logical Router in case of N-S ServiceInsertion.
    • +
  • deployment_mode (str) –

    Possible values are:

    + +

    Deployment mode specifies where the partner appliance will be +deployed in HA or non-HA i.e standalone mode.

    +
    • +
  • deployment_spec_name (str) – Name of the deployment spec to be used by this service instance.
    • +
  • implementation_type (str) –

    Possible values are:

    + +

    Implementation to be used by this service instance for deploying +the Service-VM.

    +
    • +
  • instance_deployment_config (InstanceDeploymentConfig) – Instance Deployment Config contains the information to be injected +during Service-VM deployment.
    • +
  • instance_deployment_template (DeploymentTemplate) – The deployment template to be used by this service instance. The +attribute values specific to this instance can be added.
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +

    ServiceInstance is used when NSX handles the lifecyle of appliance. +Deployment and appliance related all the information is necessary. +ByodServiceInstance is a custom instance to be used when NSX is not +handling the lifecycles of appliance/s. User will manage their own +appliance (BYOD) to connect with NSX. VirtualServiceInstance is a a +custom instance to be used when NSX is not handling the lifecycle +of an appliance and when the user is not bringing their own +appliance.

    +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • on_failure_policy (str or None) –

    Possible values are:

    + +

    Failure policy of the service instance - if it has to be different +from the service. By default the service instance inherits the +FailurePolicy of the service it belongs to.

    +
    • +
  • service_id (str or None) – The Service to which the service instance is associated. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • transport_type (str) –

    Possible values are:

    + +

    Transport to be used by this service instance for deploying the +Service-VM.

    +
    • +
+
+
+
+ATTACHMENT_POINT_TIER0_LR = 'TIER0_LR'
+
+ +
+
+ATTACHMENT_POINT_TIER1_LR = 'TIER1_LR'
+
+ +
+
+DEPLOYMENT_MODE_ACTIVE_STANDBY = 'ACTIVE_STANDBY'
+
+ +
+
+DEPLOYMENT_MODE_STAND_ALONE = 'STAND_ALONE'
+
+ +
+
+IMPLEMENTATION_TYPE_EAST_WEST = 'EAST_WEST'
+
+ +
+
+IMPLEMENTATION_TYPE_NORTH_SOUTH = 'NORTH_SOUTH'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.ServiceInstanceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Service Instance List

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of vmware.vapi.struct.VapiStruct or None) – List of the Service-Insertion ServicesInstances. The list has to be +homogenous. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +BaseServiceInstance. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in BaseServiceInstance. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ServiceProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, server_addresses=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +
    +
    Resource type of the service profile
    +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • server_addresses (list of str) –
    • +
+
+
+
+RESOURCE_TYPE_DHCPRELAYPROFILE = 'DhcpRelayProfile'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.ServiceProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of ServiceProfile) – service profile list results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ServiceRouterAllocationConfig(allocation_pool=None, edge_cluster_id=None, edge_cluster_member_indices=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • allocation_pool (vmware.vapi.struct.VapiStruct or None) – Logical router allocation can be tracked for specific services and +services may have their own hard limits and allocation sizes. For +example load balancer pool should be specified if load balancer +service will be attached to logical router. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +EdgeClusterMemberAllocationPool. When methods return a +value of this class as a return value, the attribute will contain +all the attributes defined in +EdgeClusterMemberAllocationPool.
    • +
  • edge_cluster_id (str) – To reallocate TIER1 logical router on new or existing edge cluster
    • +
  • edge_cluster_member_indices (list of long or None) – For TIER 1 logical router, for manual placement of service router +within the cluster, edge cluster member indices needs to be +provided else same will be auto-allocated. You can provide maximum +two indices for HA ACTIVE_STANDBY. format: int64
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ServiceiPsListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of ServiceIP or None) – List of service IPs registered with the LR by services like NAT, +LB, VPN, etc. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.SessionReclassificationParameter(app_profile_ids=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:app_profile_ids (list of str or None) – App Profile Ids
+
+ +
+
+class com.vmware.nsx.model_client.SftpProtocol(authentication_scheme=None, ssh_fingerprint=None, name='SftpProtocol')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters: +
+
+ +
+
+class com.vmware.nsx.model_client.SnmpCommunity(access=None, community_string=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • access (str or None) –

    Possible values are:

    + +
    +
    Type of access
    +
    • +
  • community_string (str or None) – Community string at most 64 characters long
    • +
+
+
+
+ACCESS_ONLY = 'read_only'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.SnmpServiceProperties(communities=None, start_on_boot=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

SNMP Service properties

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • communities (list of SnmpCommunity or None) – SNMP v1, v2c community
    • +
  • start_on_boot (bool) – Start when system boots
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.SoftwareModule(module_name=None, module_version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Software module details

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • module_name (str) – Name of the module in the node
    • +
  • module_version (str) – Version of the module in the node
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.SoftwareModuleResult(software_modules=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Software module result

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:software_modules (list of SoftwareModule) – Software module results
+
+ +
+
+class com.vmware.nsx.model_client.SourceNsxApiEndpoint(auth_token=None, ip=None, vc_ip=None, vc_password=None, vc_port=None, vc_username=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Details about an existing NSX manager to be migrated

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • auth_token (str or None) – Auth token used to make REST calls to source NSX API endpoint.
    • +
  • ip (str) – IP address or hostname of a source NSX API endpoint. format: +hostname-or-ip
    • +
  • vc_ip (str) – IP address or host name of VC connected to this NSX format: +hostname-or-ip
    • +
  • vc_password (str or None) – Valid password for connecting to VC.
    • +
  • vc_port (long or None) – VC port that will be used to fetch details. format: int32
    • +
  • vc_username (str) – Valid username for connecting to VC.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.SpoofGuardSwitchingProfile(white_list_providers=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='SpoofGuardSwitchingProfile', tags=None, required_capabilities=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

SpoofGuard configuration

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • white_list_providers (list of str) –

    Possible values are:

    + +
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • required_capabilities (list of str or None) –
    • +
+
+
+
+WHITE_LIST_PROVIDERS_LPORT_BINDINGS = 'LPORT_BINDINGS'
+
+ +
+
+WHITE_LIST_PROVIDERS_LSWITCH_BINDINGS = 'LSWITCH_BINDINGS'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.SshKeyBaseProperties(label=None, password=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • label (str) – SSH key label (used to identify the key)
    • +
  • password (str or None) – Current password for user (required for users root and admin)
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.SshKeyProperties(label=None, password=None, type=None, value=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • label (str) – SSH key label (used to identify the key)
    • +
  • password (str or None) – Current password for user (required for users root and admin)
    • +
  • type (str) – SSH key type
    • +
  • value (str) – SSH key value
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.SshKeyPropertiesListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

SSH key properties query results

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of SshKeyProperties) – SSH key properties query results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.SshServiceProperties(start_on_boot=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

SSH Service properties

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:start_on_boot (bool) – Start service when system boots
+
+ +
+
+class com.vmware.nsx.model_client.StandardHostSwitch(cpu_config=None, host_switch_name=None, host_switch_profile_ids=None, ip_assignment_spec=None, pnics=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Standard host switch specification

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • cpu_config (list of CpuCoreConfigForEnhancedNetworkingStackSwitch or None) – CPU configuration specifies number of Logical cpu cores (Lcores) +per Non Uniform Memory Access (NUMA) node dedicated to Enhanced +Networking Stack enabled HostSwitch to get the best performance.
    • +
  • host_switch_name (str or None) – If this name is unset or empty then the default host switch name +will be used. The name must be unique among all host switches +specified in a given transport node; unset name, empty name and the +default host switch name are considered the same in terms of +uniqueness.
    • +
  • host_switch_profile_ids (list of HostSwitchProfileTypeIdEntry or None) – host switch profiles bound to this host switch. If a profile ID is +not provided for any HostSwitchProfileType that is supported by the +transport node, the corresponding default profile will be bound to +the host switch.
    • +
  • ip_assignment_spec (vmware.vapi.struct.VapiStruct or None) – IPs can come from either a static IP pool or an explicitly +specified IP list or DHCP. In case a list of IP is specified, the +number of IPs provided should be sufficient as per teaming policy +associated with host switch uplink profile. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +IpAssignmentSpec. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in IpAssignmentSpec.
    • +
  • pnics (list of Pnic or None) – Physical NICs connected to the host switch
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.StandardHostSwitchSpec(host_switches=None, resource_type='StandardHostSwitchSpec')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Standard host switch specification is used for NSX configured transport +node.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters: +
+
+ +
+
+class com.vmware.nsx.model_client.StartAppDiscoverySessionParameters(app_profile_ids=None, ns_group_ids=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Parameters to start an application discovery session. It can have NSGroup +Ids as well as the App Profile Ids.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • app_profile_ids (list of str or None) – App Profile Ids
    • +
  • ns_group_ids (list of str) – NSGroup Ids
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.StatItem(drilldown_id=None, tooltip=None, value=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Displayed as a single number. It can be used to show the characteristics of +entities such as Logical Switches, Firewall Rules, and so on. For example, +number of logical switches and their admin states.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • drilldown_id (str or None) – Id of drilldown widget, if any. Id should be a valid id of an +existing widget.
    • +
  • tooltip (list of Tooltip or None) – Multi-line text to be shown on tooltip while hovering over the +stat.
    • +
  • value (str) – Expression for stat to be displayed.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.StaticHopBfdPeer(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, bfd_config=None, enabled=None, peer_ip_address=None, source_addresses=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • bfd_config (BfdConfigParameters or None) – If not specified then BFD peer will inherit configuration from the +BFD global config.
    • +
  • enabled (bool or None) – Indicate BFD peer is enabled or disabled. Default is true.
    • +
  • peer_ip_address (str) – IP address of BFD peer. This should be same as next hop IP address. +format: ipv4
    • +
  • source_addresses (list of str or None) – BFD peers will be created from all these source addresses to this +neighbour. format: ipv4
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.StaticHopBfdPeerListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of StaticHopBfdPeer or None) – static hop BFD peer list results +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.StaticIpListSpec(default_gateway=None, ip_list=None, subnet_mask=None, resource_type='StaticIpListSpec')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

IP assignment specification for Static IP List.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters: +
+
+ +
+
+class com.vmware.nsx.model_client.StaticIpMacListSpec(default_gateway=None, ip_mac_list=None, subnet_mask=None, resource_type='StaticIpMacListSpec')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

IP and MAC assignment specification for Static IP List.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters: +
+
+ +
+
+class com.vmware.nsx.model_client.StaticIpPoolSpec(ip_pool_id=None, resource_type='StaticIpPoolSpec')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

IP assignment specification for Static IP Pool.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters: +
+
+ +
+
+class com.vmware.nsx.model_client.StaticRoute(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, logical_router_id=None, network=None, next_hops=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • logical_router_id (str or None) – Logical router id +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • network (str) – CIDR format: ipv4-cidr-block
    • +
  • next_hops (list of StaticRouteNextHop) – Next Hops
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.StaticRouteListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of StaticRoute) – Paginated list of static routes
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.StaticRouteNextHop(administrative_distance=None, bfd_enabled=None, blackhole_action=None, ip_address=None, logical_router_port_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • administrative_distance (long or None) – Administrative Distance for the next hop IP format: int64
    • +
  • bfd_enabled (bool or None) – Status of bfd for this next hop where bfd_enabled = true indicate +bfd is enabled for this next hop and bfd_enabled = false indicate +bfd peer is disabled or not configured for this next hop. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • blackhole_action (str or None) –

    Possible values are:

    + +
    +
    Action to be taken on matching packets for NULL routes.
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • ip_address (str or None) – Next Hop IP format: ipv4
    • +
  • logical_router_port_id (ResourceReference or None) – Reference of logical router port to be used for next hop
    • +
+
+
+
+BLACKHOLE_ACTION_DISCARD = 'DISCARD'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.StatsConfiguration(label=None, navigation=None, sections=None, stat=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='StatsConfiguration', tags=None, datasources=None, drilldown_id=None, footer=None, is_drilldown=None, shared=None, weight=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Represents configuration of a statistic for an entity. Example, number of +logical switches and their admin states.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • label (Label or None) – Displayed at the sections, by default. It labels the entities of +sections. If label is not provided, the sections are not labelled.
    • +
  • navigation (str or None) – Hyperlink of the specified UI page that provides details.
    • +
  • sections (list of DonutSection or None) – Sections
    • +
  • stat (StatItem or None) – Expression that fetches statistic. It can be used to show the +characteristics of entities such as Logical Switches, Firewall +Rules, and so on. For example, number of logical switches and their +admin states. If stat is not provided, then it will not be +displayed.
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str) – Title of the widget.
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +

    Supported visualization types are LabelValueConfiguration, +DonutConfiguration, GridConfiguration, StatsConfiguration, +MultiWidgetConfiguration and ContainerConfiguration.

    +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • datasources (list of Datasource or None) – The ‘datasources’ represent the sources from which data will be +fetched. Currently, only NSX-API is supported as a ‘default’ +datasource. An example of specifying ‘default’ datasource along +with the urls to fetch data from is given at ‘example_request’ +section of ‘CreateWidgetConfiguration’ API.
    • +
  • drilldown_id (str or None) – Id of drilldown widget, if any. Id should be a valid id of an +existing widget. A widget is considered as drilldown widget when it +is associated with any other widget and provides more detailed +information about any data item from the parent widget.
    • +
  • footer (Footer or None) –
    • +
  • is_drilldown (bool or None) – Set to true if this widget should be used as a drilldown.
    • +
  • shared (bool or None) – Please use the property ‘shared’ of View instead of this. The +widgets of a shared view are visible to other users.
    • +
  • weight (long or None) – Specify relavite weight in WidgetItem for placement in a view. +Please see WidgetItem for details. format: int32
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.StatusCount(degraded_count=None, down_count=None, status=None, up_count=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters: +
+
+
+STATUS_DEGRADED = 'DEGRADED'
+
+ +
+
+STATUS_DOWN = 'DOWN'
+
+ +
+
+STATUS_UNKNOWN = 'UNKNOWN'
+
+ +
+
+STATUS_UP = 'UP'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.StringMapEntry(key=None, value=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • key (str) – String key for the map
    • +
  • value (str or None) – String value for the map entry
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.StructuredData(audit=None, comp=None, ent_id=None, ereq_id=None, error_code=None, level=None, req_id=None, s2comp=None, security=None, subcomp=None, username=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Structured data entry in RFC5424 log format

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • audit (str) – Audit flag of the log
    • +
  • comp (str) – Component value of the log
    • +
  • ent_id (str or None) – Entity Id value of the log
    • +
  • ereq_id (str or None) – External request Id value of the log
    • +
  • error_code (str or None) – Error Code value of the log
    • +
  • level (str or None) – Level value of the log
    • +
  • req_id (str or None) – Request Id value of the log
    • +
  • s2comp (str or None) – Sub-subcomponent value of the log
    • +
  • security (str or None) – Security flag of the log
    • +
  • subcomp (str) – Subcomponent value of the log
    • +
  • username (str or None) – Username value of the log
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+class com.vmware.nsx.model_client.SuccessNodeSupportBundleResult(bundle_name=None, bundle_size=None, node_display_name=None, node_id=None, sha256_thumbprint=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • bundle_name (str or None) – Name of support bundle, e.g. nsx_NODETYPE_UUID_YYYYMMDD_HHMMSS.tgz +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • bundle_size (long or None) – Size of support bundle in bytes format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • node_display_name (str or None) – Display name of node +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • node_id (str or None) – UUID of node +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sha256_thumbprint (str or None) – File’s SHA256 thumbprint +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.SupportBundleFileTransferAuthenticationScheme(password=None, scheme_name=None, username=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters: +
+
+
+SCHEME_NAME_PASSWORD = 'PASSWORD'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.SupportBundleFileTransferProtocol(authentication_scheme=None, name=None, ssh_fingerprint=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters: +
+
+
+NAME_SCP = 'SCP'
+
+ +
+
+NAME_SFTP = 'SFTP'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.SupportBundleQueryParameters(all=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:all (bool or None) – Include all files including files that may have sensitive +information like core files.
+
+ +
+
+class com.vmware.nsx.model_client.SupportBundleRemoteFileServer(directory_path=None, manager_upload_only=None, port=None, protocol=None, server=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Remote file server

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • directory_path (str) – Remote server directory to copy bundle files to
    • +
  • manager_upload_only (bool or None) – Uploads to the remote file server performed by the manager
    • +
  • port (long or None) – Server port format: int64
    • +
  • protocol (SupportBundleFileTransferProtocol) – Protocol to use to copy file
    • +
  • server (str) – Remote server hostname or IP address
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.SupportBundleRequest(content_filters=None, log_age_limit=None, nodes=None, remote_file_server=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters: +
+
+
+CONTENT_FILTERS_ALL = 'ALL'
+
+ +
+
+CONTENT_FILTERS_DEFAULT = 'DEFAULT'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.SupportBundleResult(failed_nodes=None, remaining_nodes=None, request_properties=None, success_nodes=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • failed_nodes (list of FailedNodeSupportBundleResult or None) – Nodes where bundles were not generated or not copied to remote +server +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • remaining_nodes (list of RemainingSupportBundleNode or None) – Nodes where bundle generation is pending or in progress
    • +
  • request_properties (SupportBundleRequest or None) – Request properties
    • +
  • success_nodes (list of SuccessNodeSupportBundleResult or None) – Nodes whose bundles were successfully copied to remote file server +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.SwitchSecuritySwitchingProfile(block_non_ip_traffic=None, bpdu_filter=None, dhcp_filter=None, rate_limits=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='SwitchSecuritySwitchingProfile', tags=None, required_capabilities=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • block_non_ip_traffic (bool or None) – A flag to block all traffic except IP/(G)ARP/BPDU
    • +
  • bpdu_filter (BpduFilter or None) – BPDU filtering is enabled by default. A pre-defined list of MAC +addresses are automatically excluded from BPDU filtering.
    • +
  • dhcp_filter (DhcpFilter or None) – DHCP server blocking is enabled and client blocking is disabled by +default
    • +
  • rate_limits (RateLimits or None) – Rate limiting is disabled by default
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • required_capabilities (list of str or None) –
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.SwitchingProfileStatus(num_logical_ports=None, num_logical_switches=None, switching_profile_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • num_logical_ports (long or None) – Number of logical ports using a switching profile format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • num_logical_switches (long or None) – Number of logical switches using a switching profile format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • switching_profile_id (str or None) – Identifier for the switching profile
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.SwitchingProfileTypeIdEntry(key=None, value=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters: +
+
+
+KEY_IPDISCOVERYSWITCHINGPROFILE = 'IpDiscoverySwitchingProfile'
+
+ +
+
+KEY_MACMANAGEMENTSWITCHINGPROFILE = 'MacManagementSwitchingProfile'
+
+ +
+
+KEY_PORTMIRRORINGSWITCHINGPROFILE = 'PortMirroringSwitchingProfile'
+
+ +
+
+KEY_QOSSWITCHINGPROFILE = 'QosSwitchingProfile'
+
+ +
+
+KEY_SPOOFGUARDSWITCHINGPROFILE = 'SpoofGuardSwitchingProfile'
+
+ +
+
+KEY_SWITCHSECURITYSWITCHINGPROFILE = 'SwitchSecuritySwitchingProfile'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.SwitchingProfilesListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Switching Profile queries result

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of vmware.vapi.struct.VapiStruct or None) – Switching Profile Results +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +BaseSwitchingProfile. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in BaseSwitchingProfile. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.SwitchingToVmcModeParameters(mode_id=None, auth_code=None, base_url=None, basic_auth_whitelist_ips=None, csp_client_credential=None, csp_client_incoming_credentials=None, csp_org_uri=None, csp_time_drift=None, default_org_id=None, ea_org=None, gss_org=None, mode_change_only=None, proxy_host=None, proxy_port=None, sddc_id=None, service_definition_id=None, sre_org=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Possible values of a mode in a "/config/nsx_appliance_mode" file

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • mode_id (str) –

    Possible values are:

    + +

    Possible enum values in a "/config/nsx_appliance_mode" file

    +
    • +
  • auth_code (Oauth2Credentials or None) – Client’s credentials.
    • +
  • base_url (str or None) – Protocol and domain name (or IP address) of a CSP server, like +"https://console-stg.cloud.vmware.com".
    • +
  • basic_auth_whitelist_ips (list of str or None) – List of whitelist IPs for basic auth
    • +
  • csp_client_credential (Oauth2Credentials or None) – Client’s credentials on CSP server
    • +
  • csp_client_incoming_credentials (list of str or None) – List of incoming client IDs
    • +
  • csp_org_uri (str or None) – Relative path on CSP server to the Org location. Can be +"/csp/gateway/am/api/orgs/".
    • +
  • csp_time_drift (long or None) – CSP time drift in milliseconds format: int64
    • +
  • default_org_id (str or None) – Org ID of a Client - commonly UUID.
    • +
  • ea_org (OrgInfo or None) – Org ID and role of "Site Reliability Engineer"
    • +
  • gss_org (OrgInfo or None) – Org ID and role of "Global Support Services"
    • +
  • mode_change_only (bool or None) – When this parameter is set to true, only a change of the node mode +happens without any update to the auth properties. When this param +is not set to true i.e. set to false or not provided, mode change +and update to the auth properties will both happen.
    • +
  • proxy_host (str or None) – IP/host of PoP (Point-of-Presence) Http proxy server format: +hostname-or-ipv4
    • +
  • proxy_port (long or None) – Port of PoP (Point-of-Presence) Http proxy server format: int64
    • +
  • sddc_id (str or None) – SDDC id
    • +
  • service_definition_id (str or None) – Service definition id
    • +
  • sre_org (OrgInfo or None) – Org ID and role of "Enterprise Admin"
    • +
+
+
+
+MODE_ID_ON_PREM = 'ON_PREM'
+
+ +
+
+MODE_ID_SERVICE = 'SERVICE'
+
+ +
+
+MODE_ID_VMC = 'VMC'
+
+ +
+
+MODE_ID_VMC_LOCAL = 'VMC_LOCAL'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.Tag(scope=None, tag=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Arbitrary key-value pairs that may be attached to an entity

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • scope (str or None) – Tag searches may optionally be restricted by scope
    • +
  • tag (str or None) – Identifier meaningful to user
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.TargetResourceStatus(target_id=None, target_status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Holds status of target resource in firewall context.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters: +
+
+
+TARGET_STATUS_DISABLED = 'DISABLED'
+
+ +
+
+TARGET_STATUS_ENABLED = 'ENABLED'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.TaskListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Task query results

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of TaskProperties) – Task property results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.TaskProperties(links=None, schema=None, self_=None, async_response_available=None, cancelable=None, description=None, end_time=None, id=None, message=None, progress=None, request_method=None, request_uri=None, start_time=None, status=None, user=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Task properties

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • async_response_available (bool or None) – True if response for asynchronous request is available +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • cancelable (bool or None) – True if this task can be canceled +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of the task +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • end_time (long or None) – The end time of the task in epoch milliseconds format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • id (str or None) – Identifier for this task +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • message (str or None) – A message describing the disposition of the task +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • progress (long or None) – Task progress if known, from 0 to 100 format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • request_method (str or None) – HTTP request method +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • request_uri (str or None) – URI of the method invocation that spawned this task +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • start_time (long or None) – The start time of the task in epoch milliseconds format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • status (str or None) –

    Possible values are:

    + +
    +
    Current status of the task
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • user (str or None) – Name of the user who created this task +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+
+STATUS_CANCELED = 'canceled'
+
+ +
+
+STATUS_CANCELING = 'canceling'
+
+ +
+
+STATUS_ERROR = 'error'
+
+ +
+
+STATUS_KILLED = 'killed'
+
+ +
+
+STATUS_RUNNING = 'running'
+
+ +
+
+STATUS_SUCCESS = 'success'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.TcpHeader(dst_port=None, src_port=None, tcp_flags=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • dst_port (long or None) – Destination port of tcp header format: int64
    • +
  • src_port (long or None) – Source port of tcp header format: int64
    • +
  • tcp_flags (long or None) – TCP flags (9bits) format: int64
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.TeamingPolicy(active_list=None, policy=None, standby_list=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Uplink Teaming Policy

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters: +
+
+
+POLICY_FAILOVER_ORDER = 'FAILOVER_ORDER'
+
+ +
+
+POLICY_LOADBALANCE_SRCID = 'LOADBALANCE_SRCID'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.TelemetryAgreement(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, telemetry_agreement_displayed=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • telemetry_agreement_displayed (bool) – Determine if telemetry agreement has been displayed. If false, the +agreement text will be displayed at login time.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.TelemetryConfig(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, ceip_acceptance=None, proxy_enabled=None, schedule_enabled=None, telemetry_proxy=None, telemetry_schedule=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • ceip_acceptance (bool) – Enable this flag to participate in the Customer Experience +Improvement Program.
    • +
  • proxy_enabled (bool or None) – Enable this flag to specify a proxy, and provide the proxy +settings.
    • +
  • schedule_enabled (bool) – Enable this to schedule data collection and upload times. If +enabled, and a schedule is not provided, a default schedule +(WEEKLY, Sunday at 2:00 a.m) will be applied.
    • +
  • telemetry_proxy (TelemetryProxy or None) – Specify the proxy configuration (scheme, server, port) here.
    • +
  • telemetry_schedule (vmware.vapi.struct.VapiStruct or None) – Specify one of Daily, Weekly or Monthly schedules. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +TelemetrySchedule. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in TelemetrySchedule.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.TelemetryProxy(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, hostname=None, password=None, port=None, scheme=None, username=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • hostname (str) – Specify the fully qualified domain name, or ip address, of the +proxy server. format: hostname-or-ip
    • +
  • password (str or None) – Specify the password used to authenticate with the proxy server, if +required. A GET call on /telemetry/config returns a non-meaningful +password to maintain security. To change the password to a new +value, issue a PUT call after updating this field. To remove the +password, issue a PUT call after emptying this field. To retain a +previously set password, issue a PUT call keeping the +non-meaningful value obtained from the GET call.
    • +
  • port (long) – Specify the port of the proxy server. format: int32
    • +
  • scheme (str) –

    Possible values are:

    + +

    The scheme accepted by the proxy server. Specify one of HTTP and +HTTPS.

    +
    • +
  • username (str or None) – Specify the user name used to authenticate with the proxy server, +if required.
    • +
+
+
+
+SCHEME_HTTP = 'HTTP'
+
+ +
+
+SCHEME_HTTPS = 'HTTPS'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.TelemetrySchedule(frequency_type='TelemetrySchedule')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Abstract base type for telemetry schedule configuration

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:frequency_type (str) – Specify one of DailyTelemetrySchedule, WeeklyTelemetrySchedule, or +MonthlyTelemetrySchedule.
+
+ +
+
+class com.vmware.nsx.model_client.Tooltip(condition=None, text=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Tooltip to be shown while hovering over the dashboard UI element.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • condition (str or None) – If the condition is met then the tooltip will be applied. If no +condition is provided, then the tooltip will be applied +unconditionally. Examples of expression syntax are provided under +‘example_request’ section of ‘CreateWidgetConfiguration’ API.
    • +
  • text (str) – Text to be shown on tooltip while hovering over UI element. The +text would be wrapped if it exceeds 80 chars.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.Traceflow(links=None, schema=None, self_=None, analysis=None, counters=None, id=None, logical_counters=None, lport_id=None, operation_state=None, request_status=None, result_overflowed=None, timeout=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • analysis (list of str or None) – Traceflow result analysis notes +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • counters (TraceflowObservationCounters or None) – observation counters
    • +
  • id (str or None) – The id of the traceflow round +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • logical_counters (TraceflowObservationCounters or None) – counters of observations from logical components
    • +
  • lport_id (str or None) – id of the source logical port used for injecting the traceflow +packet +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • operation_state (str or None) –

    Possible values are:

    + +
    +
    Represents the traceflow operation state
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • request_status (str or None) –

    Possible values are:

    + +

    The status of the traceflow RPC request. SUCCESS - The traceflow +request is sent successfully. TIMEOUT - The traceflow request gets +timeout. SOURCE_PORT_NOT_FOUND - The source port of the request is +not found. DATA_PATH_NOT_READY - The datapath component is not +ready to receive request. CONNECTION_ERROR - There is connection +error on datapath component. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • result_overflowed (bool or None) – A flag, when set true, indicates some observations were deleted +from the result set. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • timeout (long or None) – Maximum time (in ms) the management plane will be waiting for this +traceflow round. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+
+OPERATION_STATE_FAILED = 'FAILED'
+
+ +
+
+OPERATION_STATE_FINISHED = 'FINISHED'
+
+ +
+
+OPERATION_STATE_IN_PROGRESS = 'IN_PROGRESS'
+
+ +
+
+REQUEST_STATUS_CONNECTION_ERROR = 'CONNECTION_ERROR'
+
+ +
+
+REQUEST_STATUS_DATA_PATH_NOT_READY = 'DATA_PATH_NOT_READY'
+
+ +
+
+REQUEST_STATUS_SOURCE_PORT_NOT_FOUND = 'SOURCE_PORT_NOT_FOUND'
+
+ +
+
+REQUEST_STATUS_SUCCESS = 'SUCCESS'
+
+ +
+
+REQUEST_STATUS_TIMEOUT = 'TIMEOUT'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.TraceflowListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Traceflow queries result

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of Traceflow or None) – Traceflow Results +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.TraceflowObservation(component_name=None, component_sub_type=None, component_type=None, resource_type=None, sequence_no=None, timestamp=None, timestamp_micro=None, transport_node_id=None, transport_node_name=None, transport_node_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters: +
+
+
+COMPONENT_SUB_TYPE_LR_TIER0 = 'LR_TIER0'
+
+ +
+
+COMPONENT_SUB_TYPE_LR_TIER1 = 'LR_TIER1'
+
+ +
+
+COMPONENT_SUB_TYPE_LR_VRF_TIER0 = 'LR_VRF_TIER0'
+
+ +
+
+COMPONENT_SUB_TYPE_LS_TRANSIT = 'LS_TRANSIT'
+
+ +
+
+COMPONENT_SUB_TYPE_UNKNOWN = 'UNKNOWN'
+
+ +
+
+COMPONENT_TYPE_BRIDGE = 'BRIDGE'
+
+ +
+
+COMPONENT_TYPE_DFW = 'DFW'
+
+ +
+
+COMPONENT_TYPE_EDGE_HOSTSWITCH = 'EDGE_HOSTSWITCH'
+
+ +
+
+COMPONENT_TYPE_EDGE_TUNNEL = 'EDGE_TUNNEL'
+
+ +
+
+COMPONENT_TYPE_LR = 'LR'
+
+ +
+
+COMPONENT_TYPE_LS = 'LS'
+
+ +
+
+COMPONENT_TYPE_PHYSICAL = 'PHYSICAL'
+
+ +
+
+COMPONENT_TYPE_UNKNOWN = 'UNKNOWN'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONDELIVERED = 'TraceflowObservationDelivered'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPED = 'TraceflowObservationDropped'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPEDLOGICAL = 'TraceflowObservationDroppedLogical'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDED = 'TraceflowObservationForwarded'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDEDLOGICAL = 'TraceflowObservationForwardedLogical'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVED = 'TraceflowObservationReceived'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVEDLOGICAL = 'TraceflowObservationReceivedLogical'
+
+ +
+
+TRANSPORT_NODE_TYPE_EDGE = 'EDGE'
+
+ +
+
+TRANSPORT_NODE_TYPE_ESX = 'ESX'
+
+ +
+
+TRANSPORT_NODE_TYPE_HYPERV = 'HYPERV'
+
+ +
+
+TRANSPORT_NODE_TYPE_OTHERS = 'OTHERS'
+
+ +
+
+TRANSPORT_NODE_TYPE_PUBLIC_CLOUD_GATEWAY_NODE = 'PUBLIC_CLOUD_GATEWAY_NODE'
+
+ +
+
+TRANSPORT_NODE_TYPE_RHELKVM = 'RHELKVM'
+
+ +
+
+TRANSPORT_NODE_TYPE_UBUNTUKVM = 'UBUNTUKVM'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.TraceflowObservationCounters(delivered_count=None, dropped_count=None, forwarded_count=None, received_count=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • delivered_count (long or None) – Total number of delivered observations for this traceflow round. +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • dropped_count (long or None) – Total number of dropped observations for this round. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • forwarded_count (long or None) – Total number of forwarded observations for this traceflow round. +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • received_count (long or None) – Total number of received observations for this traceflow round. +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.TraceflowObservationDelivered(component_name=None, component_sub_type=None, component_type=None, resource_type=None, sequence_no=None, timestamp=None, timestamp_micro=None, transport_node_id=None, transport_node_name=None, transport_node_type=None, lport_id=None, lport_name=None, vlan_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters: +
+
+
+COMPONENT_SUB_TYPE_LR_TIER0 = 'LR_TIER0'
+
+ +
+
+COMPONENT_SUB_TYPE_LR_TIER1 = 'LR_TIER1'
+
+ +
+
+COMPONENT_SUB_TYPE_LR_VRF_TIER0 = 'LR_VRF_TIER0'
+
+ +
+
+COMPONENT_SUB_TYPE_LS_TRANSIT = 'LS_TRANSIT'
+
+ +
+
+COMPONENT_SUB_TYPE_UNKNOWN = 'UNKNOWN'
+
+ +
+
+COMPONENT_TYPE_BRIDGE = 'BRIDGE'
+
+ +
+
+COMPONENT_TYPE_DFW = 'DFW'
+
+ +
+
+COMPONENT_TYPE_EDGE_HOSTSWITCH = 'EDGE_HOSTSWITCH'
+
+ +
+
+COMPONENT_TYPE_EDGE_TUNNEL = 'EDGE_TUNNEL'
+
+ +
+
+COMPONENT_TYPE_LR = 'LR'
+
+ +
+
+COMPONENT_TYPE_LS = 'LS'
+
+ +
+
+COMPONENT_TYPE_PHYSICAL = 'PHYSICAL'
+
+ +
+
+COMPONENT_TYPE_UNKNOWN = 'UNKNOWN'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONDELIVERED = 'TraceflowObservationDelivered'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPED = 'TraceflowObservationDropped'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPEDLOGICAL = 'TraceflowObservationDroppedLogical'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDED = 'TraceflowObservationForwarded'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDEDLOGICAL = 'TraceflowObservationForwardedLogical'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVED = 'TraceflowObservationReceived'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVEDLOGICAL = 'TraceflowObservationReceivedLogical'
+
+ +
+
+TRANSPORT_NODE_TYPE_EDGE = 'EDGE'
+
+ +
+
+TRANSPORT_NODE_TYPE_ESX = 'ESX'
+
+ +
+
+TRANSPORT_NODE_TYPE_HYPERV = 'HYPERV'
+
+ +
+
+TRANSPORT_NODE_TYPE_OTHERS = 'OTHERS'
+
+ +
+
+TRANSPORT_NODE_TYPE_PUBLIC_CLOUD_GATEWAY_NODE = 'PUBLIC_CLOUD_GATEWAY_NODE'
+
+ +
+
+TRANSPORT_NODE_TYPE_RHELKVM = 'RHELKVM'
+
+ +
+
+TRANSPORT_NODE_TYPE_UBUNTUKVM = 'UBUNTUKVM'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.TraceflowObservationDropped(component_name=None, component_sub_type=None, component_type=None, resource_type=None, sequence_no=None, timestamp=None, timestamp_micro=None, transport_node_id=None, transport_node_name=None, transport_node_type=None, acl_rule_id=None, lport_id=None, lport_name=None, reason=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters: +
+
+
+COMPONENT_SUB_TYPE_LR_TIER0 = 'LR_TIER0'
+
+ +
+
+COMPONENT_SUB_TYPE_LR_TIER1 = 'LR_TIER1'
+
+ +
+
+COMPONENT_SUB_TYPE_LR_VRF_TIER0 = 'LR_VRF_TIER0'
+
+ +
+
+COMPONENT_SUB_TYPE_LS_TRANSIT = 'LS_TRANSIT'
+
+ +
+
+COMPONENT_SUB_TYPE_UNKNOWN = 'UNKNOWN'
+
+ +
+
+COMPONENT_TYPE_BRIDGE = 'BRIDGE'
+
+ +
+
+COMPONENT_TYPE_DFW = 'DFW'
+
+ +
+
+COMPONENT_TYPE_EDGE_HOSTSWITCH = 'EDGE_HOSTSWITCH'
+
+ +
+
+COMPONENT_TYPE_EDGE_TUNNEL = 'EDGE_TUNNEL'
+
+ +
+
+COMPONENT_TYPE_LR = 'LR'
+
+ +
+
+COMPONENT_TYPE_LS = 'LS'
+
+ +
+
+COMPONENT_TYPE_PHYSICAL = 'PHYSICAL'
+
+ +
+
+COMPONENT_TYPE_UNKNOWN = 'UNKNOWN'
+
+ +
+
+REASON_ARP_FAIL = 'ARP_FAIL'
+
+ +
+
+REASON_BFD = 'BFD'
+
+ +
+
+REASON_DHCP = 'DHCP'
+
+ +
+
+REASON_FW_RULE = 'FW_RULE'
+
+ +
+
+REASON_GENEVE = 'GENEVE'
+
+ +
+
+REASON_GRE = 'GRE'
+
+ +
+
+REASON_IFACE = 'IFACE'
+
+ +
+
+REASON_IP = 'IP'
+
+ +
+
+REASON_IPSEC = 'IPSEC'
+
+ +
+
+REASON_IPSEC_VTI = 'IPSEC_VTI'
+
+ +
+
+REASON_IP_REASS = 'IP_REASS'
+
+ +
+
+REASON_L2VPN = 'L2VPN'
+
+ +
+
+REASON_L4PORT = 'L4PORT'
+
+ +
+
+REASON_LB = 'LB'
+
+ +
+
+REASON_LROUTER = 'LROUTER'
+
+ +
+
+REASON_LSERVICE = 'LSERVICE'
+
+ +
+
+REASON_LSWITCH = 'LSWITCH'
+
+ +
+
+REASON_MD_PROXY = 'MD_PROXY'
+
+ +
+
+REASON_NAT = 'NAT'
+
+ +
+
+REASON_NEIGH = 'NEIGH'
+
+ +
+
+REASON_NO_ROUTE = 'NO_ROUTE'
+
+ +
+
+REASON_SERVICE_INSERT = 'SERVICE_INSERT'
+
+ +
+
+REASON_TTL_ZERO = 'TTL_ZERO'
+
+ +
+
+REASON_TUNNEL = 'TUNNEL'
+
+ +
+
+REASON_UNKNOWN = 'UNKNOWN'
+
+ +
+
+REASON_VXLAN = 'VXLAN'
+
+ +
+
+REASON_VXSTT = 'VXSTT'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONDELIVERED = 'TraceflowObservationDelivered'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPED = 'TraceflowObservationDropped'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPEDLOGICAL = 'TraceflowObservationDroppedLogical'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDED = 'TraceflowObservationForwarded'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDEDLOGICAL = 'TraceflowObservationForwardedLogical'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVED = 'TraceflowObservationReceived'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVEDLOGICAL = 'TraceflowObservationReceivedLogical'
+
+ +
+
+TRANSPORT_NODE_TYPE_EDGE = 'EDGE'
+
+ +
+
+TRANSPORT_NODE_TYPE_ESX = 'ESX'
+
+ +
+
+TRANSPORT_NODE_TYPE_HYPERV = 'HYPERV'
+
+ +
+
+TRANSPORT_NODE_TYPE_OTHERS = 'OTHERS'
+
+ +
+
+TRANSPORT_NODE_TYPE_PUBLIC_CLOUD_GATEWAY_NODE = 'PUBLIC_CLOUD_GATEWAY_NODE'
+
+ +
+
+TRANSPORT_NODE_TYPE_RHELKVM = 'RHELKVM'
+
+ +
+
+TRANSPORT_NODE_TYPE_UBUNTUKVM = 'UBUNTUKVM'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.TraceflowObservationDroppedLogical(component_name=None, component_sub_type=None, component_type=None, resource_type=None, sequence_no=None, timestamp=None, timestamp_micro=None, transport_node_id=None, transport_node_name=None, transport_node_type=None, acl_rule_id=None, lport_id=None, lport_name=None, reason=None, component_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters: +
+
+
+COMPONENT_SUB_TYPE_LR_TIER0 = 'LR_TIER0'
+
+ +
+
+COMPONENT_SUB_TYPE_LR_TIER1 = 'LR_TIER1'
+
+ +
+
+COMPONENT_SUB_TYPE_LR_VRF_TIER0 = 'LR_VRF_TIER0'
+
+ +
+
+COMPONENT_SUB_TYPE_LS_TRANSIT = 'LS_TRANSIT'
+
+ +
+
+COMPONENT_SUB_TYPE_UNKNOWN = 'UNKNOWN'
+
+ +
+
+COMPONENT_TYPE_BRIDGE = 'BRIDGE'
+
+ +
+
+COMPONENT_TYPE_DFW = 'DFW'
+
+ +
+
+COMPONENT_TYPE_EDGE_HOSTSWITCH = 'EDGE_HOSTSWITCH'
+
+ +
+
+COMPONENT_TYPE_EDGE_TUNNEL = 'EDGE_TUNNEL'
+
+ +
+
+COMPONENT_TYPE_LR = 'LR'
+
+ +
+
+COMPONENT_TYPE_LS = 'LS'
+
+ +
+
+COMPONENT_TYPE_PHYSICAL = 'PHYSICAL'
+
+ +
+
+COMPONENT_TYPE_UNKNOWN = 'UNKNOWN'
+
+ +
+
+REASON_ARP_FAIL = 'ARP_FAIL'
+
+ +
+
+REASON_BFD = 'BFD'
+
+ +
+
+REASON_DHCP = 'DHCP'
+
+ +
+
+REASON_FW_RULE = 'FW_RULE'
+
+ +
+
+REASON_GENEVE = 'GENEVE'
+
+ +
+
+REASON_GRE = 'GRE'
+
+ +
+
+REASON_IFACE = 'IFACE'
+
+ +
+
+REASON_IP = 'IP'
+
+ +
+
+REASON_IPSEC = 'IPSEC'
+
+ +
+
+REASON_IPSEC_VTI = 'IPSEC_VTI'
+
+ +
+
+REASON_IP_REASS = 'IP_REASS'
+
+ +
+
+REASON_L2VPN = 'L2VPN'
+
+ +
+
+REASON_L4PORT = 'L4PORT'
+
+ +
+
+REASON_LB = 'LB'
+
+ +
+
+REASON_LROUTER = 'LROUTER'
+
+ +
+
+REASON_LSERVICE = 'LSERVICE'
+
+ +
+
+REASON_LSWITCH = 'LSWITCH'
+
+ +
+
+REASON_MD_PROXY = 'MD_PROXY'
+
+ +
+
+REASON_NAT = 'NAT'
+
+ +
+
+REASON_NEIGH = 'NEIGH'
+
+ +
+
+REASON_NO_ROUTE = 'NO_ROUTE'
+
+ +
+
+REASON_SERVICE_INSERT = 'SERVICE_INSERT'
+
+ +
+
+REASON_TTL_ZERO = 'TTL_ZERO'
+
+ +
+
+REASON_TUNNEL = 'TUNNEL'
+
+ +
+
+REASON_UNKNOWN = 'UNKNOWN'
+
+ +
+
+REASON_VXLAN = 'VXLAN'
+
+ +
+
+REASON_VXSTT = 'VXSTT'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONDELIVERED = 'TraceflowObservationDelivered'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPED = 'TraceflowObservationDropped'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPEDLOGICAL = 'TraceflowObservationDroppedLogical'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDED = 'TraceflowObservationForwarded'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDEDLOGICAL = 'TraceflowObservationForwardedLogical'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVED = 'TraceflowObservationReceived'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVEDLOGICAL = 'TraceflowObservationReceivedLogical'
+
+ +
+
+TRANSPORT_NODE_TYPE_EDGE = 'EDGE'
+
+ +
+
+TRANSPORT_NODE_TYPE_ESX = 'ESX'
+
+ +
+
+TRANSPORT_NODE_TYPE_HYPERV = 'HYPERV'
+
+ +
+
+TRANSPORT_NODE_TYPE_OTHERS = 'OTHERS'
+
+ +
+
+TRANSPORT_NODE_TYPE_PUBLIC_CLOUD_GATEWAY_NODE = 'PUBLIC_CLOUD_GATEWAY_NODE'
+
+ +
+
+TRANSPORT_NODE_TYPE_RHELKVM = 'RHELKVM'
+
+ +
+
+TRANSPORT_NODE_TYPE_UBUNTUKVM = 'UBUNTUKVM'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.TraceflowObservationForwarded(component_name=None, component_sub_type=None, component_type=None, resource_type=None, sequence_no=None, timestamp=None, timestamp_micro=None, transport_node_id=None, transport_node_name=None, transport_node_type=None, context=None, dst_transport_node_id=None, dst_transport_node_name=None, local_ip_address=None, remote_ip_address=None, uplink_name=None, vtep_label=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters: +
+
+
+COMPONENT_SUB_TYPE_LR_TIER0 = 'LR_TIER0'
+
+ +
+
+COMPONENT_SUB_TYPE_LR_TIER1 = 'LR_TIER1'
+
+ +
+
+COMPONENT_SUB_TYPE_LR_VRF_TIER0 = 'LR_VRF_TIER0'
+
+ +
+
+COMPONENT_SUB_TYPE_LS_TRANSIT = 'LS_TRANSIT'
+
+ +
+
+COMPONENT_SUB_TYPE_UNKNOWN = 'UNKNOWN'
+
+ +
+
+COMPONENT_TYPE_BRIDGE = 'BRIDGE'
+
+ +
+
+COMPONENT_TYPE_DFW = 'DFW'
+
+ +
+
+COMPONENT_TYPE_EDGE_HOSTSWITCH = 'EDGE_HOSTSWITCH'
+
+ +
+
+COMPONENT_TYPE_EDGE_TUNNEL = 'EDGE_TUNNEL'
+
+ +
+
+COMPONENT_TYPE_LR = 'LR'
+
+ +
+
+COMPONENT_TYPE_LS = 'LS'
+
+ +
+
+COMPONENT_TYPE_PHYSICAL = 'PHYSICAL'
+
+ +
+
+COMPONENT_TYPE_UNKNOWN = 'UNKNOWN'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONDELIVERED = 'TraceflowObservationDelivered'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPED = 'TraceflowObservationDropped'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPEDLOGICAL = 'TraceflowObservationDroppedLogical'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDED = 'TraceflowObservationForwarded'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDEDLOGICAL = 'TraceflowObservationForwardedLogical'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVED = 'TraceflowObservationReceived'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVEDLOGICAL = 'TraceflowObservationReceivedLogical'
+
+ +
+
+TRANSPORT_NODE_TYPE_EDGE = 'EDGE'
+
+ +
+
+TRANSPORT_NODE_TYPE_ESX = 'ESX'
+
+ +
+
+TRANSPORT_NODE_TYPE_HYPERV = 'HYPERV'
+
+ +
+
+TRANSPORT_NODE_TYPE_OTHERS = 'OTHERS'
+
+ +
+
+TRANSPORT_NODE_TYPE_PUBLIC_CLOUD_GATEWAY_NODE = 'PUBLIC_CLOUD_GATEWAY_NODE'
+
+ +
+
+TRANSPORT_NODE_TYPE_RHELKVM = 'RHELKVM'
+
+ +
+
+TRANSPORT_NODE_TYPE_UBUNTUKVM = 'UBUNTUKVM'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.TraceflowObservationForwardedLogical(component_name=None, component_sub_type=None, component_type=None, resource_type=None, sequence_no=None, timestamp=None, timestamp_micro=None, transport_node_id=None, transport_node_name=None, transport_node_type=None, acl_rule_id=None, component_id=None, dst_component_id=None, dst_component_name=None, dst_component_type=None, lport_id=None, lport_name=None, vni=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters: +
+
+
+COMPONENT_SUB_TYPE_LR_TIER0 = 'LR_TIER0'
+
+ +
+
+COMPONENT_SUB_TYPE_LR_TIER1 = 'LR_TIER1'
+
+ +
+
+COMPONENT_SUB_TYPE_LR_VRF_TIER0 = 'LR_VRF_TIER0'
+
+ +
+
+COMPONENT_SUB_TYPE_LS_TRANSIT = 'LS_TRANSIT'
+
+ +
+
+COMPONENT_SUB_TYPE_UNKNOWN = 'UNKNOWN'
+
+ +
+
+COMPONENT_TYPE_BRIDGE = 'BRIDGE'
+
+ +
+
+COMPONENT_TYPE_DFW = 'DFW'
+
+ +
+
+COMPONENT_TYPE_EDGE_HOSTSWITCH = 'EDGE_HOSTSWITCH'
+
+ +
+
+COMPONENT_TYPE_EDGE_TUNNEL = 'EDGE_TUNNEL'
+
+ +
+
+COMPONENT_TYPE_LR = 'LR'
+
+ +
+
+COMPONENT_TYPE_LS = 'LS'
+
+ +
+
+COMPONENT_TYPE_PHYSICAL = 'PHYSICAL'
+
+ +
+
+COMPONENT_TYPE_UNKNOWN = 'UNKNOWN'
+
+ +
+
+DST_COMPONENT_TYPE_BRIDGE = 'BRIDGE'
+
+ +
+
+DST_COMPONENT_TYPE_DFW = 'DFW'
+
+ +
+
+DST_COMPONENT_TYPE_EDGE_HOSTSWITCH = 'EDGE_HOSTSWITCH'
+
+ +
+
+DST_COMPONENT_TYPE_EDGE_TUNNEL = 'EDGE_TUNNEL'
+
+ +
+
+DST_COMPONENT_TYPE_LR = 'LR'
+
+ +
+
+DST_COMPONENT_TYPE_LS = 'LS'
+
+ +
+
+DST_COMPONENT_TYPE_PHYSICAL = 'PHYSICAL'
+
+ +
+
+DST_COMPONENT_TYPE_UNKNOWN = 'UNKNOWN'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONDELIVERED = 'TraceflowObservationDelivered'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPED = 'TraceflowObservationDropped'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPEDLOGICAL = 'TraceflowObservationDroppedLogical'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDED = 'TraceflowObservationForwarded'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDEDLOGICAL = 'TraceflowObservationForwardedLogical'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVED = 'TraceflowObservationReceived'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVEDLOGICAL = 'TraceflowObservationReceivedLogical'
+
+ +
+
+TRANSPORT_NODE_TYPE_EDGE = 'EDGE'
+
+ +
+
+TRANSPORT_NODE_TYPE_ESX = 'ESX'
+
+ +
+
+TRANSPORT_NODE_TYPE_HYPERV = 'HYPERV'
+
+ +
+
+TRANSPORT_NODE_TYPE_OTHERS = 'OTHERS'
+
+ +
+
+TRANSPORT_NODE_TYPE_PUBLIC_CLOUD_GATEWAY_NODE = 'PUBLIC_CLOUD_GATEWAY_NODE'
+
+ +
+
+TRANSPORT_NODE_TYPE_RHELKVM = 'RHELKVM'
+
+ +
+
+TRANSPORT_NODE_TYPE_UBUNTUKVM = 'UBUNTUKVM'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.TraceflowObservationListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of TraceflowObservation or None) – TraceflowObservation list results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.TraceflowObservationReceived(component_name=None, component_sub_type=None, component_type=None, resource_type=None, sequence_no=None, timestamp=None, timestamp_micro=None, transport_node_id=None, transport_node_name=None, transport_node_type=None, local_ip_address=None, remote_ip_address=None, uplink_name=None, vtep_label=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters: +
+
+
+COMPONENT_SUB_TYPE_LR_TIER0 = 'LR_TIER0'
+
+ +
+
+COMPONENT_SUB_TYPE_LR_TIER1 = 'LR_TIER1'
+
+ +
+
+COMPONENT_SUB_TYPE_LR_VRF_TIER0 = 'LR_VRF_TIER0'
+
+ +
+
+COMPONENT_SUB_TYPE_LS_TRANSIT = 'LS_TRANSIT'
+
+ +
+
+COMPONENT_SUB_TYPE_UNKNOWN = 'UNKNOWN'
+
+ +
+
+COMPONENT_TYPE_BRIDGE = 'BRIDGE'
+
+ +
+
+COMPONENT_TYPE_DFW = 'DFW'
+
+ +
+
+COMPONENT_TYPE_EDGE_HOSTSWITCH = 'EDGE_HOSTSWITCH'
+
+ +
+
+COMPONENT_TYPE_EDGE_TUNNEL = 'EDGE_TUNNEL'
+
+ +
+
+COMPONENT_TYPE_LR = 'LR'
+
+ +
+
+COMPONENT_TYPE_LS = 'LS'
+
+ +
+
+COMPONENT_TYPE_PHYSICAL = 'PHYSICAL'
+
+ +
+
+COMPONENT_TYPE_UNKNOWN = 'UNKNOWN'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONDELIVERED = 'TraceflowObservationDelivered'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPED = 'TraceflowObservationDropped'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPEDLOGICAL = 'TraceflowObservationDroppedLogical'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDED = 'TraceflowObservationForwarded'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDEDLOGICAL = 'TraceflowObservationForwardedLogical'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVED = 'TraceflowObservationReceived'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVEDLOGICAL = 'TraceflowObservationReceivedLogical'
+
+ +
+
+TRANSPORT_NODE_TYPE_EDGE = 'EDGE'
+
+ +
+
+TRANSPORT_NODE_TYPE_ESX = 'ESX'
+
+ +
+
+TRANSPORT_NODE_TYPE_HYPERV = 'HYPERV'
+
+ +
+
+TRANSPORT_NODE_TYPE_OTHERS = 'OTHERS'
+
+ +
+
+TRANSPORT_NODE_TYPE_PUBLIC_CLOUD_GATEWAY_NODE = 'PUBLIC_CLOUD_GATEWAY_NODE'
+
+ +
+
+TRANSPORT_NODE_TYPE_RHELKVM = 'RHELKVM'
+
+ +
+
+TRANSPORT_NODE_TYPE_UBUNTUKVM = 'UBUNTUKVM'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.TraceflowObservationReceivedLogical(component_name=None, component_sub_type=None, component_type=None, resource_type=None, sequence_no=None, timestamp=None, timestamp_micro=None, transport_node_id=None, transport_node_name=None, transport_node_type=None, component_id=None, lport_id=None, lport_name=None, src_component_id=None, src_component_name=None, src_component_type=None, vni=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters: +
+
+
+COMPONENT_SUB_TYPE_LR_TIER0 = 'LR_TIER0'
+
+ +
+
+COMPONENT_SUB_TYPE_LR_TIER1 = 'LR_TIER1'
+
+ +
+
+COMPONENT_SUB_TYPE_LR_VRF_TIER0 = 'LR_VRF_TIER0'
+
+ +
+
+COMPONENT_SUB_TYPE_LS_TRANSIT = 'LS_TRANSIT'
+
+ +
+
+COMPONENT_SUB_TYPE_UNKNOWN = 'UNKNOWN'
+
+ +
+
+COMPONENT_TYPE_BRIDGE = 'BRIDGE'
+
+ +
+
+COMPONENT_TYPE_DFW = 'DFW'
+
+ +
+
+COMPONENT_TYPE_EDGE_HOSTSWITCH = 'EDGE_HOSTSWITCH'
+
+ +
+
+COMPONENT_TYPE_EDGE_TUNNEL = 'EDGE_TUNNEL'
+
+ +
+
+COMPONENT_TYPE_LR = 'LR'
+
+ +
+
+COMPONENT_TYPE_LS = 'LS'
+
+ +
+
+COMPONENT_TYPE_PHYSICAL = 'PHYSICAL'
+
+ +
+
+COMPONENT_TYPE_UNKNOWN = 'UNKNOWN'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONDELIVERED = 'TraceflowObservationDelivered'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPED = 'TraceflowObservationDropped'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPEDLOGICAL = 'TraceflowObservationDroppedLogical'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDED = 'TraceflowObservationForwarded'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDEDLOGICAL = 'TraceflowObservationForwardedLogical'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVED = 'TraceflowObservationReceived'
+
+ +
+
+RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVEDLOGICAL = 'TraceflowObservationReceivedLogical'
+
+ +
+
+SRC_COMPONENT_TYPE_BRIDGE = 'BRIDGE'
+
+ +
+
+SRC_COMPONENT_TYPE_DFW = 'DFW'
+
+ +
+
+SRC_COMPONENT_TYPE_EDGE_HOSTSWITCH = 'EDGE_HOSTSWITCH'
+
+ +
+
+SRC_COMPONENT_TYPE_EDGE_TUNNEL = 'EDGE_TUNNEL'
+
+ +
+
+SRC_COMPONENT_TYPE_LR = 'LR'
+
+ +
+
+SRC_COMPONENT_TYPE_LS = 'LS'
+
+ +
+
+SRC_COMPONENT_TYPE_PHYSICAL = 'PHYSICAL'
+
+ +
+
+SRC_COMPONENT_TYPE_UNKNOWN = 'UNKNOWN'
+
+ +
+
+TRANSPORT_NODE_TYPE_EDGE = 'EDGE'
+
+ +
+
+TRANSPORT_NODE_TYPE_ESX = 'ESX'
+
+ +
+
+TRANSPORT_NODE_TYPE_HYPERV = 'HYPERV'
+
+ +
+
+TRANSPORT_NODE_TYPE_OTHERS = 'OTHERS'
+
+ +
+
+TRANSPORT_NODE_TYPE_PUBLIC_CLOUD_GATEWAY_NODE = 'PUBLIC_CLOUD_GATEWAY_NODE'
+
+ +
+
+TRANSPORT_NODE_TYPE_RHELKVM = 'RHELKVM'
+
+ +
+
+TRANSPORT_NODE_TYPE_UBUNTUKVM = 'UBUNTUKVM'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.TraceflowRequest(lport_id=None, packet=None, timeout=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • lport_id (str) – id of the source logical port to inject the traceflow packet into
    • +
  • packet (PacketData) – Packet configuration
    • +
  • timeout (long or None) – Maximum time (in ms) the management plane will wait for observation +result list to be sent by controller plane. format: int64
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.TransportNode(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, host_switch_spec=None, host_switches=None, maintenance_mode=None, node_id=None, transport_zone_endpoints=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Transport Node

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • host_switch_spec (vmware.vapi.struct.VapiStruct or None) – This property is used to either create standard host switches or to +inform NSX about preconfigured host switches that already exist on +the transport node. Pass an array of either StandardHostSwitchSpec +objects or PreconfiguredHostSwitchSpec objects. It is an error to +pass an array containing different types of HostSwitchSpec objects. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +HostSwitchSpec. When methods return a value of this class +as a return value, the attribute will contain all the attributes +defined in HostSwitchSpec.
    • +
  • host_switches (list of HostSwitch or None) – This property is deprecated in favor of ‘host_switch_spec’. +Property ‘host_switches’ can only be used for NSX managed transport +nodes. ‘host_switch_spec’ can be used for both NSX managed or +manually preconfigured host switches.
    • +
  • maintenance_mode (str or None) –

    Possible values are:

    + +

    The property is read-only, used for querying result. User could +update transport node maintenance mode by +UpdateTransportNodeMaintenanceMode call. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • node_id (str) – Unique Id of the fabric node
    • +
  • transport_zone_endpoints (list of TransportZoneEndPoint or None) – Transport zone endpoints.
    • +
+
+
+
+MAINTENANCE_MODE_DISABLED = 'DISABLED'
+
+ +
+
+MAINTENANCE_MODE_ENABLED = 'ENABLED'
+
+ +
+
+MAINTENANCE_MODE_FORCE_ENABLED = 'FORCE_ENABLED'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.TransportNodeListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Transport Node queries result

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of TransportNode or None) – TransportNode Results +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.TransportNodeState(details=None, failure_code=None, failure_message=None, state=None, host_switch_states=None, maintenance_mode_state=None, transport_node_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Transport Node State

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters: +
+
+
+MAINTENANCE_MODE_STATE_DISABLED = 'DISABLED'
+
+ +
+
+MAINTENANCE_MODE_STATE_ENABLED = 'ENABLED'
+
+ +
+
+MAINTENANCE_MODE_STATE_ENTERING = 'ENTERING'
+
+ +
+
+MAINTENANCE_MODE_STATE_EXITING = 'EXITING'
+
+ +
+
+STATE_FAILED = 'failed'
+
+ +
+
+STATE_IN_PROGRESS = 'in_progress'
+
+ +
+
+STATE_ORPHANED = 'orphaned'
+
+ +
+
+STATE_PARTIAL_SUCCESS = 'partial_success'
+
+ +
+
+STATE_PENDING = 'pending'
+
+ +
+
+STATE_SUCCESS = 'success'
+
+ +
+
+STATE_UNKNOWN = 'unknown'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.TransportNodeStateListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Transport node state queries result

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of TransportNodeState or None) – Transport Node State Results +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.TransportNodeStatus(control_connection_status=None, mgmt_connection_status=None, node_display_name=None, node_uuid=None, pnic_status=None, status=None, tunnel_status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters: +
+
+
+MGMT_CONNECTION_STATUS_DOWN = 'DOWN'
+
+ +
+
+MGMT_CONNECTION_STATUS_UP = 'UP'
+
+ +
+
+STATUS_DEGRADED = 'DEGRADED'
+
+ +
+
+STATUS_DOWN = 'DOWN'
+
+ +
+
+STATUS_UNKNOWN = 'UNKNOWN'
+
+ +
+
+STATUS_UP = 'UP'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.TransportNodeStatusListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of TransportNodeStatus or None) – List of transport node statuses
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.TransportNodeTemplateListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Compute collection transport node template list result

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of ComputeCollectionTransportNodeTemplate or None) – Compute collection transport node template results +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.TransportNodeTemplateState(node_id=None, state=None, transport_node_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

transport node template application state

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters: +
+
+
+STATE_FAILED_TO_CREATE = 'FAILED_TO_CREATE'
+
+ +
+
+STATE_FAILED_TO_REALIZE = 'FAILED_TO_REALIZE'
+
+ +
+
+STATE_IN_PROGRESS = 'IN_PROGRESS'
+
+ +
+
+STATE_SUCCESS = 'SUCCESS'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.TransportProtocolHeader(dhcp_header=None, dns_header=None, icmp_echo_request_header=None, tcp_header=None, udp_header=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters: +
+
+ +
+
+class com.vmware.nsx.model_client.TransportZone(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, host_switch_id=None, host_switch_mode=None, host_switch_name=None, nested_nsx=None, transport_type=None, transport_zone_profile_ids=None, uplink_teaming_policy_names=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • host_switch_id (str or None) – the host switch id generated by the system. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • host_switch_mode (str or None) –

    Possible values are:

    + +

    STANDARD mode applies to all the hypervisors. ENS mode stands for +Enhanced Networking Stack. This feature is only available for ESX +hypervisor. It is not available on KVM, EDGE and Public Cloud +Gateway etc. When a Transport Zone mode is set to ENS, only +Transport Nodes of type ESX can participate in such a Transport +Zone.

    +
    • +
  • host_switch_name (str or None) – If this name is unset or empty then the default host switch name +will be used.
    • +
  • nested_nsx (bool or None) – The flag only need to be set in nested NSX environment.
    • +
  • transport_type (str) –

    Possible values are:

    + +
    +
    The transport type of this transport zone.
    +
    • +
  • transport_zone_profile_ids (list of TransportZoneProfileTypeIdEntry or None) – Identifiers of the transport zone profiles associated with this +TransportZone.
    • +
  • uplink_teaming_policy_names (list of str or None) – The names of switching uplink teaming policies that all transport +nodes in this transport zone must support. An exception will be +thrown if a transport node within the transport zone does not +support a named teaming policy. The user will need to first ensure +all trasnport nodes support the desired named teaming policy before +assigning it to the transport zone. If the field is not specified, +the host switch’s default teaming policy will be used.
    • +
+
+
+
+HOST_SWITCH_MODE_ENS = 'ENS'
+
+ +
+
+HOST_SWITCH_MODE_STANDARD = 'STANDARD'
+
+ +
+
+TRANSPORT_TYPE_OVERLAY = 'OVERLAY'
+
+ +
+
+TRANSPORT_TYPE_VLAN = 'VLAN'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.TransportZoneEndPoint(transport_zone_id=None, transport_zone_profile_ids=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Specify which HostSwitch from this TransportNode is used handle traffic for +given TransportZone

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • transport_zone_id (str) – Unique ID identifying the transport zone for this endpoint
    • +
  • transport_zone_profile_ids (list of TransportZoneProfileTypeIdEntry or None) – Identifiers of the transport zone profiles associated with this +transport zone endpoint on this transport node.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.TransportZoneListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Transport zone queries result

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of TransportZone) – Transport Zone Results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.TransportZoneProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='TransportZoneProfile', tags=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
+
+
+
+RESOURCE_TYPE_BFDHEALTHMONITORINGPROFILE = 'BfdHealthMonitoringProfile'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.TransportZoneProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Transport zone profile queries result

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of vmware.vapi.struct.VapiStruct or None) – Transport zone profile results +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +TransportZoneProfile. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in TransportZoneProfile. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.TransportZoneProfileTypeIdEntry(profile_id=None, resource_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters: +
+
+
+RESOURCE_TYPE_BFDHEALTHMONITORINGPROFILE = 'BfdHealthMonitoringProfile'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.TransportZoneStatus(num_logical_ports=None, num_logical_switches=None, num_transport_nodes=None, transport_zone_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Transport zone runtime status information

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • num_logical_ports (long or None) – Count of logical ports in the transport zone format: int32 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • num_logical_switches (long or None) – Count of logical switches in the transport zone format: int32 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • num_transport_nodes (long or None) – Count of transport nodes in the transport zone format: int32 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • transport_zone_id (str or None) – Unique ID identifying the transport zone +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.TransportZoneStatusListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Transport zone runtime status queries result

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of TransportZoneStatus) – Transport Zone Runtime Status Info Results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.TrunkVlanRange(end=None, start=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Trunk VLAN id range

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • end (long) – Virtual Local Area Network Identifier format: int64
    • +
  • start (long) – Virtual Local Area Network Identifier format: int64
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.TrustManagementData(supported_algorithms=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:supported_algorithms (list of CryptoAlgorithm or None) – list of supported algorithms +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
+
+ +
+
+class com.vmware.nsx.model_client.TrustObjectData(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, key_algo=None, passphrase=None, pem_encoded=None, private_key=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • key_algo (str or None) – Key algorithm contained in this certificate
    • +
  • passphrase (str or None) – Password for private key encryption
    • +
  • pem_encoded (str) – pem encoded certificate data
    • +
  • private_key (str or None) – private key data
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.TunnelList(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, tunnels=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • tunnels (list of TunnelProperties or None) – List of transport node tunnels +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.TunnelPortConfig(ip_subnets=None, tunnel_port_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

IP Tunnel port configuration.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • ip_subnets (list of IPSubnet) – IP Tunnel port (commonly referred as VTI) subnet.
    • +
  • tunnel_port_id (str or None) – Logical route port identifier. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.TunnelProperties(links=None, schema=None, self_=None, bfd=None, egress_interface=None, encap=None, last_updated_time=None, local_ip=None, name=None, remote_ip=None, remote_node_display_name=None, remote_node_id=None, status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • bfd (BFDProperties or None) – Detailed information about BFD configured on interface
    • +
  • egress_interface (str or None) – Corresponds to the interface where local_ip_address is routed. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • encap (str or None) –

    Possible values are:

    + +
    +
    Tunnel encap
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • last_updated_time (long or None) – Time at which the Tunnel status has been fetched last time. format: +int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • local_ip (str or None) – Local IP address of tunnel format: ip +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • name (str or None) – Name of tunnel +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • remote_ip (str or None) – Remote IP address of tunnel format: ip +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • remote_node_display_name (str or None) – Represents the display name of the remote transport node at the +other end of the tunnel. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • remote_node_id (str or None) – UUID of the remote transport node +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • status (str or None) –

    Possible values are:

    + +
    +
    Status of tunnel
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
+
+
+
+ENCAP_GENEVE = 'GENEVE'
+
+ +
+
+ENCAP_STT = 'STT'
+
+ +
+
+ENCAP_UNKNOWN_ENCAP = 'UNKNOWN_ENCAP'
+
+ +
+
+ENCAP_VXLAN = 'VXLAN'
+
+ +
+
+STATUS_DOWN = 'DOWN'
+
+ +
+
+STATUS_UNKNOWN = 'UNKNOWN'
+
+ +
+
+STATUS_UP = 'UP'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.TunnelStatusCount(degraded_count=None, down_count=None, status=None, up_count=None, bfd_diagnostic=None, bfd_status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters: +
+
+
+STATUS_DEGRADED = 'DEGRADED'
+
+ +
+
+STATUS_DOWN = 'DOWN'
+
+ +
+
+STATUS_UNKNOWN = 'UNKNOWN'
+
+ +
+
+STATUS_UP = 'UP'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.TypeGroup(count=None, group_by_field_value=None, hits=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • count (long) – Total count per group by field value format: int64
    • +
  • group_by_field_value (str) – Group By Field Value
    • +
  • hits (list of vmware.vapi.struct.VapiStruct or None) – Hits per resource type
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.UdpHeader(dst_port=None, src_port=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • dst_port (long or None) – Destination port of udp header format: int64
    • +
  • src_port (long or None) – Source port of udp header format: int64
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.UnassociatedVMListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, last_update_timestamp=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_update_timestamp (long or None) – Timestamp in milliseconds since epoch format: int64
    • +
  • results (list of VirtualMachine) – List of VMs which are not associated with any NSGroup
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.UpdatePrincipalIdentityCertificateRequest(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, certificate_id=None, principal_identity_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Request to update the certificate of a principal identity with a new +certificate

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • certificate_id (str) – Id of the stored certificate
    • +
  • principal_identity_id (str) – Unique ID of the principal
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.UpgradeBundleFetchRequest(url=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

URL and other fetch requests of upgrade bundle

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:url (str) – URL for uploading upgrade bundle
+
+ +
+
+class com.vmware.nsx.model_client.UpgradeBundleId(bundle_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Identifier of the upgrade bundle

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:bundle_id (str or None) – Identifier of bundle upload +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
+
+ +
+
+class com.vmware.nsx.model_client.UpgradeBundleInfo(bundle_size=None, url=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Information about the upgrade bundle

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • bundle_size (str or None) – size of upgrade bundle +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • url (str or None) – URL for uploading upgrade bundle +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.UpgradeBundleUploadStatus(detailed_status=None, percent=None, status=None, url=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Upload status of upgrade bundle uploaded from url

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • detailed_status (str or None) – Detailed status of upgrade bundle upload +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • percent (float or None) – Percent of bundle uploaded from URL +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • status (str or None) –

    Possible values are:

    + +
    +
    Current status of upgrade bundle upload
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • url (str or None) – URL for uploading upgrade bundle +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+
+STATUS_FAILED = 'FAILED'
+
+ +
+
+STATUS_SUCCESS = 'SUCCESS'
+
+ +
+
+STATUS_UPLOADING = 'UPLOADING'
+
+ +
+
+STATUS_VERIFYING = 'VERIFYING'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.UpgradeHistory(initial_version=None, target_version=None, timestamp=None, upgrade_status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters: +
+
+
+UPGRADE_STATUS_FAILED = 'FAILED'
+
+ +
+
+UPGRADE_STATUS_STARTED = 'STARTED'
+
+ +
+
+UPGRADE_STATUS_SUCCESS = 'SUCCESS'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.UpgradeHistoryList(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of UpgradeHistory or None) – Upgrade history list +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.UpgradePlanSettings(parallel=None, pause_after_each_group=None, pause_on_error=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • parallel (bool or None) – Upgrade Method to specify whether the upgrade is to be performed +serially or in parallel
    • +
  • pause_after_each_group (bool or None) – Flag to indicate whether to pause the upgrade after upgrade of each +group is completed
    • +
  • pause_on_error (bool or None) – Flag to indicate whether to pause the upgrade plan execution when +an error occurs
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.UpgradeStatus(ccp_status=None, component_status=None, edge_status=None, host_status=None, overall_upgrade_status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters: +
+
+
+OVERALL_UPGRADE_STATUS_FAILED = 'FAILED'
+
+ +
+
+OVERALL_UPGRADE_STATUS_IN_PROGRESS = 'IN_PROGRESS'
+
+ +
+
+OVERALL_UPGRADE_STATUS_NOT_STARTED = 'NOT_STARTED'
+
+ +
+
+OVERALL_UPGRADE_STATUS_PAUSED = 'PAUSED'
+
+ +
+
+OVERALL_UPGRADE_STATUS_SUCCESS = 'SUCCESS'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.UpgradeSummary(component_target_versions=None, system_version=None, target_version=None, upgrade_bundle_file_name=None, upgrade_coordinator_updated=None, upgrade_coordinator_version=None, upgrade_status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • component_target_versions (list of ComponentTargetVersion or None) –
    • +
  • system_version (str or None) – Current system version +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • target_version (str or None) – Target system version +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • upgrade_bundle_file_name (str or None) – Name of the last successfully uploaded upgrade bundle file +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • upgrade_coordinator_updated (bool or None) – Has upgrade coordinator been updated after upload of upgrade bundle +file +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • upgrade_coordinator_version (str or None) – Current version of upgrade coordinator +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • upgrade_status (str or None) –

    Possible values are:

    + +
    +
    Status of upgrade
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
+
+
+
+UPGRADE_STATUS_FAILED = 'FAILED'
+
+ +
+
+UPGRADE_STATUS_IN_PROGRESS = 'IN_PROGRESS'
+
+ +
+
+UPGRADE_STATUS_NOT_STARTED = 'NOT_STARTED'
+
+ +
+
+UPGRADE_STATUS_PAUSED = 'PAUSED'
+
+ +
+
+UPGRADE_STATUS_SUCCESS = 'SUCCESS'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.UpgradeUnit(links=None, schema=None, self_=None, current_version=None, display_name=None, group=None, id=None, metadata=None, type=None, warnings=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • current_version (str or None) – This is component version e.g. if upgrade unit is of type edge, +then this is edge version. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • display_name (str or None) – Name of the upgrade unit
    • +
  • group (UpgradeUnitGroupInfo or None) – Info of the group to which this upgrade unit belongs
    • +
  • id (str or None) – Identifier of the upgrade unit +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • metadata (list of KeyValuePair or None) – Metadata about upgrade unit +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • type (str or None) – Upgrade unit type
    • +
  • warnings (list of str or None) – List of warnings indicating issues with the upgrade unit that may +result in upgrade failure +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.UpgradeUnitAggregateInfo(links=None, schema=None, self_=None, current_version=None, display_name=None, errors=None, group=None, id=None, metadata=None, percent_complete=None, status=None, type=None, warnings=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • current_version (str or None) – This is component version e.g. if upgrade unit is of type edge, +then this is edge version. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • display_name (str or None) – Name of the upgrade unit
    • +
  • errors (list of str or None) – List of errors occurred during upgrade of this upgrade unit +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • group (UpgradeUnitGroupInfo or None) – Info of the group to which this upgrade unit belongs
    • +
  • id (str or None) – Identifier of the upgrade unit +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • metadata (list of KeyValuePair or None) – Metadata about upgrade unit +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • percent_complete (float or None) – Indicator of upgrade progress in percentage +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • status (str or None) –

    Possible values are:

    + +
    +
    Status of upgrade unit
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • type (str or None) – Upgrade unit type
    • +
  • warnings (list of str or None) – List of warnings indicating issues with the upgrade unit that may +result in upgrade failure +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+
+STATUS_FAILED = 'FAILED'
+
+ +
+
+STATUS_IN_PROGRESS = 'IN_PROGRESS'
+
+ +
+
+STATUS_NOT_STARTED = 'NOT_STARTED'
+
+ +
+
+STATUS_PAUSED = 'PAUSED'
+
+ +
+
+STATUS_SUCCESS = 'SUCCESS'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.UpgradeUnitAggregateInfoListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of UpgradeUnitAggregateInfo or None) – Paged collection of UpgradeUnit AggregateInfo +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.UpgradeUnitGroup(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, enabled=None, extended_configuration=None, parallel=None, type=None, upgrade_unit_count=None, upgrade_units=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • enabled (bool or None) – Flag to indicate whether upgrade of this group is enabled or not
    • +
  • extended_configuration (list of KeyValuePair or None) – Extended configuration for the group
    • +
  • parallel (bool or None) – Upgrade method to specify whether the upgrade is to be performed in +parallel or serially
    • +
  • type (str) – Component type
    • +
  • upgrade_unit_count (long or None) – Number of upgrade units in the group format: int32 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • upgrade_units (list of UpgradeUnit or None) – List of upgrade units in the group
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.UpgradeUnitGroupAggregateInfo(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, enabled=None, extended_configuration=None, failed_count=None, parallel=None, percent_complete=None, status=None, type=None, upgrade_unit_count=None, upgrade_units=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • enabled (bool or None) – Flag to indicate whether upgrade of this group is enabled or not
    • +
  • extended_configuration (list of KeyValuePair or None) – Extended configuration for the group
    • +
  • failed_count (long or None) – Number of nodes in the upgrade unit group that failed upgrade +format: int32 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • parallel (bool or None) – Upgrade method to specify whether the upgrade is to be performed in +parallel or serially
    • +
  • percent_complete (float or None) – Indicator of upgrade progress in percentage +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • status (str or None) –

    Possible values are:

    + +
    +
    Upgrade status of upgrade unit group
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • type (str) – Component type
    • +
  • upgrade_unit_count (long or None) – Number of upgrade units in the group format: int32 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • upgrade_units (list of UpgradeUnit or None) – List of upgrade units in the group
    • +
+
+
+
+STATUS_FAILED = 'FAILED'
+
+ +
+
+STATUS_IN_PROGRESS = 'IN_PROGRESS'
+
+ +
+
+STATUS_NOT_STARTED = 'NOT_STARTED'
+
+ +
+
+STATUS_PAUSED = 'PAUSED'
+
+ +
+
+STATUS_SUCCESS = 'SUCCESS'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.UpgradeUnitGroupAggregateInfoListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of UpgradeUnitGroupAggregateInfo or None) – Paged collection of upgrade status for upgrade unit groups +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.UpgradeUnitGroupInfo(display_name=None, id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • display_name (str or None) – Name of the group +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • id (str or None) – Identifier of group +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.UpgradeUnitGroupListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of UpgradeUnitGroup) – Paged Collection of Upgrade unit groups
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.UpgradeUnitGroupStatus(failed_count=None, group_id=None, group_name=None, percent_complete=None, status=None, upgrade_unit_count=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • failed_count (long or None) – Number of nodes in the upgrade unit group that failed upgrade +format: int32 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • group_id (str or None) – Identifier for upgrade unit group +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • group_name (str or None) – Name of the upgrade unit group +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • percent_complete (float or None) – Indicator of upgrade progress in percentage +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • status (str or None) –

    Possible values are:

    + +
    +
    Upgrade status of upgrade unit group
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • upgrade_unit_count (long or None) – Number of upgrade units in the group format: int32 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+
+STATUS_FAILED = 'FAILED'
+
+ +
+
+STATUS_IN_PROGRESS = 'IN_PROGRESS'
+
+ +
+
+STATUS_NOT_STARTED = 'NOT_STARTED'
+
+ +
+
+STATUS_PAUSED = 'PAUSED'
+
+ +
+
+STATUS_SUCCESS = 'SUCCESS'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.UpgradeUnitGroupStatusListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of UpgradeUnitGroupStatus or None) – Paged collection of upgrade status for upgrade unit groups +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.UpgradeUnitList(list=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:list (list of UpgradeUnit) – Collection of Upgrade units
+
+ +
+
+class com.vmware.nsx.model_client.UpgradeUnitListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of UpgradeUnit) – Paged Collection of Upgrade units
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.UpgradeUnitStatus(display_name=None, errors=None, id=None, percent_complete=None, status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • display_name (str or None) – Name of upgrade unit +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • errors (list of str or None) – List of errors occurred during upgrade of this upgrade unit +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • id (str or None) – Identifier of upgrade unit +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • percent_complete (float or None) – Indicator of upgrade progress in percentage +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • status (str or None) –

    Possible values are:

    + +
    +
    Status of upgrade unit
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
+
+
+
+STATUS_FAILED = 'FAILED'
+
+ +
+
+STATUS_IN_PROGRESS = 'IN_PROGRESS'
+
+ +
+
+STATUS_NOT_STARTED = 'NOT_STARTED'
+
+ +
+
+STATUS_PAUSED = 'PAUSED'
+
+ +
+
+STATUS_SUCCESS = 'SUCCESS'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.UpgradeUnitStatusListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of UpgradeUnitStatus) – Paged Collection of upgrade units status
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.UpgradeUnitTypeStats(node_count=None, node_with_issues_count=None, type=None, version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • node_count (long or None) – Number of nodes format: int32 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • node_with_issues_count (long or None) – Number of nodes with issues that may cause upgrade failure format: +int32 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • type (str or None) – Type of upgrade unit +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • version (str or None) – Version of the upgrade unit +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.UpgradeUnitTypeStatsList(results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:results (list of UpgradeUnitTypeStats or None) – List of upgrade unit type stats +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
+
+ +
+ +

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Object to identify an uplink based on its type and name

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters: +
+
+ +
+ +
+ +
+ +
+ +
+
+class com.vmware.nsx.model_client.UplinkHostSwitchProfile(lags=None, mtu=None, named_teamings=None, overlay_encap=None, teaming=None, transport_vlan=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='UplinkHostSwitchProfile', tags=None, required_capabilities=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Profile for uplink policies

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • lags (list of Lag or None) – list of LACP group
    • +
  • mtu (long or None) – Maximum Transmission Unit used for uplinks format: int32
    • +
  • named_teamings (list of NamedTeamingPolicy or None) – List of named uplink teaming policies that can be used by logical +switches
    • +
  • overlay_encap (str or None) –

    Possible values are:

    + +
    +
    The protocol used to encapsulate overlay traffic
    +
    • +
  • teaming (TeamingPolicy) – Default TeamingPolicy associated with this UplinkProfile
    • +
  • transport_vlan (long or None) – VLAN used for tagging Overlay traffic of associated HostSwitch +format: int64
    • +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • required_capabilities (list of str or None) –
    • +
+
+
+
+OVERLAY_ENCAP_GENEVE = 'GENEVE'
+
+ +
+
+OVERLAY_ENCAP_VXLAN = 'VXLAN'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.UrlAlias(alias=None, query=None, url=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Short name or alias of a url. It is used to represent the url.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • alias (str or None) –
    • +
  • query (str or None) – Search query to be applied, if any. If query string is not +provided, it will be ignored.
    • +
  • url (str) – Url to fetch data from.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.UserInfo(roles=None, user_name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Authenticated User Info

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • roles (list of NsxRole or None) – Permissions +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • user_name (str or None) – User Name +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.UsernamePasswordLoginCredential(password=None, thumbprint=None, username=None, credential_type='UsernamePasswordLoginCredential')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

A login credential specifying a username and password

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • password (str or None) – The authentication password for login
    • +
  • thumbprint (str or None) – Thumbprint of the login server
    • +
  • username (str or None) – The username for login
    • +
  • credential_type (str) – Possible values are ‘UsernamePasswordLoginCredential’, +‘VerifiableAsymmetricLoginCredential’.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.VIPSubnet(active_vip_addresses=None, prefix_length=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • active_vip_addresses (list of str) – Array of IP address subnets which will be used as floating IP +addresses. | These IPs will move and will be owned by Active node. +format: ipv4
    • +
  • prefix_length (long) – Subnet Prefix Length format: int64
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.VerifiableAsymmetricLoginCredential(asymmetric_credential=None, credential_key=None, credential_verifier=None, credential_type='VerifiableAsymmetricLoginCredential')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • asymmetric_credential (str or None) – Asymmetric login credential
    • +
  • credential_key (str or None) – Credential key
    • +
  • credential_verifier (str or None) – Credential verifier
    • +
  • credential_type (str) – Possible values are ‘UsernamePasswordLoginCredential’, +‘VerifiableAsymmetricLoginCredential’.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.VersionList(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, acceptable_versions=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • acceptable_versions (list of str) – List of component versions
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.VersionedDeploymentSpec(host_type=None, host_version=None, package_stores=None, service_vm_ovf_url=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Versioned DeploymentSpec contains vibs and ofv urls for specific version of +fabric module and host type and host version.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters: +
+
+
+HOST_TYPE_CENTOSKVM = 'CENTOSKVM'
+
+ +
+
+HOST_TYPE_CENTOSSERVER = 'CENTOSSERVER'
+
+ +
+
+HOST_TYPE_ESXI = 'ESXI'
+
+ +
+
+HOST_TYPE_RHELCONTAINER = 'RHELCONTAINER'
+
+ +
+
+HOST_TYPE_RHELKVM = 'RHELKVM'
+
+ +
+
+HOST_TYPE_RHELSERVER = 'RHELSERVER'
+
+ +
+
+HOST_TYPE_UBUNTUKVM = 'UBUNTUKVM'
+
+ +
+
+HOST_TYPE_UBUNTUSERVER = 'UBUNTUSERVER'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.VidmInfo(display_name=None, name=None, type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Vidm Info

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • display_name (str or None) – User’s Full Name Or User Group’s Display Name +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • name (str or None) – Username Or Groupname +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • type (str or None) –

    Possible values are:

    + +
    +
    Type
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
+
+
+
+TYPE_GROUP = 'remote_group'
+
+ +
+
+TYPE_USER = 'remote_user'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.VidmInfoListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of VidmInfo) – List results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.View(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, exclude_roles=None, include_roles=None, shared=None, weight=None, widgets=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Describes the configuration of a view to be displayed on the dashboard.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str) – Title of the widget.
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • exclude_roles (str or None) – Comma separated list of roles to which the shared view is not +visible. Allows user to prevent the visibility of a shared view to +the specified roles. User defined roles can also be specified in +the list. The roles can be obtained via GET /api/v1/aaa/roles. +Please visit API documentation for details about roles. If +include_roles is specified then exclude_roles cannot be specified.
    • +
  • include_roles (str or None) – Comma separated list of roles to which the shared view is visible. +Allows user to specify the visibility of a shared view to the +specified roles. User defined roles can also be specified in the +list. The roles can be obtained via GET /api/v1/aaa/roles. Please +visit API documentation for details about roles.
    • +
  • shared (bool or None) – Defaults to false. Set to true to publish the view to other users. +The widgets of a shared view are visible to other users.
    • +
  • weight (long or None) – Determines placement of view relative to other views. The lower the +weight, the higher it is in the placement order. format: int32
    • +
  • widgets (list of WidgetItem) – Array of widgets that are part of the view.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.ViewList(views=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Represents a list of views.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:views (list of View or None) – Array of views +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
+
+ +
+
+class com.vmware.nsx.model_client.VifAttachmentContext(app_id=None, parent_vif_id=None, traffic_tag=None, transport_node_uuid=None, vif_type=None, allocate_addresses=None, resource_type='VifAttachmentContext')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • app_id (str or None) – An application ID used to identify / look up a child VIF behind a +parent VIF. Only effective when vif_type is CHILD.
    • +
  • parent_vif_id (str or None) – VIF ID of the parent VIF if vif_type is CHILD
    • +
  • traffic_tag (long or None) – Current we use VLAN id as the traffic tag. Only effective when +vif_type is CHILD. Each logical port inside a container must have a +unique traffic tag. If the traffic_tag is not unique, no error is +generated, but traffic will not be delivered to any port with a +non-unique tag. format: int32
    • +
  • transport_node_uuid (str or None) – Only effective when vif_type is INDEPENDENT. Each logical port +inside a bare metal server or container must have a transport node +UUID. We use transport node ID as transport node UUID.
    • +
  • vif_type (str) –

    Possible values are:

    + +
    +
    Type of the VIF attached to logical port
    +
    • +
  • allocate_addresses (str or None) –

    Possible values are:

    + +

    A flag to indicate whether to allocate addresses from allocation +pools bound to the parent logical switch.

    +
    • +
  • resource_type (str) – Used to identify which concrete class it is
    • +
+
+
+
+VIF_TYPE_CHILD = 'CHILD'
+
+ +
+
+VIF_TYPE_INDEPENDENT = 'INDEPENDENT'
+
+ +
+
+VIF_TYPE_PARENT = 'PARENT'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.VirtualMachine(links=None, schema=None, self_=None, last_sync_time=None, description=None, display_name=None, resource_type=None, tags=None, compute_ids=None, external_id=None, host_id=None, local_id_on_host=None, power_state=None, source=None, type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • last_sync_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • compute_ids (list of str) – List of external compute ids of the virtual machine in the format +‘id-type-key:value’ , list of external compute ids +[‘uuid:xxxx-xxxx-xxxx-xxxx’, ‘moIdOnHost:moref-11’, +‘instanceUuid:xxxx-xxxx-xxxx-xxxx’]
    • +
  • external_id (str) – Current external id of this virtual machine in the system.
    • +
  • host_id (str or None) – Id of the host in which this virtual machine exists.
    • +
  • local_id_on_host (str) – Id of the vm unique within the host.
    • +
  • power_state (str) –

    Possible values are:

    + +
    +
    Current power state of this virtual machine in the system.
    +
    • +
  • source (ResourceReference or None) – Reference of the Host or Public Cloud Gateway that reported the VM
    • +
  • type (str or None) –

    Possible values are:

    + +
    +
    Virtual Machine type; Edge, Service VM or other.
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
+
+
+
+POWER_STATE_UNKNOWN = 'UNKNOWN'
+
+ +
+
+POWER_STATE_VM_RUNNING = 'VM_RUNNING'
+
+ +
+
+POWER_STATE_VM_STOPPED = 'VM_STOPPED'
+
+ +
+
+POWER_STATE_VM_SUSPENDED = 'VM_SUSPENDED'
+
+ +
+
+TYPE_EDGE = 'EDGE'
+
+ +
+
+TYPE_REGULAR = 'REGULAR'
+
+ +
+
+TYPE_SERVICE = 'SERVICE'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.VirtualMachineListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of VirtualMachine) – VirtualMachine list results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.VirtualMachineTagUpdate(external_id=None, tags=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • external_id (str) – External id of the virtual machine to which tags are to be applied
    • +
  • tags (list of Tag) – List of tags to be applied to the virtual machine
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.VirtualNetworkInterface(links=None, schema=None, self_=None, last_sync_time=None, description=None, display_name=None, resource_type=None, tags=None, device_key=None, device_name=None, external_id=None, host_id=None, ip_address_info=None, lport_attachment_id=None, mac_address=None, owner_vm_id=None, vm_local_id_on_host=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • last_sync_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • device_key (str) – Device key of the virtual network interface.
    • +
  • device_name (str or None) – Device name of the virtual network interface.
    • +
  • external_id (str) – External Id of the virtual network inferface.
    • +
  • host_id (str) – Id of the host on which the vm exists.
    • +
  • ip_address_info (list of IpAddressInfo or None) – IP Addresses of the the virtual network interface, from various +sources.
    • +
  • lport_attachment_id (str or None) – LPort Attachment Id of the virtual network interface.
    • +
  • mac_address (str) – MAC address of the virtual network interface.
    • +
  • owner_vm_id (str) – Id of the vm to which this virtual network interface belongs.
    • +
  • vm_local_id_on_host (str) – Id of the vm unique within the host.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.VirtualNetworkInterfaceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of VirtualNetworkInterface) – VirtualNetworkInterface list results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.VirtualServiceInstance(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='VirtualServiceInstance', tags=None, on_failure_policy=None, service_id=None, transport_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

VirtualServiceInstance is a custom instance to be used when NSX is not +handling the lifecycles of appliance/s and the user is not bringing their +own appliance (BYOD).

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +

    ServiceInstance is used when NSX handles the lifecyle of appliance. +Deployment and appliance related all the information is necessary. +ByodServiceInstance is a custom instance to be used when NSX is not +handling the lifecycles of appliance/s. User will manage their own +appliance (BYOD) to connect with NSX. VirtualServiceInstance is a a +custom instance to be used when NSX is not handling the lifecycle +of an appliance and when the user is not bringing their own +appliance.

    +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • on_failure_policy (str or None) –

    Possible values are:

    + +

    Failure policy of the service instance - if it has to be different +from the service. By default the service instance inherits the +FailurePolicy of the service it belongs to.

    +
    • +
  • service_id (str or None) – The Service to which the service instance is associated. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • transport_type (str) –

    Possible values are:

    + +

    Transport to be used by this service instance for deploying the +Service-VM.

    +
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.VlanMirrorSource(vlan_ids=None, resource_type='VlanMirrorSource')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters: +
+
+ +
+
+class com.vmware.nsx.model_client.VlanTrunkSpec(vlan_ranges=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

VlanTrunkspec is used for specifying trunk VLAN id ranges.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:vlan_ranges (list of TrunkVlanRange) – Trunk VLAN id ranges
+
+ +
+
+class com.vmware.nsx.model_client.VmNicInfo(nic_infos=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Contains a set of information of a VM on the network interfaces present on +the partner appliance that needs to be configured by the NSX Manager.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:nic_infos (list of NicInfo) – Set of information of a VM on the network interfaces present on the +partner appliance that needs to be configured by the NSX Manager.
+
+ +
+
+class com.vmware.nsx.model_client.VmkToLogicalSwitchMapping(dest_network_id=None, src_interface_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Holds VMkernal to logical switch mapping. This will be used for network +migration.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • dest_network_id (str) – Only VLAN type of logical switch can be specified here, as +migration operation is only supported for these types.
    • +
  • src_interface_id (str) – The ID (for example, vmk0) of the vmkernal interface on ESX to +migrate.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.VniPool(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, ranges=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • ranges (list of VniRange) – VNI range list results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.VniPoolListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of VniPool) – VNI pool list results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.VniRange(links=None, schema=None, self_=None, end=None, start=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

A range of virtual network identifiers (VNIs)

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • end (long) – End value for vni range to be used for virtual networks format: +int64
    • +
  • start (long) – Start value for vni range to be used for virtual networks format: +int64
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.VsphereClusterNodeVMDeploymentConfig(allow_ssh_root_login=None, compute_id=None, default_gateway_addresses=None, dns_servers=None, enable_ssh=None, host_id=None, hostname=None, management_network_id=None, management_port_subnets=None, ntp_servers=None, storage_id=None, vc_id=None, placement_type='VsphereClusterNodeVMDeploymentConfig')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Config for deploying a cluster node VM through a Vcenter server

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • allow_ssh_root_login (bool or None) – If true, the root user will be allowed to log into the VM. Allowing +root SSH logins is not recommended for security reasons.
    • +
  • compute_id (str) – The cluster node VM will be deployed on the specified cluster or +resourcepool for specified VC server.
    • +
  • default_gateway_addresses (list of str or None) – The default gateway for the VM to be deployed must be specified if +all the other VMs it communicates with are not in the same subnet. +Do not specify this field and management_port_subnets to use DHCP. +Note: only single IPv4 default gateway address is supported and it +must belong to management network. IMPORTANT: Controllers deployed +using DHCP are currently not supported, so this parameter should be +specified for deploying Controllers. format: ip
    • +
  • dns_servers (list of str or None) – List of DNS servers. If DHCP is used, the default DNS servers +associated with the DHCP server will be used instead. format: ipv4
    • +
  • enable_ssh (bool or None) – If true, the SSH service will automatically be started on the VM. +Enabling SSH service is not recommended for security reasons.
    • +
  • host_id (str or None) – The cluster node VM will be deployed on the specified host in the +specified VC server within the cluster if host_id is specified. +Note: User must ensure that storage and specified networks are +accessible by this host.
    • +
  • hostname (str) – Desired host name/FQDN for the VM to be deployed
    • +
  • management_network_id (str) – Distributed portgroup identifier to which the management vnic of +cluster node VM will be connected.
    • +
  • management_port_subnets (list of IPSubnet or None) – IP Address and subnet configuration for the management port. Do not +specify this field and default_gateway_addresses to use DHCP. Note: +only one IPv4 address is supported for the management port. +IMPORTANT: Controllers deployed using DHCP are currently not +supported, so this parameter should be specified for deploying +Controllers.
    • +
  • ntp_servers (list of str or None) – List of NTP servers. To use hostnames, a DNS server must be +defined. If not using DHCP, a DNS server should be specified under +dns_servers. format: hostname-or-ipv4
    • +
  • storage_id (str) – The cluster node VM will be deployed on the specified datastore in +the specified VC server. User must ensure that storage is +accessible by the specified cluster/host.
    • +
  • vc_id (str) – The VC-specific identifiers will be resolved on this VC, so all +other identifiers specified in the config must belong to this +Vcenter server.
    • +
  • placement_type (str) –

    Possible values are:

    + +

    Specifies the config for the platform through which to deploy the +VM

    +
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.VsphereDeploymentConfig(allow_ssh_root_login=None, compute_id=None, data_network_ids=None, default_gateway_addresses=None, dns_servers=None, enable_ssh=None, host_id=None, hostname=None, management_network_id=None, management_port_subnets=None, ntp_servers=None, search_domains=None, storage_id=None, vc_id=None, placement_type='VsphereDeploymentConfig')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Vsphere deployment configuration determines where to deploy the edge +node. It contains settings that are applied during install time. If using +DHCP, you must leave the following fields unset: search_domains, +management_port_subnets, dns_servers and default_gateway_addresses.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • allow_ssh_root_login (bool or None) – Allowing root SSH logins is not recommended for security reasons.
    • +
  • compute_id (str) – The edge node vm will be deployed on the specified cluster or +resourcepool. Note - all the hosts must have nsx fabric prepared in +the specified cluster.
    • +
  • data_network_ids (list of str) – List of distributed portgroup or VLAN logical identifiers to which +the datapath serving vnics of edge node vm will be connected.
    • +
  • default_gateway_addresses (list of str or None) – The default gateway for edge node must be specified if all the +nodes it communicates with are not in the same subnet. Note: Only +single IPv4 default gateway address is supported and it must belong +to management network. format: ip
    • +
  • dns_servers (list of str or None) – List of DNS servers. format: ip
    • +
  • enable_ssh (bool or None) – Enabling SSH service is not recommended for security reasons.
    • +
  • host_id (str or None) – The edge node vm will be deployed on the specified Host within the +cluster if host_id is specified. Note - User must ensure that +storage and specified networks are accessible by this host.
    • +
  • hostname (str) – Host name or FQDN for edge node.
    • +
  • management_network_id (str) – Distributed portgroup identifier to which the management vnic of +edge node vm will be connected. This portgroup must have +connectivity with MP and CCP. A VLAN logical switch identifier may +also be specified.
    • +
  • management_port_subnets (list of IPSubnet or None) – IP Address and subnet configuration for the management port. Note: +only one IPv4 address is supported for the management port.
    • +
  • ntp_servers (list of str or None) – List of NTP servers. format: ip
    • +
  • search_domains (list of str or None) – List of domain names that are used to complete unqualified host +names.
    • +
  • storage_id (str) – The edge node vm will be deployed on the specified datastore. User +must ensure that storage is accessible by the specified +cluster/host.
    • +
  • vc_id (str) – The vc specific identifiers will be resolved on this VC. So all +other identifiers specified here must belong to this vcenter +server.
    • +
  • placement_type (str) –

    Possible values are:

    + +
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.VtepCsvListResult(file_name=None, last_update_timestamp=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • file_name (str or None) – File name set by HTTP server if API returns CSV result as a file.
    • +
  • last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has +never updated the data. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of VtepTableCsvRecord or None) –
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.VtepLabelPool(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, pool_usage=None, ranges=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

A collection of ranges of virtual tunnel endpoint labels

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str or None) – Defaults to ID if not set
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str or None) – The type of this resource.
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • pool_usage (VtepLabelPoolUsage or None) – Pool usage statistics
    • +
  • ranges (list of VtepLabelRange) – Array of ranges for virtual tunnel endpoint labels
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.VtepLabelPoolListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of VtepLabelPool) – Virtual tunnel endpoint label pool list results
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.VtepLabelPoolUsage(allocated_ids=None, free_ids=None, total_ids=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Pool usage statistics in a pool

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • allocated_ids (long or None) – Total number of allocated IDs in a pool format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • free_ids (long or None) – Total number of free IDs in a pool format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • total_ids (long or None) – Total number of IDs in a pool format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.VtepLabelRange(links=None, schema=None, self_=None, end=None, start=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • end (long) – End value for virtual tunnel endpoint label range format: int64
    • +
  • start (long) – Start value for virtual tunnel endpoint label range format: int64
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.VtepListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, last_update_timestamp=None, logical_switch_id=None, results=None, transport_node_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has +never updated the data. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • logical_switch_id (str or None) – The id of the logical Switch +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • results (list of VtepTableEntry or None) –
    • +
  • transport_node_id (str or None) – Transport node identifier +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.VtepTableCsvRecord(segment_id=None, vtep_ip=None, vtep_label=None, vtep_mac_address=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • segment_id (str or None) – The segment Id
    • +
  • vtep_ip (str or None) – The virtual tunnel endpoint IP address format: ip
    • +
  • vtep_label (long) – The virtual tunnel endpoint label format: int64
    • +
  • vtep_mac_address (str) – The virtual tunnel endpoint MAC address
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.VtepTableEntry(segment_id=None, vtep_ip=None, vtep_label=None, vtep_mac_address=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • segment_id (str or None) – The segment Id
    • +
  • vtep_ip (str or None) – The virtual tunnel endpoint IP address format: ip
    • +
  • vtep_label (long or None) – The virtual tunnel endpoint label format: int64
    • +
  • vtep_mac_address (str or None) – The virtual tunnel endpoint MAC address
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.WeeklyBackupSchedule(days_of_week=None, hour_of_day=None, minute_of_day=None, resource_type='WeeklyBackupSchedule')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Schedule to specify day of the week and time to take automated backup

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters: +
+
+ +
+
+class com.vmware.nsx.model_client.WeeklyTelemetrySchedule(day_of_week=None, hour_of_day=None, minutes=None, frequency_type='WeeklyTelemetrySchedule')
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters: +
+
+
+DAY_OF_WEEK_FRIDAY = 'FRIDAY'
+
+ +
+
+DAY_OF_WEEK_MONDAY = 'MONDAY'
+
+ +
+
+DAY_OF_WEEK_SATURDAY = 'SATURDAY'
+
+ +
+
+DAY_OF_WEEK_SUNDAY = 'SUNDAY'
+
+ +
+
+DAY_OF_WEEK_THURSDAY = 'THURSDAY'
+
+ +
+
+DAY_OF_WEEK_TUESDAY = 'TUESDAY'
+
+ +
+
+DAY_OF_WEEK_WEDNESDAY = 'WEDNESDAY'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.WidgetConfiguration(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='WidgetConfiguration', tags=None, datasources=None, drilldown_id=None, footer=None, is_drilldown=None, shared=None, weight=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Describes the configuration of a widget to be displayed on the dashboard. +WidgetConfiguration is a base type that provides attributes of a widget +in-general.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • self (SelfResourceLink or None) – Link to this resource
    • +
  • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
    • +
  • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • description (str or None) – Description of this resource
    • +
  • display_name (str) – Title of the widget.
    • +
  • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • resource_type (str) –

    Possible values are:

    + +

    Supported visualization types are LabelValueConfiguration, +DonutConfiguration, GridConfiguration, StatsConfiguration, +MultiWidgetConfiguration and ContainerConfiguration.

    +
    • +
  • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
    • +
  • datasources (list of Datasource or None) – The ‘datasources’ represent the sources from which data will be +fetched. Currently, only NSX-API is supported as a ‘default’ +datasource. An example of specifying ‘default’ datasource along +with the urls to fetch data from is given at ‘example_request’ +section of ‘CreateWidgetConfiguration’ API.
    • +
  • drilldown_id (str or None) – Id of drilldown widget, if any. Id should be a valid id of an +existing widget. A widget is considered as drilldown widget when it +is associated with any other widget and provides more detailed +information about any data item from the parent widget.
    • +
  • footer (Footer or None) –
    • +
  • is_drilldown (bool or None) – Set to true if this widget should be used as a drilldown.
    • +
  • shared (bool or None) – Please use the property ‘shared’ of View instead of this. The +widgets of a shared view are visible to other users.
    • +
  • weight (long or None) – Specify relavite weight in WidgetItem for placement in a view. +Please see WidgetItem for details. format: int32
    • +
+
+
+
+RESOURCE_TYPE_CONTAINERCONFIGURATION = 'ContainerConfiguration'
+
+ +
+
+RESOURCE_TYPE_DONUTCONFIGURATION = 'DonutConfiguration'
+
+ +
+
+RESOURCE_TYPE_GRIDCONFIGURATION = 'GridConfiguration'
+
+ +
+
+RESOURCE_TYPE_LABELVALUECONFIGURATION = 'LabelValueConfiguration'
+
+ +
+
+RESOURCE_TYPE_MULTIWIDGETCONFIGURATION = 'MultiWidgetConfiguration'
+
+ +
+
+RESOURCE_TYPE_STATSCONFIGURATION = 'StatsConfiguration'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.WidgetConfigurationList(widgetconfigurations=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Represents a list of widget configurations.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:widgetconfigurations (list of vmware.vapi.struct.VapiStruct or None) – Array of widget configurations +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +WidgetConfiguration. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in WidgetConfiguration. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
+
+ +
+
+class com.vmware.nsx.model_client.WidgetItem(label=None, weight=None, widget_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Represents a reference to a widget that is held by a container or a +multi-widget or a View.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • label (Label or None) – Applicable for ‘DonutConfiguration’ and ‘StatsConfiguration’ +reports only. If label is not specified, then it defaults to the +label of the donut or stats report.
    • +
  • weight (long or None) – Determines placement of widget or container relative to other +widgets and containers. The lower the weight, the higher it is in +the placement order. format: int32
    • +
  • widget_id (str) – Id of the widget configuration that is held by a multi-widget or a +container or a view.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.X509Certificate(dsa_public_keyg=None, dsa_public_keyp=None, dsa_public_keyq=None, dsa_public_keyy=None, is_ca=None, is_valid=None, issuer=None, issuer_cn=None, not_after=None, not_before=None, public_key_algo=None, public_key_length=None, rsa_public_key_exponent=None, rsa_public_key_modulus=None, serial_number=None, signature=None, signature_algorithm=None, subject=None, subject_cn=None, version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • dsa_public_keyg (str or None) – One of the DSA cryptogaphic algorithm’s strength parameters, base +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • dsa_public_keyp (str or None) – One of the DSA cryptogaphic algorithm’s strength parameters, prime +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • dsa_public_keyq (str or None) – One of the DSA cryptogaphic algorithm’s strength parameters, +sub-prime +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • dsa_public_keyy (str or None) – One of the DSA cryptogaphic algorithm’s strength parameters +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • is_ca (bool or None) – True if this is a CA certificate +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • is_valid (bool or None) – True if this certificate is valid +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • issuer (str or None) – the certificate issuers complete distinguished name +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • issuer_cn (str or None) – the certificate issuer’s common name +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • not_after (long or None) – the time in epoch milliseconds at which the certificate becomes +invalid format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • not_before (long or None) – the time in epoch milliseconds at which the certificate becomes +valid format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • public_key_algo (str or None) –

    Possible values are:

    + +
    +
    Cryptographic algorithm used by the public key for data encryption
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    • +
  • public_key_length (long or None) – size measured in bits of the public/private keys used in a +cryptographic algorithm format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • rsa_public_key_exponent (str or None) – An RSA public key is made up of the modulus and the public +exponent. Exponent is a power number +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • rsa_public_key_modulus (str or None) – An RSA public key is made up of the modulus and the public +exponent. Modulus is wrap around number +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • serial_number (str or None) – certificate’s serial number +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • signature (str or None) – the signature value(the raw signature bits) used for signing and +validate the cert +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • signature_algorithm (str or None) – the algorithm used by the Certificate Authority to sign the +certificate +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • subject (str or None) – the certificate owners complete distinguished name +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • subject_cn (str or None) – the certificate owner’s common name +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • version (str or None) – Certificate version (default v1) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+
+PUBLIC_KEY_ALGO_DSA = 'DSA'
+
+ +
+
+PUBLIC_KEY_ALGO_RSA = 'RSA'
+
+ +
+ +
+
+class com.vmware.nsx.model_client.X509Crl(crl_entries=None, issuer=None, next_update=None, version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

A CRL is a time-stamped list identifying revoked certificates.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • crl_entries (list of X509CrlEntry or None) – list of X509CrlEntry +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • issuer (str or None) – Issuer’s distinguished name(DN) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • next_update (str or None) – Next update time for the CRL +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • version (str or None) – CRL’s version number either 1 or 2 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+class com.vmware.nsx.model_client.X509CrlEntry(revocation_date=None, serial_number=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Each revoked certificate is identified in a CRL by its certificate serial +number.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • revocation_date (str or None) – Revocation date +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
  • serial_number (str or None) – the revoked certificate’s serial number +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    • +
+
+
+ +
+
+

com.vmware.nsx.node_client module

+
+
+class com.vmware.nsx.node_client.FileStore(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+copyfromremotefile(file_name, copy_from_remote_file_properties)
+

Copy a remote file to the file store. If you use scp or sftp, you must +provide the remote server’s SSH fingerprint. See the NSX-T +Administration Guide for information and instructions about finding +the SSH fingerprint.

+ +++ + + + + + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.FileProperties

+
Returns:

com.vmware.nsx.model.FileProperties

+
Raise:

com.vmware.vapi.std.errors_client.TimedOut +Gateway Timeout

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.ConcurrentChange +Conflict

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+copytoremotefile(file_name, copy_to_remote_file_properties)
+

Copy a file in the file store to a remote server. If you use scp or +sftp, you must provide the remote server’s SSH fingerprint. See the +NSX-T Administration Guide for information and instructions about +finding the SSH fingerprint.

+ +++ + + + + + + + + + + + + + + + +
Parameters: +
Raise:

com.vmware.vapi.std.errors_client.TimedOut +Gateway Timeout

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+createremotedirectory(create_remote_directory_properties)
+

Create a directory on the remote remote server. Supports only SFTP. You +must provide the remote server’s SSH fingerprint. See the NSX +Administration Guide for information and instructions about finding +the SSH fingerprint.

+ +++ + + + + + + + + + + + + + + + +
Parameters:create_remote_directory_properties (com.vmware.nsx.model_client.CreateRemoteDirectoryProperties) – (required)
Raise:com.vmware.vapi.std.errors_client.TimedOut +Gateway Timeout
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(file_name)
+

Delete file

+ +++ + + + + + + + + + + + + + +
Parameters:file_name (str) – Name of the file to delete (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(file_name)
+

Read file properties

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:file_name (str) – Name of the file to retrieve information about (required)
Return type:com.vmware.nsx.model_client.FileProperties
Returns:com.vmware.nsx.model.FileProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list()
+

List node files

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.FilePropertiesListResult
Returns:com.vmware.nsx.model.FilePropertiesListResult
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node_client.Logs(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+list()
+

Returns the number of log files and lists the log files that reside on +the NSX virtual appliance. The list includes the filename, file size, +and last-modified time in milliseconds since epoch (1 January 1970) for +each log file. Knowing the last-modified time with millisecond accuracy +since epoch is helpful when you are comparing two times, such as the +time of a POST request and the end time on a server.

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeLogPropertiesListResult
Returns:com.vmware.nsx.model.NodeLogPropertiesListResult
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node_client.Mode(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Returns current Node Mode.

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeMode
Returns:com.vmware.nsx.model.NodeMode
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node_client.Network(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Read network configuration properties

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeNetworkProperties
Returns:com.vmware.nsx.model.NodeNetworkProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node_client.Processes(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(process_id)
+

Returns information for a specified process ID (pid).

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:process_id (str) – ID of process to read (required)
Return type:com.vmware.nsx.model_client.NodeProcessProperties
Returns:com.vmware.nsx.model.NodeProcessProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list()
+

Returns the number of processes and information about each process. +Process information includes 1) mem_resident, which is roughly +equivalent to the amount of RAM, in bytes, currently used by the +process, 2) parent process ID (ppid), 3) process name, 4) process up +time in milliseconds, 5) mem_used, wich is the amount of virtual memory +used by the process, in bytes, 6) process start time, in milliseconds +since epoch, 7) process ID (pid), 8) CPU time, both user and the +system, consumed by the process in milliseconds.

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeProcessPropertiesListResult
Returns:com.vmware.nsx.model.NodeProcessPropertiesListResult
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node_client.RabbitmqManagementPort(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create()
+

Set RabbitMQ management port

+ +++ + + + + + + + + + + + +
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete()
+

Delete RabbitMQ management port

+ +++ + + + + + + + + + + + +
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get()
+

Returns status as true if RabbitMQ management port is enabled else +false

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.PortStatus
Returns:com.vmware.nsx.model.PortStatus
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node_client.Services(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+list()
+

Returns a list of all services available on the NSX Manager applicance.

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServicePropertiesListResult
Returns:com.vmware.nsx.model.NodeServicePropertiesListResult
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Returns information about the NSX Manager appliance’s file system, CPU, +memory, disk usage, and uptime.

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeStatusProperties
Returns:com.vmware.nsx.model.NodeStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+class com.vmware.nsx.node_client.Tasks(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+cancel(task_id)
+

Cancel specified task

+ +++ + + + + + + + + + + + + + +
Parameters:task_id (str) – ID of task to delete (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(task_id)
+

Delete task

+ +++ + + + + + + + + + + + + + + + +
Parameters:task_id (str) – ID of task to delete (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.ConcurrentChange +Conflict
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(task_id, suppress_redirect=None)
+

Read task properties

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • task_id (str) – ID of task to read (required)
    • +
  • suppress_redirect (bool or None) – Suppress redirect status if applicable (optional, default to false)
    • +
+
Return type:

com.vmware.nsx.model_client.ApplianceManagementTaskProperties

+
Returns:

com.vmware.nsx.model.ApplianceManagementTaskProperties

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+list(fields=None, request_method=None, request_path=None, request_uri=None, status=None, user=None)
+

List appliance management tasks

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • fields (str or None) – Fields to include in query results (optional)
    • +
  • request_method (str or None) – Request method(s) to include in query result (optional)
    • +
  • request_path (str or None) – Request URI path(s) to include in query result (optional)
    • +
  • request_uri (str or None) – Request URI(s) to include in query result (optional)
    • +
  • status (str or None) – Status(es) to include in query result (optional)
    • +
  • user (str or None) – Names of users to include in query result (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.ApplianceManagementTaskListResult

+
Returns:

com.vmware.nsx.model.ApplianceManagementTaskListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.node_client.Users(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(userid)
+

Returns information about a specified user who is configued to log in +to the NSX Manager appliance

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:userid (str) – User id of the user (required)
Return type:com.vmware.nsx.model_client.NodeUserProperties
Returns:com.vmware.nsx.model.NodeUserProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list()
+

Returns the list of users configued to log in to the NSX Manager +appliance.

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeUserPropertiesListResult
Returns:com.vmware.nsx.model.NodeUserPropertiesListResult
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+update(userid, node_user_properties)
+

Updates attributes of an existing NSX Manager appliance user. This +method cannot be used to add a new user. Modifiable attributes include +the username, full name of the user, and password. If you specify a +password in a PUT request, it is not returned in the response. Nor is +it returned in a GET request.

+ +++ + + + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.NodeUserProperties

+
Returns:

com.vmware.nsx.model.NodeUserProperties

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.ConcurrentChange +Conflict

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.node_client.Version(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Read node version

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeVersion
Returns:com.vmware.nsx.model.NodeVersion
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+

com.vmware.nsx.ns_groups_client module

+
+
+class com.vmware.nsx.ns_groups_client.EffectiveIpAddressMembers(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+list(ns_group_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Returns effective ip address members of the specified NSGroup.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • ns_group_id (str) – NSGroup Id (required)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.EffectiveIPAddressMemberListResult

+
Returns:

com.vmware.nsx.model.EffectiveIPAddressMemberListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.ns_groups_client.EffectiveLogicalPortMembers(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+list(ns_group_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Returns effective logical port members of the specified NSGroup.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • ns_group_id (str) – NSGroup Id (required)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.EffectiveMemberResourceListResult

+
Returns:

com.vmware.nsx.model.EffectiveMemberResourceListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.ns_groups_client.EffectiveLogicalSwitchMembers(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+list(ns_group_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Returns effective logical switch members of the specified NSGroup.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • ns_group_id (str) – NSGroup Id (required)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.EffectiveMemberResourceListResult

+
Returns:

com.vmware.nsx.model.EffectiveMemberResourceListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.ns_groups_client.EffectiveVirtualMachineMembers(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+list(ns_group_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Returns effective virtual machine members of the specified NSGroup.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • ns_group_id (str) – NSGroup Id (required)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.VirtualMachineListResult

+
Returns:

com.vmware.nsx.model.VirtualMachineListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.ns_groups_client.MemberTypes(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(ns_group_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Returns member types for a specified NSGroup including child NSGroups. +This considers static members and members added via membership criteria +only

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • ns_group_id (str) – NSGroup Id (required)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.EffectiveMemberTypeListResult

+
Returns:

com.vmware.nsx.model.EffectiveMemberTypeListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.ns_groups_client.ServiceAssociations(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+LIST_SERVICE_TYPE_FIREWALL = 'firewall'
+

Possible value for serviceType of method ServiceAssociations.list().

+
+ +
+
+LIST_SERVICE_TYPE_IPFIX = 'ipfix'
+

Possible value for serviceType of method ServiceAssociations.list().

+
+ +
+
+list(nsgroup_id, service_type, cursor=None, fetch_parentgroup_associations=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Returns information about services that are associated with the given +NSGroup. The service name is passed by service_type parameter

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • nsgroup_id (str) – (required)
    • +
  • service_type (str) – (required)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • fetch_parentgroup_associations (bool or None) – Fetch complete list of associated resources considering nesting +(optional, default to false)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

vmware.vapi.struct.VapiStruct

+
Returns:

com.vmware.nsx.model.ServiceAssociationListResult +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.ServiceAssociationListResult.

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.ns_groups_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+class com.vmware.nsx.ns_groups_client.UnassociatedVirtualMachines(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+list(cursor=None, display_name=None, external_id=None, host_id=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Get the list of all the virtual machines that are not a part of any +existing NSGroup.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • display_name (str or None) – Display Name of the virtual machine (optional)
    • +
  • external_id (str or None) – External id of the virtual machine (optional)
    • +
  • host_id (str or None) – Id of the host where this vif is located (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.UnassociatedVMListResult

+
Returns:

com.vmware.nsx.model.UnassociatedVMListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+

com.vmware.nsx.pktcap_client module

+
+
+class com.vmware.nsx.pktcap_client.Session(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(packet_capture_request)
+

Create an new packet capture session on given node with specified +options

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:packet_capture_request (com.vmware.nsx.model_client.PacketCaptureRequest) – (required)
Return type:com.vmware.nsx.model_client.PacketCaptureSession
Returns:com.vmware.nsx.model.PacketCaptureSession
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(session_id)
+

Before calling this method, terminate any running capture session.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:session_id (str) – Packet capture session id (required)
Return type:com.vmware.nsx.model_client.PacketCaptureSession
Returns:com.vmware.nsx.model.PacketCaptureSession
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(session_id)
+

Get the packet capture status information by session id.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:session_id (str) – Packet capture session id (required)
Return type:com.vmware.nsx.model_client.PacketCaptureSession
Returns:com.vmware.nsx.model.PacketCaptureSession
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+terminate(session_id)
+

Terminate the packet capture session by session id.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:session_id (str) – Packet capture session id (required)
Return type:com.vmware.nsx.model_client.PacketCaptureSession
Returns:com.vmware.nsx.model.PacketCaptureSession
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.pktcap_client.Sessions(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+delete()
+

Delete all the packet capture sessions.

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.PacketCaptureSessionList
Returns:com.vmware.nsx.model.PacketCaptureSessionList
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list()
+

Get the information of all packet capture sessions.

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.PacketCaptureSessionList
Returns:com.vmware.nsx.model.PacketCaptureSessionList
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.pktcap_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+

com.vmware.nsx.pools_client module

+
+
+class com.vmware.nsx.pools_client.IpBlocks(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(ip_block)
+

Creates a new IPv4 address block using the specified cidr. cidr is a +required parameter. display_name & description are optional parameters

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:ip_block (com.vmware.nsx.model_client.IpBlock) – (required)
Return type:com.vmware.nsx.model_client.IpBlock
Returns:com.vmware.nsx.model.IpBlock
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(block_id)
+

Deletes the IP address block with specified id if it exists. IP block +cannot be deleted if there are allocated subnets from the block.

+ +++ + + + + + + + + + + + + + +
Parameters:block_id (str) – IP address block id (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(block_id)
+

Returns information about the IP address block with specified id. +Information includes id, display_name, description & cidr.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:block_id (str) – IP address block id (required)
Return type:com.vmware.nsx.model_client.IpBlock
Returns:com.vmware.nsx.model.IpBlock
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Returns information about configured IP address blocks. Information +includes the id, display name, description & CIDR of IP address blocks

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.IpBlockListResult

+
Returns:

com.vmware.nsx.model.IpBlockListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(block_id, ip_block)
+

Modifies the IP address block with specifed id. display_name, +description and cidr are parameters that can be modified. If a new cidr +is specified, it should contain all existing subnets in the IP block. +Returns a conflict error if the IP address block cidr can not be +modified due to the presence of subnets that it contains. Eg: If the IP +block contains a subnet 192.168.0.1/24 and we try to change the IP +block cidr to 10.1.0.1/16, it results in a conflict.

+ +++ + + + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.IpBlock

+
Returns:

com.vmware.nsx.model.IpBlock

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.ConcurrentChange +Conflict

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.pools_client.IpPools(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+ALLOCATEORRELEASE_ACTION_ALLOCATE = 'ALLOCATE'
+

Possible value for action of method IpPools.allocateorrelease().

+
+ +
+
+ALLOCATEORRELEASE_ACTION_RELEASE = 'RELEASE'
+

Possible value for action of method IpPools.allocateorrelease().

+
+ +
+
+allocateorrelease(pool_id, allocation_ip_address, action)
+
+++ + + + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.AllocationIpAddress

+
Returns:

com.vmware.nsx.model.AllocationIpAddress

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.ConcurrentChange +Conflict

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+create(ip_pool)
+

Creates a new IPv4 or IPv6 address pool. Required parameters are +allocation_ranges and cidr. Optional parameters are display_name, +description, dns_nameservers, dns_suffix, and gateway_ip.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:ip_pool (com.vmware.nsx.model_client.IpPool) – (required)
Return type:com.vmware.nsx.model_client.IpPool
Returns:com.vmware.nsx.model.IpPool
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(pool_id, force=None)
+

Deletes the specified IP address pool. By default, if the IpPool is +used in other configurations (such as transport node template), it +won’t be deleted. In such situations, pass "force=true" as +query param to force delete the IpPool

+ +++ + + + + + + + + + + + + + +
Parameters:
    +
  • pool_id (str) – IP pool ID (required)
    • +
  • force (bool or None) – Force delete the resource even if it is being used somewhere +(optional, default to false)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get(pool_id)
+

Returns information about the specified IP address pool.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:pool_id (str) – IP pool ID (required)
Return type:com.vmware.nsx.model_client.IpPool
Returns:com.vmware.nsx.model.IpPool
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Returns information about the configured IP address pools. Information +includes the display name and description of the pool and the details +of each of the subnets in the pool, including the DNS servers, +allocation ranges, gateway, and CIDR subnet address.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.IpPoolListResult

+
Returns:

com.vmware.nsx.model.IpPoolListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(pool_id, ip_pool)
+

Modifies the specified IP address pool. Modifiable parameters include +the description, display_name, and all subnet information.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.IpPool

+
Returns:

com.vmware.nsx.model.IpPool

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.pools_client.IpSubnets(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+ALLOCATEORRELEASEFROMIPBLOCKSUBNET_ACTION_ALLOCATE = 'ALLOCATE'
+

Possible value for action of method +IpSubnets.allocateorreleasefromipblocksubnet().

+
+ +
+
+ALLOCATEORRELEASEFROMIPBLOCKSUBNET_ACTION_RELEASE = 'RELEASE'
+

Possible value for action of method +IpSubnets.allocateorreleasefromipblocksubnet().

+
+ +
+
+allocateorreleasefromipblocksubnet(subnet_id, allocation_ip_address, action)
+
+++ + + + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.AllocationIpAddress

+
Returns:

com.vmware.nsx.model.AllocationIpAddress

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.ConcurrentChange +Conflict

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+create(ip_block_subnet)
+

Carves out a subnet of requested size from the specified IP block. The +"size" parameter and the "block_id " are the requireds +field while invoking this API. If the IP block has sufficient +resources/space to allocate a subnet of specified size, the response +will contain all the details of the newly created subnet including the +display_name, description, cidr & allocation_ranges. Returns a conflict +error if the IP block does not have enough resources/space to allocate +a subnet of the requested size.

+ +++ + + + + + + + + + + + + + + + + + + + +
Parameters:ip_block_subnet (com.vmware.nsx.model_client.IpBlockSubnet) – (required)
Return type:com.vmware.nsx.model_client.IpBlockSubnet
Returns:com.vmware.nsx.model.IpBlockSubnet
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.ConcurrentChange +Conflict
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(subnet_id)
+

Deletes a subnet with specified id within a given IP address block. +Deletion is allowed only when there are no allocated IP addresses from +that subnet.

+ +++ + + + + + + + + + + + + + +
Parameters:subnet_id (str) – Subnet id (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(subnet_id)
+

Returns information about the subnet with specified id within a given +IP address block. Information includes display_name, description, cidr +and allocation_ranges.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:subnet_id (str) – Subnet id (required)
Return type:com.vmware.nsx.model_client.IpBlockSubnet
Returns:com.vmware.nsx.model.IpBlockSubnet
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(block_id=None, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Returns information about all subnets present within an IP address +block. Information includes subnet’s id, display_name, description, +cidr and allocation ranges.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • block_id (str or None) – (optional)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.IpBlockSubnetListResult

+
Returns:

com.vmware.nsx.model.IpBlockSubnetListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.pools_client.MacPools(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(pool_id)
+

Returns information about the specified MAC pool.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:pool_id (str) – MAC pool ID (required)
Return type:com.vmware.nsx.model_client.MacPool
Returns:com.vmware.nsx.model.MacPool
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Returns a list of all the MAC pools

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.MacPoolListResult

+
Returns:

com.vmware.nsx.model.MacPoolListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.pools_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+class com.vmware.nsx.pools_client.VniPools(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(pool_id)
+

Returns information about the specified virtual network identifier +(VNI) pool.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:pool_id (str) – VNI pool ID (required)
Return type:com.vmware.nsx.model_client.VniPool
Returns:com.vmware.nsx.model.VniPool
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Returns information about the default and configured virtual network +identifier (VNI) pools for use when building logical network segments. +Each virtual network has a unique ID called a VNI. Instead of creating +a new VNI each time you need a new logical switch, you can instead +allocate a VNI from a VNI pool. VNI pools are sometimes called segment +ID pools. Each VNI pool has a range of usable VNIs. By default, there +is one pool with two ranges [5000, 65535] and [65536, 75000]. To create +multiple smaller pools, specify a smaller range for each pool such as +75001-75100 and 75101-75200. The VNI range determines the maximum +number of logical switches that can be created in each network segment.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.VniPoolListResult

+
Returns:

com.vmware.nsx.model.VniPoolListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(pool_id, vni_pool)
+

Updates the specified VNI pool. Modifiable parameters include +description, display_name and ranges. Ranges can be added, modified or +deleted. Overlapping ranges are not allowed. Only range end can be +modified for any existing range. Range shrinking or deletion is not +allowed if there are any allocated VNIs.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.VniPool

+
Returns:

com.vmware.nsx.model.VniPool

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.pools_client.VtepLabelPools(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(pool_id)
+

Returns information about the specified virtual tunnel endpoint label +pool.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:pool_id (str) – Virtual tunnel endpoint label pool ID (required)
Return type:com.vmware.nsx.model_client.VtepLabelPool
Returns:com.vmware.nsx.model.VtepLabelPool
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Returns a list of all virtual tunnel endpoint label pools

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.VtepLabelPoolListResult

+
Returns:

com.vmware.nsx.model.VtepLabelPoolListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+

com.vmware.nsx.realization_state_barrier_client module

+
+
+class com.vmware.nsx.realization_state_barrier_client.Config(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Returns the current barrier configuration

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.RealizationStateBarrierConfig
Returns:com.vmware.nsx.model.RealizationStateBarrierConfig
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+update(realization_state_barrier_config)
+

Updates the barrier configuration having interval set in milliseconds +The new interval that automatically increments the global realization +number

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:realization_state_barrier_config (com.vmware.nsx.model_client.RealizationStateBarrierConfig) – (required)
Return type:com.vmware.nsx.model_client.RealizationStateBarrierConfig
Returns:com.vmware.nsx.model.RealizationStateBarrierConfig
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.realization_state_barrier_client.Current(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Returns the current global realization barrier number for NSX. This +method has been deprecated. To track realization state, use +X-NSX-REQUESTID request header instead.

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.CurrentRealizationStateBarrier
Returns:com.vmware.nsx.model.CurrentRealizationStateBarrier
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+increment()
+

Increment the current barrier number by 1 for NSX. This method has been +deprecated. To track realization state, use X-NSX-REQUESTID request +header instead.

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.CurrentRealizationStateBarrier
Returns:com.vmware.nsx.model.CurrentRealizationStateBarrier
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.realization_state_barrier_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+

com.vmware.nsx.serviceinsertion_client module

+
+
+class com.vmware.nsx.serviceinsertion_client.Sections(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+CREATEWITHRULES_OPERATION_AFTER = 'insert_after'
+

Possible value for operation of method Sections.createwithrules().

+
+ +
+
+CREATEWITHRULES_OPERATION_BEFORE = 'insert_before'
+

Possible value for operation of method Sections.createwithrules().

+
+ +
+
+CREATEWITHRULES_OPERATION_BOTTOM = 'insert_bottom'
+

Possible value for operation of method Sections.createwithrules().

+
+ +
+
+CREATEWITHRULES_OPERATION_TOP = 'insert_top'
+

Possible value for operation of method Sections.createwithrules().

+
+ +
+
+CREATE_OPERATION_AFTER = 'insert_after'
+

Possible value for operation of method Sections.create().

+
+ +
+
+CREATE_OPERATION_BEFORE = 'insert_before'
+

Possible value for operation of method Sections.create().

+
+ +
+
+CREATE_OPERATION_BOTTOM = 'insert_bottom'
+

Possible value for operation of method Sections.create().

+
+ +
+
+CREATE_OPERATION_TOP = 'insert_top'
+

Possible value for operation of method Sections.create().

+
+ +
+
+LIST_EXCLUDE_APPLIED_TO_TYPE_LOGICALPORT = 'LogicalPort'
+

Possible value for excludeAppliedToType of method Sections.list().

+
+ +
+
+LIST_EXCLUDE_APPLIED_TO_TYPE_LOGICALROUTER = 'LogicalRouter'
+

Possible value for excludeAppliedToType of method Sections.list().

+
+ +
+
+LIST_EXCLUDE_APPLIED_TO_TYPE_LOGICALSWITCH = 'LogicalSwitch'
+

Possible value for excludeAppliedToType of method Sections.list().

+
+ +
+
+LIST_EXCLUDE_APPLIED_TO_TYPE_NSGROUP = 'NSGroup'
+

Possible value for excludeAppliedToType of method Sections.list().

+
+ +
+
+LIST_FILTER_TYPE_FILTER = 'FILTER'
+

Possible value for filterType of method Sections.list().

+
+ +
+ +

Possible value for filterType of method Sections.list().

+
+ +
+
+LIST_INCLUDE_APPLIED_TO_TYPE_LOGICALPORT = 'LogicalPort'
+

Possible value for includeAppliedToType of method Sections.list().

+
+ +
+
+LIST_INCLUDE_APPLIED_TO_TYPE_LOGICALROUTER = 'LogicalRouter'
+

Possible value for includeAppliedToType of method Sections.list().

+
+ +
+
+LIST_INCLUDE_APPLIED_TO_TYPE_LOGICALSWITCH = 'LogicalSwitch'
+

Possible value for includeAppliedToType of method Sections.list().

+
+ +
+
+LIST_INCLUDE_APPLIED_TO_TYPE_NSGROUP = 'NSGroup'
+

Possible value for includeAppliedToType of method Sections.list().

+
+ +
+
+LIST_TYPE_L3REDIRECT = 'L3REDIRECT'
+

Possible value for type of method Sections.list().

+
+ +
+
+REVISEWITHRULES_OPERATION_AFTER = 'insert_after'
+

Possible value for operation of method Sections.revisewithrules().

+
+ +
+
+REVISEWITHRULES_OPERATION_BEFORE = 'insert_before'
+

Possible value for operation of method Sections.revisewithrules().

+
+ +
+
+REVISEWITHRULES_OPERATION_BOTTOM = 'insert_bottom'
+

Possible value for operation of method Sections.revisewithrules().

+
+ +
+
+REVISEWITHRULES_OPERATION_TOP = 'insert_top'
+

Possible value for operation of method Sections.revisewithrules().

+
+ +
+
+REVISE_OPERATION_AFTER = 'insert_after'
+

Possible value for operation of method Sections.revise().

+
+ +
+
+REVISE_OPERATION_BEFORE = 'insert_before'
+

Possible value for operation of method Sections.revise().

+
+ +
+
+REVISE_OPERATION_BOTTOM = 'insert_bottom'
+

Possible value for operation of method Sections.revise().

+
+ +
+
+REVISE_OPERATION_TOP = 'insert_top'
+

Possible value for operation of method Sections.revise().

+
+ +
+
+create(service_insertion_section, id=None, operation=None)
+

Creates new empty Service Insertion section in the system.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • service_insertion_section (com.vmware.nsx.model_client.ServiceInsertionSection) – (required)
    • +
  • id (str or None) – Identifier of the anchor rule or section. This is a required field +in case operation like ‘insert_before’ and ‘insert_after’. +(optional)
    • +
  • operation (str or None) – Operation (optional, default to insert_top)
    • +
+
Return type:

com.vmware.nsx.model_client.ServiceInsertionSection

+
Returns:

com.vmware.nsx.model.ServiceInsertionSection

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+createwithrules(service_insertion_section_rule_list, id=None, operation=None)
+

Creates a new serviceinsertion section with rules. The limit on the +number of rules is defined by maxItems in collection types for +ServiceInsertionRule (ServiceInsertionRuleXXXList types). When invoked +on a section with a large number of rules, this API is supported only +at low rates of invocation (not more than 4-5 times per minute). The +typical latency of this API with about 1024 rules is about 4-5 seconds. +This API should not be invoked with large payloads at automation +speeds. More than 50 rules are not supported. Instead, to create +sections, use: POST /api/v1/serviceinsertion/sections To create rules, +use: POST /api/v1/serviceinsertion/sections/<section-id>/rules

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • service_insertion_section_rule_list (com.vmware.nsx.model_client.ServiceInsertionSectionRuleList) – (required)
    • +
  • id (str or None) – Identifier of the anchor rule or section. This is a required field +in case operation like ‘insert_before’ and ‘insert_after’. +(optional)
    • +
  • operation (str or None) – Operation (optional, default to insert_top)
    • +
+
Return type:

com.vmware.nsx.model_client.ServiceInsertionSectionRuleList

+
Returns:

com.vmware.nsx.model.ServiceInsertionSectionRuleList

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+delete(section_id, cascade=None)
+

Removes serviceinsertion section from the system. ServiceInsertion +section with rules can only be deleted by passing +"cascade=true" parameter.

+ +++ + + + + + + + + + + + + + +
Parameters:
    +
  • section_id (str) – (required)
    • +
  • cascade (bool or None) – Flag to cascade delete of this object to all it’s child objects. +(optional, default to false)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get(section_id)
+

Returns information about serviceinsertion section for the identifier.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:section_id (str) – (required)
Return type:com.vmware.nsx.model_client.ServiceInsertionSection
Returns:com.vmware.nsx.model.ServiceInsertionSection
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(applied_tos=None, cursor=None, destinations=None, exclude_applied_to_type=None, filter_type=None, include_applied_to_type=None, included_fields=None, page_size=None, services=None, sort_ascending=None, sort_by=None, sources=None, type=None)
+

List all Service Insertion section in paginated form. A default page +size is limited to 1000 sections. By default, the list of section is +filtered by L3REDIRECT type.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • applied_tos (str or None) – AppliedTo’s referenced by this section or section’s Distributed +Service Rules . (optional)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • destinations (str or None) – Destinations referenced by this section’s Distributed Service Rules +. (optional)
    • +
  • exclude_applied_to_type (str or None) – Resource type valid for use as AppliedTo filter in section API +(optional)
    • +
  • filter_type (str or None) – Filter type (optional, default to FILTER)
    • +
  • include_applied_to_type (str or None) – Resource type valid for use as AppliedTo filter in section API +(optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • services (str or None) – NSService referenced by this section’s Distributed Service Rules . +(optional)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
  • sources (str or None) – Sources referenced by this section’s Distributed Service Rules . +(optional)
    • +
  • type (str or None) – Section Type (optional, default to L3REDIRECT)
    • +
+
Return type:

com.vmware.nsx.model_client.ServiceInsertionSectionListResult

+
Returns:

com.vmware.nsx.model.ServiceInsertionSectionListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+listwithrules(section_id)
+

Returns serviceinsertion section information with rules for a section +identifier. When invoked on a section with a large number of rules, +this API is supported only at low rates of invocation (not more than +4-5 times per minute). The typical latency of this API with about 1024 +rules is about 4-5 seconds. This API should not be invoked with large +payloads at automation speeds. More than 50 rules are not supported. +Instead, to read serviceinsertion rules, use: GET +/api/v1/serviceinsertion/sections/<section-id>/rules with the +appropriate page_size.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:section_id (str) – (required)
Return type:com.vmware.nsx.model_client.ServiceInsertionSectionRuleList
Returns:com.vmware.nsx.model.ServiceInsertionSectionRuleList
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+revise(section_id, service_insertion_section, id=None, operation=None)
+

Modifies an existing serviceinsertion section along with its relative +position among other serviceinsertion sections in the system.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • section_id (str) – (required)
    • +
  • service_insertion_section (com.vmware.nsx.model_client.ServiceInsertionSection) – (required)
    • +
  • id (str or None) – Identifier of the anchor rule or section. This is a required field +in case operation like ‘insert_before’ and ‘insert_after’. +(optional)
    • +
  • operation (str or None) – Operation (optional, default to insert_top)
    • +
+
Return type:

com.vmware.nsx.model_client.ServiceInsertionSection

+
Returns:

com.vmware.nsx.model.ServiceInsertionSection

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+revisewithrules(section_id, service_insertion_section_rule_list, id=None, operation=None)
+

Modifies an existing serviceinsertion section along with its relative +position among other serviceinsertion sections with rules. When invoked +on a large number of rules, this API is supported only at low rates of +invocation (not more than 2 times per minute). The typical latency of +this API with about 1024 rules is about 15 seconds in a cluster setup. +This API should not be invoked with large payloads at automation +speeds. Instead, to move a section above or below another section, use: +POST /api/v1/serviceinsertion/sections/<section-id>?action=revise To +modify rules, use: PUT +/api/v1/serviceinsertion/sections/<section-id>/rules/<rule-id>

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • section_id (str) – (required)
    • +
  • service_insertion_section_rule_list (com.vmware.nsx.model_client.ServiceInsertionSectionRuleList) – (required)
    • +
  • id (str or None) – Identifier of the anchor rule or section. This is a required field +in case operation like ‘insert_before’ and ‘insert_after’. +(optional)
    • +
  • operation (str or None) – Operation (optional, default to insert_top)
    • +
+
Return type:

com.vmware.nsx.model_client.ServiceInsertionSectionRuleList

+
Returns:

com.vmware.nsx.model.ServiceInsertionSectionRuleList

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(section_id, service_insertion_section)
+

Modifies the specified section, but does not modify the section’s +associated rules.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.ServiceInsertionSection

+
Returns:

com.vmware.nsx.model.ServiceInsertionSection

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+updatewithrules(section_id, service_insertion_section_rule_list)
+

Modifies existing serviceinsertion section along with its association +with rules. When invoked on a large number of rules, this API is +supported only at low rates of invocation (not more than 2 times per +minute). The typical latency of this API with about 1024 rules is about +15 seconds in a cluster setup. This API should not be invoked with +large payloads at automation speeds. Instead, to update rule content, +use: PUT /api/v1/serviceinsertion/sections/<section-id>/rules/<rule-id>

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.ServiceInsertionSectionRuleList

+
Returns:

com.vmware.nsx.model.ServiceInsertionSectionRuleList

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.serviceinsertion_client.ServiceAttachments(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(service_attachment)
+

Adds a new Service attachment. A service attachment represents a point +on NSX entity (Example: Logical Router) to which service instance can +be connected through an InstanceEndpoint.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:service_attachment (com.vmware.nsx.model_client.ServiceAttachment) – (required)
Return type:com.vmware.nsx.model_client.ServiceAttachment
Returns:com.vmware.nsx.model.ServiceAttachment
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(service_attachment_id)
+

Delete existing service attachment from system. Before deletion, please +make sure that, no instance endpoints are connected to this attachment. +In turn no appliance should be connected to this attachment.

+ +++ + + + + + + + + + + + + + +
Parameters:service_attachment_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(service_attachment_id)
+

Returns detailed Attachment information for a given service attachment.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:service_attachment_id (str) – (required)
Return type:com.vmware.nsx.model_client.ServiceAttachment
Returns:com.vmware.nsx.model.ServiceAttachment
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list()
+

Returns all Service-Attachement(s) present in the system.

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.ServiceAttachmentListResult
Returns:com.vmware.nsx.model.ServiceAttachmentListResult
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.serviceinsertion_client.Services(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(service_definition)
+

Creates new Service-Insertion Service in the system.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:service_definition (com.vmware.nsx.model_client.ServiceDefinition) – (required)
Return type:com.vmware.nsx.model_client.ServiceDefinition
Returns:com.vmware.nsx.model.ServiceDefinition
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(service_id, cascade=None)
+

Removes Service-Insertion Service from the system. A Service with +Service-Instances can only be deleted by passing "cascade=true" +parameter.

+ +++ + + + + + + + + + + + + + +
Parameters:
    +
  • service_id (str) – (required)
    • +
  • cascade (bool or None) – Flag to cascade delete all the child objects, associated with it. +(optional, default to false)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get(service_id)
+

Returns information about Service-Insertion Service with the given +identifier.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:service_id (str) – (required)
Return type:com.vmware.nsx.model_client.ServiceDefinition
Returns:com.vmware.nsx.model.ServiceDefinition
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list()
+

List all Service-Insertion Service Definitions.

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.ServiceInsertionServiceListResult
Returns:com.vmware.nsx.model.ServiceInsertionServiceListResult
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+update(service_id, service_definition)
+

Modifies the specified Service.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.ServiceDefinition

+
Returns:

com.vmware.nsx.model.ServiceDefinition

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.serviceinsertion_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+

com.vmware.nsx.switching_profiles_client module

+
+
+class com.vmware.nsx.switching_profiles_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+class com.vmware.nsx.switching_profiles_client.Summary(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(switching_profile_id)
+

Get Counts of Ports and Switches Using This Switching Profile

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:switching_profile_id (str) – (required)
Return type:com.vmware.nsx.model_client.SwitchingProfileStatus
Returns:com.vmware.nsx.model.SwitchingProfileStatus
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+

com.vmware.nsx.tasks_client module

+
+
+class com.vmware.nsx.tasks_client.Response(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(task_id)
+

Get the response of a task

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:task_id (str) – ID of task to read (required)
Return type:vmware.vapi.struct.VapiStruct
Returns:DynamicStructure
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.tasks_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+

com.vmware.nsx.telemetry_client module

+
+
+class com.vmware.nsx.telemetry_client.Agreement(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Returns telemetry agreement information.

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.TelemetryAgreement
Returns:com.vmware.nsx.model.TelemetryAgreement
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+update(telemetry_agreement)
+

Set telemetry agreement information.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:telemetry_agreement (com.vmware.nsx.model_client.TelemetryAgreement) – (required)
Return type:com.vmware.nsx.model_client.TelemetryAgreement
Returns:com.vmware.nsx.model.TelemetryAgreement
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.telemetry_client.Config(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Returns the telemetry configuration.

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.TelemetryConfig
Returns:com.vmware.nsx.model.TelemetryConfig
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+update(telemetry_config)
+

Updates or creates the telemetry configuration, and returns the new +configuration.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:telemetry_config (com.vmware.nsx.model_client.TelemetryConfig) – (required)
Return type:com.vmware.nsx.model_client.TelemetryConfig
Returns:com.vmware.nsx.model.TelemetryConfig
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.telemetry_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+

com.vmware.nsx.traceflows_client module

+
+
+class com.vmware.nsx.traceflows_client.Observations(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+LIST_COMPONENT_TYPE_BRIDGE = 'BRIDGE'
+

Possible value for componentType of method Observations.list().

+
+ +
+
+LIST_COMPONENT_TYPE_DFW = 'DFW'
+

Possible value for componentType of method Observations.list().

+
+ +
+
+LIST_COMPONENT_TYPE_EDGE_HOSTSWITCH = 'EDGE_HOSTSWITCH'
+

Possible value for componentType of method Observations.list().

+
+ +
+
+LIST_COMPONENT_TYPE_EDGE_TUNNEL = 'EDGE_TUNNEL'
+

Possible value for componentType of method Observations.list().

+
+ +
+
+LIST_COMPONENT_TYPE_LR = 'LR'
+

Possible value for componentType of method Observations.list().

+
+ +
+
+LIST_COMPONENT_TYPE_LS = 'LS'
+

Possible value for componentType of method Observations.list().

+
+ +
+
+LIST_COMPONENT_TYPE_PHYSICAL = 'PHYSICAL'
+

Possible value for componentType of method Observations.list().

+
+ +
+
+LIST_COMPONENT_TYPE_UNKNOWN = 'UNKNOWN'
+

Possible value for componentType of method Observations.list().

+
+ +
+
+LIST_RESOURCE_TYPE_TRACEFLOWOBSERVATIONDELIVERED = 'TraceflowObservationDelivered'
+

Possible value for resourceType of method Observations.list().

+
+ +
+
+LIST_RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPED = 'TraceflowObservationDropped'
+

Possible value for resourceType of method Observations.list().

+
+ +
+
+LIST_RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPEDLOGICAL = 'TraceflowObservationDroppedLogical'
+

Possible value for resourceType of method Observations.list().

+
+ +
+
+LIST_RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDED = 'TraceflowObservationForwarded'
+

Possible value for resourceType of method Observations.list().

+
+ +
+
+LIST_RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDEDLOGICAL = 'TraceflowObservationForwardedLogical'
+

Possible value for resourceType of method Observations.list().

+
+ +
+
+LIST_RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVED = 'TraceflowObservationReceived'
+

Possible value for resourceType of method Observations.list().

+
+ +
+
+LIST_RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVEDLOGICAL = 'TraceflowObservationReceivedLogical'
+

Possible value for resourceType of method Observations.list().

+
+ +
+
+list(traceflow_id, component_name=None, component_type=None, cursor=None, included_fields=None, page_size=None, resource_type=None, sort_ascending=None, sort_by=None, transport_node_name=None)
+

Get observations for the Traceflow round

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • traceflow_id (str) – (required)
    • +
  • component_name (str or None) – Observations having the given component name will be listed. +(optional)
    • +
  • component_type (str or None) – Observations having the given component type will be listed. +(optional)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • resource_type (str or None) – The type of observations that will be listed. (optional)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
  • transport_node_name (str or None) – Observations having the given transport node name will be listed. +(optional)
    • +
+
Return type:

com.vmware.nsx.model_client.TraceflowObservationListResult

+
Returns:

com.vmware.nsx.model.TraceflowObservationListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.traceflows_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+

com.vmware.nsx.transport_nodes_client module

+
+
+class com.vmware.nsx.transport_nodes_client.PnicBondStatus(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+list(node_id)
+

Get high-level summary of a transport node

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:node_id (str) – ID of transport node (required)
Return type:com.vmware.nsx.model_client.PnicBondStatusListResult
Returns:com.vmware.nsx.model.PnicBondStatusListResult
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.transport_nodes_client.RemoteTransportNodeStatus(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+LIST_BFD_DIAGNOSTIC_CODE_0 = '0'
+

Possible value for bfdDiagnosticCode of method +RemoteTransportNodeStatus.list().

+
+ +
+
+LIST_BFD_DIAGNOSTIC_CODE_1 = '1'
+

Possible value for bfdDiagnosticCode of method +RemoteTransportNodeStatus.list().

+
+ +
+
+LIST_BFD_DIAGNOSTIC_CODE_2 = '2'
+

Possible value for bfdDiagnosticCode of method +RemoteTransportNodeStatus.list().

+
+ +
+
+LIST_BFD_DIAGNOSTIC_CODE_3 = '3'
+

Possible value for bfdDiagnosticCode of method +RemoteTransportNodeStatus.list().

+
+ +
+
+LIST_BFD_DIAGNOSTIC_CODE_4 = '4'
+

Possible value for bfdDiagnosticCode of method +RemoteTransportNodeStatus.list().

+
+ +
+
+LIST_BFD_DIAGNOSTIC_CODE_5 = '5'
+

Possible value for bfdDiagnosticCode of method +RemoteTransportNodeStatus.list().

+
+ +
+
+LIST_BFD_DIAGNOSTIC_CODE_6 = '6'
+

Possible value for bfdDiagnosticCode of method +RemoteTransportNodeStatus.list().

+
+ +
+
+LIST_BFD_DIAGNOSTIC_CODE_7 = '7'
+

Possible value for bfdDiagnosticCode of method +RemoteTransportNodeStatus.list().

+
+ +
+
+LIST_BFD_DIAGNOSTIC_CODE_8 = '8'
+

Possible value for bfdDiagnosticCode of method +RemoteTransportNodeStatus.list().

+
+ +
+
+LIST_BFD_DIAGNOSTIC_CODE_ADMINISTRATIVELY_DOWN = 'ADMINISTRATIVELY_DOWN'
+

Possible value for bfdDiagnosticCode of method +RemoteTransportNodeStatus.list().

+
+ +
+
+LIST_BFD_DIAGNOSTIC_CODE_CONCATENATED_PATH_DOWN = 'CONCATENATED_PATH_DOWN'
+

Possible value for bfdDiagnosticCode of method +RemoteTransportNodeStatus.list().

+
+ +
+
+LIST_BFD_DIAGNOSTIC_CODE_CONTROL_DETECTION_TIME_EXPIRED = 'CONTROL_DETECTION_TIME_EXPIRED'
+

Possible value for bfdDiagnosticCode of method +RemoteTransportNodeStatus.list().

+
+ +
+
+LIST_BFD_DIAGNOSTIC_CODE_ECHO_FUNCTION_FAILED = 'ECHO_FUNCTION_FAILED'
+

Possible value for bfdDiagnosticCode of method +RemoteTransportNodeStatus.list().

+
+ +
+
+LIST_BFD_DIAGNOSTIC_CODE_FORWARDING_PLANE_RESET = 'FORWARDING_PLANE_RESET'
+

Possible value for bfdDiagnosticCode of method +RemoteTransportNodeStatus.list().

+
+ +
+
+LIST_BFD_DIAGNOSTIC_CODE_NEIGHBOR_SIGNALED_SESSION_DOWN = 'NEIGHBOR_SIGNALED_SESSION_DOWN'
+

Possible value for bfdDiagnosticCode of method +RemoteTransportNodeStatus.list().

+
+ +
+
+LIST_BFD_DIAGNOSTIC_CODE_NO_DIAGNOSTIC = 'NO_DIAGNOSTIC'
+

Possible value for bfdDiagnosticCode of method +RemoteTransportNodeStatus.list().

+
+ +
+
+LIST_BFD_DIAGNOSTIC_CODE_PATH_DOWN = 'PATH_DOWN'
+

Possible value for bfdDiagnosticCode of method +RemoteTransportNodeStatus.list().

+
+ +
+
+LIST_BFD_DIAGNOSTIC_CODE_REVERSE_CONCATENATED_PATH_DOWN = 'REVERSE_CONCATENATED_PATH_DOWN'
+

Possible value for bfdDiagnosticCode of method +RemoteTransportNodeStatus.list().

+
+ +
+
+LIST_SOURCE_CACHED = 'cached'
+

Possible value for source of method RemoteTransportNodeStatus.list().

+
+ +
+
+LIST_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method RemoteTransportNodeStatus.list().

+
+ +
+
+LIST_TUNNEL_STATUS_DOWN = 'DOWN'
+

Possible value for tunnelStatus of method +RemoteTransportNodeStatus.list().

+
+ +
+
+LIST_TUNNEL_STATUS_UP = 'UP'
+

Possible value for tunnelStatus of method +RemoteTransportNodeStatus.list().

+
+ +
+
+list(node_id, bfd_diagnostic_code=None, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, source=None, tunnel_status=None)
+

Read status of all transport nodes with tunnel connections to transport +node

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • node_id (str) – ID of transport node (required)
    • +
  • bfd_diagnostic_code (str or None) – BFD diagnostic code of Tunnel as defined in RFC 5880 (optional)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
  • source (str or None) – Data source type. (optional)
    • +
  • tunnel_status (str or None) – Tunnel Status (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.TransportNodeStatusListResult

+
Returns:

com.vmware.nsx.model.TransportNodeStatusListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.transport_nodes_client.State(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+LIST_MM_STATE_DISABLED = 'DISABLED'
+

Possible value for mmState of method State.list().

+
+ +
+
+LIST_MM_STATE_ENABLED = 'ENABLED'
+

Possible value for mmState of method State.list().

+
+ +
+
+LIST_MM_STATE_ENTERING = 'ENTERING'
+

Possible value for mmState of method State.list().

+
+ +
+
+LIST_MM_STATE_EXITING = 'EXITING'
+

Possible value for mmState of method State.list().

+
+ +
+
+LIST_STATUS_FAILED = 'FAILED'
+

Possible value for status of method State.list().

+
+ +
+
+LIST_STATUS_IN_PROGRESS = 'IN_PROGRESS'
+

Possible value for status of method State.list().

+
+ +
+
+LIST_STATUS_ORPHANED = 'ORPHANED'
+

Possible value for status of method State.list().

+
+ +
+
+LIST_STATUS_PARTIAL_SUCCESS = 'PARTIAL_SUCCESS'
+

Possible value for status of method State.list().

+
+ +
+
+LIST_STATUS_PENDING = 'PENDING'
+

Possible value for status of method State.list().

+
+ +
+
+LIST_STATUS_SUCCESS = 'SUCCESS'
+

Possible value for status of method State.list().

+
+ +
+
+get(transportnode_id)
+

Returns information about the current state of the transport node +configuration and information about the associated hostswitch.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:transportnode_id (str) – (required)
Return type:com.vmware.nsx.model_client.TransportNodeState
Returns:com.vmware.nsx.model.TransportNodeState
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(mm_state=None, status=None, vtep_ip=None)
+

Returns a list of transport node states that have realized state as +provided as query parameter

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • mm_state (str or None) – maintenance mode state (optional)
    • +
  • status (str or None) – Realized state of transport nodes (optional)
    • +
  • vtep_ip (str or None) – Virtual tunnel endpoint ip address of transport node (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.TransportNodeStateListResult

+
Returns:

com.vmware.nsx.model.TransportNodeStateListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.transport_nodes_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+GET_0_SOURCE_CACHED = 'cached'
+

Possible value for source of method Status.get_0().

+
+ +
+
+GET_0_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Status.get_0().

+
+ +
+
+get()
+

Get high-level summary of all transport nodes. The service layer does +not support source = realtime or cached.

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.HeatMapTransportZoneStatus
Returns:com.vmware.nsx.model.HeatMapTransportZoneStatus
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get_0(node_id, source=None)
+

Read status of a transport node

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • node_id (str) – ID of transport node (required)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.TransportNodeStatus

+
Returns:

com.vmware.nsx.model.TransportNodeStatus

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.transport_nodes_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+class com.vmware.nsx.transport_nodes_client.Tunnels(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+GET_SOURCE_CACHED = 'cached'
+

Possible value for source of method Tunnels.get().

+
+ +
+
+GET_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Tunnels.get().

+
+ +
+
+LIST_BFD_DIAGNOSTIC_CODE_0 = '0'
+

Possible value for bfdDiagnosticCode of method Tunnels.list().

+
+ +
+
+LIST_BFD_DIAGNOSTIC_CODE_1 = '1'
+

Possible value for bfdDiagnosticCode of method Tunnels.list().

+
+ +
+
+LIST_BFD_DIAGNOSTIC_CODE_2 = '2'
+

Possible value for bfdDiagnosticCode of method Tunnels.list().

+
+ +
+
+LIST_BFD_DIAGNOSTIC_CODE_3 = '3'
+

Possible value for bfdDiagnosticCode of method Tunnels.list().

+
+ +
+
+LIST_BFD_DIAGNOSTIC_CODE_4 = '4'
+

Possible value for bfdDiagnosticCode of method Tunnels.list().

+
+ +
+
+LIST_BFD_DIAGNOSTIC_CODE_5 = '5'
+

Possible value for bfdDiagnosticCode of method Tunnels.list().

+
+ +
+
+LIST_BFD_DIAGNOSTIC_CODE_6 = '6'
+

Possible value for bfdDiagnosticCode of method Tunnels.list().

+
+ +
+
+LIST_BFD_DIAGNOSTIC_CODE_7 = '7'
+

Possible value for bfdDiagnosticCode of method Tunnels.list().

+
+ +
+
+LIST_BFD_DIAGNOSTIC_CODE_8 = '8'
+

Possible value for bfdDiagnosticCode of method Tunnels.list().

+
+ +
+
+LIST_BFD_DIAGNOSTIC_CODE_ADMINISTRATIVELY_DOWN = 'ADMINISTRATIVELY_DOWN'
+

Possible value for bfdDiagnosticCode of method Tunnels.list().

+
+ +
+
+LIST_BFD_DIAGNOSTIC_CODE_CONCATENATED_PATH_DOWN = 'CONCATENATED_PATH_DOWN'
+

Possible value for bfdDiagnosticCode of method Tunnels.list().

+
+ +
+
+LIST_BFD_DIAGNOSTIC_CODE_CONTROL_DETECTION_TIME_EXPIRED = 'CONTROL_DETECTION_TIME_EXPIRED'
+

Possible value for bfdDiagnosticCode of method Tunnels.list().

+
+ +
+
+LIST_BFD_DIAGNOSTIC_CODE_ECHO_FUNCTION_FAILED = 'ECHO_FUNCTION_FAILED'
+

Possible value for bfdDiagnosticCode of method Tunnels.list().

+
+ +
+
+LIST_BFD_DIAGNOSTIC_CODE_FORWARDING_PLANE_RESET = 'FORWARDING_PLANE_RESET'
+

Possible value for bfdDiagnosticCode of method Tunnels.list().

+
+ +
+
+LIST_BFD_DIAGNOSTIC_CODE_NEIGHBOR_SIGNALED_SESSION_DOWN = 'NEIGHBOR_SIGNALED_SESSION_DOWN'
+

Possible value for bfdDiagnosticCode of method Tunnels.list().

+
+ +
+
+LIST_BFD_DIAGNOSTIC_CODE_NO_DIAGNOSTIC = 'NO_DIAGNOSTIC'
+

Possible value for bfdDiagnosticCode of method Tunnels.list().

+
+ +
+
+LIST_BFD_DIAGNOSTIC_CODE_PATH_DOWN = 'PATH_DOWN'
+

Possible value for bfdDiagnosticCode of method Tunnels.list().

+
+ +
+
+LIST_BFD_DIAGNOSTIC_CODE_REVERSE_CONCATENATED_PATH_DOWN = 'REVERSE_CONCATENATED_PATH_DOWN'
+

Possible value for bfdDiagnosticCode of method Tunnels.list().

+
+ +
+
+LIST_SOURCE_CACHED = 'cached'
+

Possible value for source of method Tunnels.list().

+
+ +
+
+LIST_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Tunnels.list().

+
+ +
+
+LIST_STATUS_DOWN = 'DOWN'
+

Possible value for status of method Tunnels.list().

+
+ +
+
+LIST_STATUS_UP = 'UP'
+

Possible value for status of method Tunnels.list().

+
+ +
+
+get(node_id, tunnel_name, source=None)
+

Tunnel properties

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • node_id (str) – ID of transport node (required)
    • +
  • tunnel_name (str) – Tunnel name (required)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.TunnelProperties

+
Returns:

com.vmware.nsx.model.TunnelProperties

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+list(node_id, bfd_diagnostic_code=None, cursor=None, included_fields=None, page_size=None, remote_node_id=None, sort_ascending=None, sort_by=None, source=None, status=None)
+

List of tunnels

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • node_id (str) – ID of transport node (required)
    • +
  • bfd_diagnostic_code (str or None) – BFD diagnostic code of Tunnel as defined in RFC 5880 (optional)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • remote_node_id (str or None) – (optional)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
  • source (str or None) – Data source type. (optional)
    • +
  • status (str or None) – Tunnel status (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.TunnelList

+
Returns:

com.vmware.nsx.model.TunnelList

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+

com.vmware.nsx.transport_zones_client module

+
+
+class com.vmware.nsx.transport_zones_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+GET_0_SOURCE_CACHED = 'cached'
+

Possible value for source of method Status.get_0().

+
+ +
+
+GET_0_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Status.get_0().

+
+ +
+
+get()
+

Get high-level summary of a transport zone. The service layer does not +support source = realtime or cached.

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.HeatMapTransportNodesAggregateStatus
Returns:com.vmware.nsx.model.HeatMapTransportNodesAggregateStatus
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get_0(zone_id, source=None)
+

Get high-level summary of a transport zone

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • zone_id (str) – ID of transport zone (required)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.HeatMapTransportZoneStatus

+
Returns:

com.vmware.nsx.model.HeatMapTransportZoneStatus

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.transport_zones_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+class com.vmware.nsx.transport_zones_client.Summary(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(zone_id)
+

Returns information about a specified transport zone, including the +number of logical switches in the transport zone, number of logical +spitch ports assigned to the transport zone, and number of transport +nodes in the transport zone.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:zone_id (str) – (required)
Return type:com.vmware.nsx.model_client.TransportZoneStatus
Returns:com.vmware.nsx.model.TransportZoneStatus
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.transport_zones_client.TransportNodeStatus(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+GETALL_SOURCE_CACHED = 'cached'
+

Possible value for source of method TransportNodeStatus.getall().

+
+ +
+
+GETALL_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method TransportNodeStatus.getall().

+
+ +
+
+GETALL_STATUS_DEGRADED = 'DEGRADED'
+

Possible value for status of method TransportNodeStatus.getall().

+
+ +
+
+GETALL_STATUS_DOWN = 'DOWN'
+

Possible value for status of method TransportNodeStatus.getall().

+
+ +
+
+GETALL_STATUS_UNKNOWN = 'UNKNOWN'
+

Possible value for status of method TransportNodeStatus.getall().

+
+ +
+
+GETALL_STATUS_UP = 'UP'
+

Possible value for status of method TransportNodeStatus.getall().

+
+ +
+
+LIST_SOURCE_CACHED = 'cached'
+

Possible value for source of method TransportNodeStatus.list().

+
+ +
+
+LIST_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method TransportNodeStatus.list().

+
+ +
+
+LIST_STATUS_DEGRADED = 'DEGRADED'
+

Possible value for status of method TransportNodeStatus.list().

+
+ +
+
+LIST_STATUS_DOWN = 'DOWN'
+

Possible value for status of method TransportNodeStatus.list().

+
+ +
+
+LIST_STATUS_UNKNOWN = 'UNKNOWN'
+

Possible value for status of method TransportNodeStatus.list().

+
+ +
+
+LIST_STATUS_UP = 'UP'
+

Possible value for status of method TransportNodeStatus.list().

+
+ +
+
+getall(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, source=None, status=None)
+

Read status of all the transport nodes

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
  • source (str or None) – Data source type. (optional)
    • +
  • status (str or None) – Transport node (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.TransportNodeStatusListResult

+
Returns:

com.vmware.nsx.model.TransportNodeStatusListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+list(zone_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, source=None, status=None)
+

Read status of transport nodes in a transport zone

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • zone_id (str) – ID of transport zone (required)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
  • source (str or None) – Data source type. (optional)
    • +
  • status (str or None) – Transport node (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.TransportNodeStatusListResult

+
Returns:

com.vmware.nsx.model.TransportNodeStatusListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+

com.vmware.nsx.trust_management_client module

+
+
+class com.vmware.nsx.trust_management_client.Certificates(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+LIST_TYPE_CERTIFICATE = 'cluster_api_certificate'
+

Possible value for type of method Certificates.list().

+
+ +
+
+delete(cert_id)
+

Removes the specified certificate. The private key associated with the +certificate is also deleted.

+ +++ + + + + + + + + + + + + + +
Parameters:cert_id (str) – ID of certificate to delete (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(cert_id, details=None)
+

Returns information for the specified certificate ID, including the +certificate’s UUID; resource_type (for example, +certificate_self_signed, certificate_ca, or certificate_signed); +pem_encoded data; and history of the certificate (who created or +modified it and when). For additional information, include the +?details=true modifier at the end of the request URI.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cert_id (str) – ID of certificate to read (required)
    • +
  • details (bool or None) – whether to expand the pem data and show all its details (optional, +default to false)
    • +
+
Return type:

com.vmware.nsx.model_client.Certificate

+
Returns:

com.vmware.nsx.model.Certificate

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+importcertificate(trust_object_data)
+

Adds a new private-public certificate or a chain of certificates (CAs) +and, optionally, a private key that can be applied to one of the +user-facing components (appliance management or edge). The certificate +and the key should be stored in PEM format. If no private key is +provided, the certificate is used as a client certificate in the trust +store.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:trust_object_data (com.vmware.nsx.model_client.TrustObjectData) – (required)
Return type:com.vmware.nsx.model_client.CertificateList
Returns:com.vmware.nsx.model.CertificateList
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, details=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, type=None)
+

Returns all certificate information viewable by the user, including +each certificate’s UUID; resource_type (for example, +certificate_self_signed, certificate_ca, or certificate_signed); +pem_encoded data; and history of the certificate (who created or +modified it and when). For additional information, include the +?details=true modifier at the end of the request URI.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • details (bool or None) – whether to expand the pem data and show all its details (optional, +default to false)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
  • type (str or None) – Type of certificate to return (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.CertificateList

+
Returns:

com.vmware.nsx.model.CertificateList

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.trust_management_client.Crls(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+LIST_TYPE_CERTIFICATE = 'cluster_api_certificate'
+

Possible value for type of method Crls.list().

+
+ +
+
+delete(crl_id)
+

Deletes an existing CRL.

+ +++ + + + + + + + + + + + + + +
Parameters:crl_id (str) – ID of CRL to delete (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(crl_id, details=None)
+

Returns information about the specified CRL. For additional +information, include the ?details=true modifier at the end of the +request URI.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • crl_id (str) – ID of CRL to read (required)
    • +
  • details (bool or None) – whether to expand the pem data and show all its details (optional, +default to false)
    • +
+
Return type:

com.vmware.nsx.model_client.Crl

+
Returns:

com.vmware.nsx.model.Crl

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+importcrl(crl_object_data)
+

Adds a new certificate revocation list (CRL). The CRL is used to verify +the client certificate status against the revocation lists published by +the CA. For this reason, the administrator needs to add the CRL in +certificate repository as well.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:crl_object_data (com.vmware.nsx.model_client.CrlObjectData) – (required)
Return type:com.vmware.nsx.model_client.CrlList
Returns:com.vmware.nsx.model.CrlList
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, details=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, type=None)
+

Returns information about all CRLs. For additional information, include +the ?details=true modifier at the end of the request URI.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • details (bool or None) – whether to expand the pem data and show all its details (optional, +default to false)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
  • type (str or None) – Type of certificate to return (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.CrlList

+
Returns:

com.vmware.nsx.model.CrlList

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(crl_id, crl)
+

Updates an existing CRL.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.Crl

+
Returns:

com.vmware.nsx.model.Crl

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.trust_management_client.Csrs(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(csr)
+

Creates a new certificate signing request (CSR). A CSR is encrypted +text that contains information about your organization (organization +name, country, and so on) and your Web server’s public key, which is a +public certificate the is generated on the server that can be used to +forward this request to a certificate authority (CA). A private key is +also usually created at the same time as the CSR.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:csr (com.vmware.nsx.model_client.Csr) – (required)
Return type:com.vmware.nsx.model_client.Csr
Returns:com.vmware.nsx.model.Csr
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(csr_id)
+

Removes a specified CSR. If a CSR is not used for verification, you can +delete it. Note that the CSR import and upload POST actions +automatically delete the associated CSR.

+ +++ + + + + + + + + + + + + + +
Parameters:csr_id (str) – ID of CSR to delete (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(csr_id)
+

Returns information about the specified CSR.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:csr_id (str) – ID of CSR to read (required)
Return type:com.vmware.nsx.model_client.Csr
Returns:com.vmware.nsx.model.Csr
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+importcsr(csr_id, trust_object_data)
+

Imports a certificate authority (CA)-signed certificate for a CSR. This +action links the certificate to the private key created by the CSR. The +pem_encoded string in the request body is the signed certificate +provided by your CA in response to the CSR that you provide to them. +The import POST action automatically deletes the associated CSR.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.CertificateList

+
Returns:

com.vmware.nsx.model.CertificateList

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Returns information about all of the CSRs that have been created.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.CsrList

+
Returns:

com.vmware.nsx.model.CsrList

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+selfsign(csr_id, days_valid)
+

Self-signs the previously generated CSR. This action is similar to the +import certificate action, but instead of using a public certificate +signed by a CA, the self_sign POST action uses a certificate that is +signed with NSX’s own private key.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • csr_id (str) – CSR this certificate is associated with (required)
    • +
  • days_valid (long) – Number of days the certificate will be valid, default 10 years +(required)
    • +
+
Return type:

com.vmware.nsx.model_client.Certificate

+
Returns:

com.vmware.nsx.model.Certificate

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.trust_management_client.PrincipalIdentities(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(principal_identity)
+

Associates a principal’s name with a certificate that is used to +authenticate.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:principal_identity (com.vmware.nsx.model_client.PrincipalIdentity) – (required)
Return type:com.vmware.nsx.model_client.PrincipalIdentity
Returns:com.vmware.nsx.model.PrincipalIdentity
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(principal_identity_id)
+

Delete a principal identity. It does not delete the certificate.

+ +++ + + + + + + + + + + + + + +
Parameters:principal_identity_id (str) – Unique id of the principal identity to delete (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(principal_identity_id)
+

Get a stored principal identity

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:principal_identity_id (str) – ID of Principal Identity to get (required)
Return type:com.vmware.nsx.model_client.PrincipalIdentity
Returns:com.vmware.nsx.model.PrincipalIdentity
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list()
+

Returns the list of principals registered with a certificate.

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.PrincipalIdentityList
Returns:com.vmware.nsx.model.PrincipalIdentityList
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+updatecertificate(update_principal_identity_certificate_request)
+

Update a principal identity’s certificate

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:update_principal_identity_certificate_request (com.vmware.nsx.model_client.UpdatePrincipalIdentityCertificateRequest) – (required)
Return type:com.vmware.nsx.model_client.PrincipalIdentity
Returns:com.vmware.nsx.model.PrincipalIdentity
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.trust_management_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+

com.vmware.nsx.ui_views_client module

+
+
+class com.vmware.nsx.ui_views_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+class com.vmware.nsx.ui_views_client.Widgetconfigurations(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(view_id, widget_configuration)
+

Creates a new Widget Configuration and adds it to the specified view. +Supported resource_types are LabelValueConfiguration, +DonutConfiguration, GridConfiguration, StatsConfiguration, +MultiWidgetConfiguration and ContainerConfiguration. Note: Expressions +should be given in a single line. If an expression spans multiple +lines, then form the expression in a single line. For label-value +pairs, expressions are evaluated as follows: a. First, render +configurations are evaluated in their order of appearance in the widget +config. The ‘field’ is evaluated at the end. b. Second, when render +configuration is provided then the order of evaluation is 1. If +expressions provided in ‘condition’ and ‘display value’ are well-formed +and free of runtime-errors such as ‘null pointers’ and evaluates to +‘true’; Then remaining render configurations are not evaluated, and the +current render configuration’s ‘display value’ is taken as the final +value. 2. If expression provided in ‘condition’ of render configuration +is false, then next render configuration is evaluated. 3. Finally, +‘field’ is evaluated only when every render configuration evaluates to +false and no error occurs during steps 1 and 2 above. If an error +occurs during evaluation of render configuration, then an error message +is shown. The display value corresponding to that label is not shown +and evaluation of the remaining render configurations continues to +collect and show all the error messages (marked with the ‘Label’ for +identification) as ‘Error_Messages: {}’. If during evaluation of +expressions for any label-value pair an error occurs, then it is marked +with error. The errors are shown in the report, along with the label +value pairs that are error-free. Important: For elements that take +expressions, strings should be provided by escaping them with a +back-slash. These elements are - condition, field, tooltip text and +render_configuration’s display_value.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

vmware.vapi.struct.VapiStruct

+
Returns:

com.vmware.nsx.model.WidgetConfiguration +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.WidgetConfiguration.

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+delete(view_id, widgetconfiguration_id)
+

Detaches widget from a given view. If the widget is no longer part of +any view, then it will be purged.

+ +++ + + + + + + + + + + + + + +
Parameters:
    +
  • view_id (str) – (required)
    • +
  • widgetconfiguration_id (str) – (required)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get(view_id, container=None, widget_ids=None)
+

If no query params are specified then all the Widget Configurations of +the specified view are returned.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • view_id (str) – (required)
    • +
  • container (str or None) – Id of the container (optional)
    • +
  • widget_ids (str or None) – Ids of the WidgetConfigurations (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.WidgetConfigurationList

+
Returns:

com.vmware.nsx.model.WidgetConfigurationList

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get_0(view_id, widgetconfiguration_id)
+

Returns Information about a specific Widget Configuration.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • view_id (str) – (required)
    • +
  • widgetconfiguration_id (str) – (required)
    • +
+
Return type:

vmware.vapi.struct.VapiStruct

+
Returns:

com.vmware.nsx.model.WidgetConfiguration +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.WidgetConfiguration.

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(view_id, widgetconfiguration_id, widget_configuration)
+

Updates the widget at the given view. If the widget is referenced by +other views, then the widget will be updated in all the views that it +is part of.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • view_id (str) – (required)
    • +
  • widgetconfiguration_id (str) – (required)
    • +
  • widget_configuration (vmware.vapi.struct.VapiStruct) – (required) +The parameter must contain all the attributes defined in +com.vmware.nsx.model_client.WidgetConfiguration.
    • +
+
Return type:

vmware.vapi.struct.VapiStruct

+
Returns:

com.vmware.nsx.model.WidgetConfiguration +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.WidgetConfiguration.

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+

com.vmware.nsx.upgrade_client module

+
+
+class com.vmware.nsx.upgrade_client.Bundles(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(upgrade_bundle_fetch_request)
+

Fetch upgrade bundle from given url

+ +++ + + + + + + + + + + + + + + + + + + + +
Parameters:upgrade_bundle_fetch_request (com.vmware.nsx.model_client.UpgradeBundleFetchRequest) – (required)
Return type:com.vmware.nsx.model_client.UpgradeBundleId
Returns:com.vmware.nsx.model.UpgradeBundleId
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
Raise:com.vmware.vapi.std.errors_client.Unauthenticated +Unauthorized
+
+ +
+
+get(bundle_id)
+

Get uploaded upgrade bundle information

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:bundle_id (str) – (required)
Return type:com.vmware.nsx.model_client.UpgradeBundleInfo
Returns:com.vmware.nsx.model.UpgradeBundleInfo
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.upgrade_client.History(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+list()
+

Get upgrade history

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.UpgradeHistoryList
Returns:com.vmware.nsx.model.UpgradeHistoryList
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.upgrade_client.Nodes(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+list(component_type=None, component_version=None, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Get list of nodes across all types

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • component_type (str or None) – Component type based on which nodes will be filtered (optional)
    • +
  • component_version (str or None) – Component version based on which nodes will be filtered (optional)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.NodeInfoListResult

+
Returns:

com.vmware.nsx.model.NodeInfoListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.upgrade_client.NodesSummary(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Get summary of nodes

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeSummaryList
Returns:com.vmware.nsx.model.NodeSummaryList
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.upgrade_client.Plan(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+continue_(skip=None)
+

Continue upgrade

+ +++ + + + + + + + + + + + + + + + +
Parameters:skip (bool or None) – Skip to upgrade of next component. (optional, default to false)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.ConcurrentChange +Conflict
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+pause()
+

Pause upgrade

+ +++ + + + + + + + + + + + + + +
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.ConcurrentChange +Conflict
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+reset(component_type)
+

Reset the upgrade plan to default plan. User has an option to change +the default plan. But if after making changes, user wants to go back to +the default plan, this is the way to do so.

+ +++ + + + + + + + + + + + + + +
Parameters:component_type (str) – Component type (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+start()
+

Start upgrade

+ +++ + + + + + + + + + + + +
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+upgradeselectedunits(upgrade_unit_list)
+

Upgrade selected units

+ +++ + + + + + + + + + + + + + + + +
Parameters:upgrade_unit_list (com.vmware.nsx.model_client.UpgradeUnitList) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.ConcurrentChange +Conflict
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.upgrade_client.StatusSummary(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+GET_SELECTION_STATUS_ALL = 'ALL'
+

Possible value for selectionStatus of method StatusSummary.get().

+
+ +
+
+GET_SELECTION_STATUS_DESELECTED = 'DESELECTED'
+

Possible value for selectionStatus of method StatusSummary.get().

+
+ +
+
+GET_SELECTION_STATUS_SELECTED = 'SELECTED'
+

Possible value for selectionStatus of method StatusSummary.get().

+
+ +
+
+get(component_type=None, selection_status=None, show_history=None)
+

Get upgrade status summary

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • component_type (str or None) – Component type based on which upgrade units to be filtered +(optional)
    • +
  • selection_status (str or None) – Flag to indicate whether to return status for only selected, only +deselected or both type of upgrade units (optional, default to ALL)
    • +
  • show_history (bool or None) – Get upgrade activity for a given component (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.UpgradeStatus

+
Returns:

com.vmware.nsx.model.UpgradeStatus

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.upgrade_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+class com.vmware.nsx.upgrade_client.Summary(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Get upgrade summary

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.UpgradeSummary
Returns:com.vmware.nsx.model.UpgradeSummary
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.upgrade_client.UpgradeUnitGroups(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+addupgradeunits(group_id, upgrade_unit_list)
+

Add upgrade units to specified upgrade unit group

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.UpgradeUnitList

+
Returns:

com.vmware.nsx.model.UpgradeUnitList

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+create(upgrade_unit_group)
+

Create a group

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:upgrade_unit_group (com.vmware.nsx.model_client.UpgradeUnitGroup) – (required)
Return type:com.vmware.nsx.model_client.UpgradeUnitGroup
Returns:com.vmware.nsx.model.UpgradeUnitGroup
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(group_id)
+

Delete the upgrade unit group

+ +++ + + + + + + + + + + + + + +
Parameters:group_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(group_id, summary=None)
+

Return upgrade unit group information

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • group_id (str) – (required)
    • +
  • summary (bool or None) – Flag indicating whether to return the summary (optional, default to +false)
    • +
+
Return type:

com.vmware.nsx.model_client.UpgradeUnitGroup

+
Returns:

com.vmware.nsx.model.UpgradeUnitGroup

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+list(component_type=None, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, summary=None, sync=None)
+

Return information of all upgrade unit groups

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • component_type (str or None) – Component type based on which upgrade unit groups to be filtered +(optional)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
  • summary (bool or None) – Flag indicating whether to return summary (optional, default to +false)
    • +
  • sync (bool or None) – Synchronize before returning upgrade unit groups (optional, default +to false)
    • +
+
Return type:

com.vmware.nsx.model_client.UpgradeUnitGroupListResult

+
Returns:

com.vmware.nsx.model.UpgradeUnitGroupListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+reorder(group_id, reorder_request)
+

Reorder upgrade unit group

+ +++ + + + + + + + + + + + + + +
Parameters: +
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(group_id, upgrade_unit_group)
+

Update the upgrade unit group

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.UpgradeUnitGroup

+
Returns:

com.vmware.nsx.model.UpgradeUnitGroup

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.upgrade_client.UpgradeUnitGroupsStatus(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+getall(component_type=None, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Get upgrade status for upgrade unit groups

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • component_type (str or None) – Component type based on which upgrade unit groups to be filtered +(optional)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.UpgradeUnitGroupStatusListResult

+
Returns:

com.vmware.nsx.model.UpgradeUnitGroupStatusListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.upgrade_client.UpgradeUnits(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(upgrade_unit_id)
+

Get a specific upgrade unit

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:upgrade_unit_id (str) – (required)
Return type:com.vmware.nsx.model_client.UpgradeUnit
Returns:com.vmware.nsx.model.UpgradeUnit
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(component_type=None, current_version=None, cursor=None, group_id=None, has_warnings=None, included_fields=None, metadata=None, page_size=None, sort_ascending=None, sort_by=None, upgrade_unit_type=None)
+

Get upgrade units

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • component_type (str or None) – Component type based on which upgrade units to be filtered +(optional)
    • +
  • current_version (str or None) – Current version of upgrade unit based on which upgrade units to be +filtered (optional)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • group_id (str or None) – UUID of group based on which upgrade units to be filtered +(optional)
    • +
  • has_warnings (bool or None) – Flag to indicate whether to return only upgrade units with warnings +(optional, default to false)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • metadata (str or None) – Metadata about upgrade unit to filter on (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
  • upgrade_unit_type (str or None) – Upgrade unit type based on which upgrade units to be filtered +(optional)
    • +
+
Return type:

com.vmware.nsx.model_client.UpgradeUnitListResult

+
Returns:

com.vmware.nsx.model.UpgradeUnitListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.upgrade_client.UpgradeUnitsStats(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, sync=None)
+

Get upgrade units stats

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
  • sync (bool or None) – Synchronize before returning upgrade unit stats (optional, default +to false)
    • +
+
Return type:

com.vmware.nsx.model_client.UpgradeUnitTypeStatsList

+
Returns:

com.vmware.nsx.model.UpgradeUnitTypeStatsList

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.upgrade_client.VersionWhitelist(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(component_type)
+

Get whitelist of versions for a component. Component can include HOST, +EDGE, CCP, MP

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:component_type (str) – (required)
Return type:com.vmware.nsx.model_client.AcceptableComponentVersion
Returns:com.vmware.nsx.model.AcceptableComponentVersion
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list()
+

Get whitelist of versions for different components

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.AcceptableComponentVersionList
Returns:com.vmware.nsx.model.AcceptableComponentVersionList
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+update(component_type, version_list)
+

Update the version whitelist for the specified component type (HOST, +EDGE, CCP, MP).

+ +++ + + + + + + + + + + + + + +
Parameters: +
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/com.vmware.nsx.lldp.html b/nsx/nsx/com.vmware.nsx.lldp.html new file mode 100644 index 00000000..87ac831d --- /dev/null +++ b/nsx/nsx/com.vmware.nsx.lldp.html @@ -0,0 +1,345 @@ + + + + + + + + + + + com.vmware.nsx.lldp package — NSX-T SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

com.vmware.nsx.lldp package

+
+

Submodules

+
+
+

com.vmware.nsx.lldp.transport_nodes_client module

+
+
+class com.vmware.nsx.lldp.transport_nodes_client.Interfaces(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(node_id, interface_name)
+

Read LLDP Neighbor Properties

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • node_id (str) – ID of transport node (required)
    • +
  • interface_name (str) – Interface name to read (required)
    • +
+
Return type:

com.vmware.nsx.model_client.InterfaceNeighborProperties

+
Returns:

com.vmware.nsx.model.InterfaceNeighborProperties

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+list(node_id)
+

List LLDP Neighbor Properties

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:node_id (str) – ID of transport node (required)
Return type:com.vmware.nsx.model_client.InterfaceNeighborPropertyListResult
Returns:com.vmware.nsx.model.InterfaceNeighborPropertyListResult
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.lldp.transport_nodes_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/com.vmware.nsx.loadbalancer.html b/nsx/nsx/com.vmware.nsx.loadbalancer.html new file mode 100644 index 00000000..9906bf90 --- /dev/null +++ b/nsx/nsx/com.vmware.nsx.loadbalancer.html @@ -0,0 +1,588 @@ + + + + + + + + + + + com.vmware.nsx.loadbalancer package — NSX-T SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

com.vmware.nsx.loadbalancer package

+ +
+

Submodules

+
+
+

com.vmware.nsx.loadbalancer.services_client module

+
+
+class com.vmware.nsx.loadbalancer.services_client.DebugInfo(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(service_id)
+

API to download below information which will be used for debugging and +troubleshooting. 1) Load balancer service 2) Load balancer associated +virtual servers 3) Load balancer associated pools 4) Load balancer +associated profiles such as persistence, SSL, application. 5) Load +balancer associated monitors 6) Load balancer associated rules

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:service_id (str) – (required)
Return type:com.vmware.nsx.model_client.LbServiceDebugInfo
Returns:com.vmware.nsx.model.LbServiceDebugInfo
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.loadbalancer.services_client.Statistics(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+GET_SOURCE_CACHED = 'cached'
+

Possible value for source of method Statistics.get().

+
+ +
+
+GET_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Statistics.get().

+
+ +
+
+get(service_id, source=None)
+

Returns the statistics of the given load balancer service.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • service_id (str) – (required)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.LbServiceStatistics

+
Returns:

com.vmware.nsx.model.LbServiceStatistics

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.loadbalancer.services_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+GET_SOURCE_CACHED = 'cached'
+

Possible value for source of method Status.get().

+
+ +
+
+GET_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Status.get().

+
+ +
+
+get(service_id, source=None)
+

Returns the status of the given load balancer service.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • service_id (str) – (required)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.LbServiceStatus

+
Returns:

com.vmware.nsx.model.LbServiceStatus

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.loadbalancer.services_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+class com.vmware.nsx.loadbalancer.services_client.Usage(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(service_id)
+

API to fetch the capacity and current usage of the given load balancer +service.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:service_id (str) – (required)
Return type:com.vmware.nsx.model_client.LbServiceUsage
Returns:com.vmware.nsx.model.LbServiceUsage
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+

com.vmware.nsx.loadbalancer.ssl_client module

+
+
+class com.vmware.nsx.loadbalancer.ssl_client.CiphersAndProtocols(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Retrieve a list of supported SSL ciphers and protocols.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.LbSslCipherAndProtocolListResult

+
Returns:

com.vmware.nsx.model.LbSslCipherAndProtocolListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.loadbalancer.ssl_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/com.vmware.nsx.loadbalancer.services.html b/nsx/nsx/com.vmware.nsx.loadbalancer.services.html new file mode 100644 index 00000000..8946e319 --- /dev/null +++ b/nsx/nsx/com.vmware.nsx.loadbalancer.services.html @@ -0,0 +1,790 @@ + + + + + + + + + + + com.vmware.nsx.loadbalancer.services package — NSX-T SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

com.vmware.nsx.loadbalancer.services package

+
+

Submodules

+
+
+

com.vmware.nsx.loadbalancer.services.pools_client module

+
+
+class com.vmware.nsx.loadbalancer.services.pools_client.Statistics(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+GET_SOURCE_CACHED = 'cached'
+

Possible value for source of method Statistics.get().

+
+ +
+
+GET_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Statistics.get().

+
+ +
+
+LIST_SOURCE_CACHED = 'cached'
+

Possible value for source of method Statistics.list().

+
+ +
+
+LIST_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Statistics.list().

+
+ +
+
+get(service_id, pool_id, source=None)
+

Returns the statistics of the given load balancer pool by given load +balancer serives id and load balancer pool id.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • service_id (str) – (required)
    • +
  • pool_id (str) – (required)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.LbPoolStatistics

+
Returns:

com.vmware.nsx.model.LbPoolStatistics

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+list(service_id, source=None)
+

Returns the statistics list of load balancer pools in given load +balancer service.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • service_id (str) – (required)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.LbPoolStatisticsListResult

+
Returns:

com.vmware.nsx.model.LbPoolStatisticsListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.loadbalancer.services.pools_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+GET_SOURCE_CACHED = 'cached'
+

Possible value for source of method Status.get().

+
+ +
+
+GET_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Status.get().

+
+ +
+
+LIST_SOURCE_CACHED = 'cached'
+

Possible value for source of method Status.list().

+
+ +
+
+LIST_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Status.list().

+
+ +
+
+get(service_id, pool_id, source=None)
+

Returns the status of the given load balancer pool by given load +balancer serives id and load balancer pool id.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • service_id (str) – (required)
    • +
  • pool_id (str) – (required)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.LbPoolStatus

+
Returns:

com.vmware.nsx.model.LbPoolStatus

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+list(service_id, source=None)
+

Returns the status list of load balancer pools in given load balancer +service.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • service_id (str) – (required)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.LbPoolStatusListResult

+
Returns:

com.vmware.nsx.model.LbPoolStatusListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.loadbalancer.services.pools_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+

com.vmware.nsx.loadbalancer.services.virtual_servers_client module

+
+
+class com.vmware.nsx.loadbalancer.services.virtual_servers_client.Statistics(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+GET_SOURCE_CACHED = 'cached'
+

Possible value for source of method Statistics.get().

+
+ +
+
+GET_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Statistics.get().

+
+ +
+
+LIST_SOURCE_CACHED = 'cached'
+

Possible value for source of method Statistics.list().

+
+ +
+
+LIST_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Statistics.list().

+
+ +
+
+get(service_id, virtual_server_id, source=None)
+

Returns the statistics of the load balancer virtual server by given +load balancer serives id and load balancer virtual server id.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • service_id (str) – (required)
    • +
  • virtual_server_id (str) – (required)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.LbVirtualServerStatistics

+
Returns:

com.vmware.nsx.model.LbVirtualServerStatistics

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+list(service_id, source=None)
+

Returns the statistics list of virtual servers in given load balancer +service.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • service_id (str) – (required)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.LbVirtualServerStatisticsListResult

+
Returns:

com.vmware.nsx.model.LbVirtualServerStatisticsListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.loadbalancer.services.virtual_servers_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+GET_SOURCE_CACHED = 'cached'
+

Possible value for source of method Status.get().

+
+ +
+
+GET_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Status.get().

+
+ +
+
+LIST_SOURCE_CACHED = 'cached'
+

Possible value for source of method Status.list().

+
+ +
+
+LIST_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Status.list().

+
+ +
+
+get(service_id, virtual_server_id, source=None)
+

Returns the status of the virtual server by given load balancer serives +id and load balancer virtual server id.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • service_id (str) – (required)
    • +
  • virtual_server_id (str) – (required)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.LbVirtualServerStatus

+
Returns:

com.vmware.nsx.model.LbVirtualServerStatus

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+list(service_id, source=None)
+

Returns the status list of virtual servers in given load balancer +service.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • service_id (str) – (required)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.LbVirtualServerStatusListResult

+
Returns:

com.vmware.nsx.model.LbVirtualServerStatusListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.loadbalancer.services.virtual_servers_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/com.vmware.nsx.logical_router_ports.html b/nsx/nsx/com.vmware.nsx.logical_router_ports.html new file mode 100644 index 00000000..4a2bfc00 --- /dev/null +++ b/nsx/nsx/com.vmware.nsx.logical_router_ports.html @@ -0,0 +1,326 @@ + + + + + + + + + + + com.vmware.nsx.logical_router_ports package — NSX-T SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

com.vmware.nsx.logical_router_ports package

+
+

Submodules

+
+
+

com.vmware.nsx.logical_router_ports.statistics_client module

+
+
+class com.vmware.nsx.logical_router_ports.statistics_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+class com.vmware.nsx.logical_router_ports.statistics_client.Summary(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+GET_SOURCE_CACHED = 'cached'
+

Possible value for source of method Summary.get().

+
+ +
+
+GET_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Summary.get().

+
+ +
+
+get(logical_router_port_id, source=None)
+

Returns the summation of statistics from all nodes for the Specified +Logical Router Port. The query parameter "source=realtime" is +not supported.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • logical_router_port_id (str) – (required)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.LogicalRouterPortStatisticsSummary

+
Returns:

com.vmware.nsx.model.LogicalRouterPortStatisticsSummary

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/com.vmware.nsx.logical_routers.html b/nsx/nsx/com.vmware.nsx.logical_routers.html new file mode 100644 index 00000000..60ce0c95 --- /dev/null +++ b/nsx/nsx/com.vmware.nsx.logical_routers.html @@ -0,0 +1,1877 @@ + + + + + + + + + + + com.vmware.nsx.logical_routers package — NSX-T SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

com.vmware.nsx.logical_routers package

+ +
+

Submodules

+
+
+

com.vmware.nsx.logical_routers.nat_client module

+
+
+class com.vmware.nsx.logical_routers.nat_client.Rules(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(logical_router_id, nat_rule)
+

Add a NAT rule in a specific logical router.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.NatRule

+
Returns:

com.vmware.nsx.model.NatRule

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+delete(logical_router_id, rule_id)
+

Delete a specific NAT rule from a logical router

+ +++ + + + + + + + + + + + + + +
Parameters:
    +
  • logical_router_id (str) – (required)
    • +
  • rule_id (str) – (required)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get(logical_router_id, rule_id)
+

Get a specific NAT rule from a given logical router

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • logical_router_id (str) – (required)
    • +
  • rule_id (str) – (required)
    • +
+
Return type:

com.vmware.nsx.model_client.NatRule

+
Returns:

com.vmware.nsx.model.NatRule

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+list(logical_router_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Returns paginated list of all user defined NAT rules of the specific +logical router

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • logical_router_id (str) – (required)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.NatRuleListResult

+
Returns:

com.vmware.nsx.model.NatRuleListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(logical_router_id, rule_id, nat_rule)
+

Update a specific NAT rule from a given logical router.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.NatRule

+
Returns:

com.vmware.nsx.model.NatRule

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.logical_routers.nat_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+

com.vmware.nsx.logical_routers.routing_client module

+
+
+class com.vmware.nsx.logical_routers.routing_client.Advertisement(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(logical_router_id)
+

Returns information about the routes to be advertised by the specified +TIER1 logical router.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:logical_router_id (str) – (required)
Return type:com.vmware.nsx.model_client.AdvertisementConfig
Returns:com.vmware.nsx.model.AdvertisementConfig
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+update(logical_router_id, advertisement_config)
+

Modifies the route advertisement configuration on the specified logical +router.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.AdvertisementConfig

+
Returns:

com.vmware.nsx.model.AdvertisementConfig

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.logical_routers.routing_client.BfdConfig(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(logical_router_id)
+

Returns the BFD configuration for all routing BFD peers. This will be +inherited | by all BFD peers for LogicalRouter unless overriden while +configuring the Peer.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:logical_router_id (str) – (required)
Return type:com.vmware.nsx.model_client.BfdConfig
Returns:com.vmware.nsx.model.BfdConfig
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+update(logical_router_id, bfd_config)
+

Modifies the BFD configuration for routing BFD peers. Note - the +configuration | changes apply only to those routing BFD peers for which +the BFD configuration has | not been overridden at Peer level.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.BfdConfig

+
Returns:

com.vmware.nsx.model.BfdConfig

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.logical_routers.routing_client.Bgp(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(logical_router_id)
+

Returns information about the BGP configuration on a specified logical +router. Information includes whether or not the BGP configuration is +enabled, the AS number, and whether or not graceful restart is enabled.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:logical_router_id (str) – (required)
Return type:com.vmware.nsx.model_client.BgpConfig
Returns:com.vmware.nsx.model.BgpConfig
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+update(logical_router_id, bgp_config)
+

Modifies the BGP configuration on a specified TIER0 logical router. +Modifiable parameters include enabled, graceful_restart, as_number.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.BgpConfig

+
Returns:

com.vmware.nsx.model.BgpConfig

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.logical_routers.routing_client.ForwardingTable(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+LIST_SOURCE_CACHED = 'cached'
+

Possible value for source of method ForwardingTable.list().

+
+ +
+
+LIST_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method ForwardingTable.list().

+
+ +
+
+list(logical_router_id, transport_node_id, cursor=None, included_fields=None, network_prefix=None, page_size=None, sort_ascending=None, sort_by=None, source=None)
+
+++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • logical_router_id (str) – (required)
    • +
  • transport_node_id (str) – TransportNode Id (required)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • network_prefix (str or None) – IPv4 CIDR Block (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.LogicalRouterRouteTable

+
Returns:

com.vmware.nsx.model.LogicalRouterRouteTable

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.logical_routers.routing_client.IpPrefixLists(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(logical_router_id, ip_prefix_list)
+

Adds a new IPPrefixList on a Logical Router

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.IPPrefixList

+
Returns:

com.vmware.nsx.model.IPPrefixList

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+delete(logical_router_id, id)
+

Deletes a specific IPPrefixList on the specified logical router.

+ +++ + + + + + + + + + + + + + +
Parameters:
    +
  • logical_router_id (str) – (required)
    • +
  • id (str) – (required)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get(logical_router_id, id)
+

Read a specific IPPrefixList on the specified logical router.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • logical_router_id (str) – (required)
    • +
  • id (str) – (required)
    • +
+
Return type:

com.vmware.nsx.model_client.IPPrefixList

+
Returns:

com.vmware.nsx.model.IPPrefixList

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+list(logical_router_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Paginated List of IPPrefixLists

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • logical_router_id (str) – (required)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.IPPrefixListListResult

+
Returns:

com.vmware.nsx.model.IPPrefixListListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(logical_router_id, id, ip_prefix_list)
+

Update a specific IPPrefixList on the specified logical router.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.IPPrefixList

+
Returns:

com.vmware.nsx.model.IPPrefixList

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.logical_routers.routing_client.Redistribution(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(logical_router_id)
+

Returns information about configured route redistribution for the +specified logical router.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:logical_router_id (str) – (required)
Return type:com.vmware.nsx.model_client.RedistributionConfig
Returns:com.vmware.nsx.model.RedistributionConfig
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+update(logical_router_id, redistribution_config)
+

Modifies existing route redistribution rules for the specified TIER0 +logical router.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.RedistributionConfig

+
Returns:

com.vmware.nsx.model.RedistributionConfig

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.logical_routers.routing_client.RouteMaps(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(logical_router_id, route_map)
+

Adds a new RouteMap on a Logical Router

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.RouteMap

+
Returns:

com.vmware.nsx.model.RouteMap

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+delete(logical_router_id, id)
+

Deletes a specific RouteMap on the specified logical router.

+ +++ + + + + + + + + + + + + + +
Parameters:
    +
  • logical_router_id (str) – (required)
    • +
  • id (str) – (required)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get(logical_router_id, id)
+

Read a specific RouteMap on the specified logical router.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • logical_router_id (str) – (required)
    • +
  • id (str) – (required)
    • +
+
Return type:

com.vmware.nsx.model_client.RouteMap

+
Returns:

com.vmware.nsx.model.RouteMap

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+list(logical_router_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Paginated List of RouteMaps

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • logical_router_id (str) – (required)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.RouteMapListResult

+
Returns:

com.vmware.nsx.model.RouteMapListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(logical_router_id, id, route_map)
+

Update a specific RouteMap on the specified logical router.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.RouteMap

+
Returns:

com.vmware.nsx.model.RouteMap

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.logical_routers.routing_client.RouteTable(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+LIST_SOURCE_CACHED = 'cached'
+

Possible value for source of method RouteTable.list().

+
+ +
+
+LIST_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method RouteTable.list().

+
+ +
+
+list(logical_router_id, transport_node_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, source=None)
+
+++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • logical_router_id (str) – (required)
    • +
  • transport_node_id (str) – TransportNode Id (required)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.LogicalRouterRouteTable

+
Returns:

com.vmware.nsx.model.LogicalRouterRouteTable

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.logical_routers.routing_client.RoutingTable(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+LIST_ROUTE_SOURCE_BGP = 'BGP'
+

Possible value for routeSource of method RoutingTable.list().

+
+ +
+
+LIST_ROUTE_SOURCE_CONNECTED = 'CONNECTED'
+

Possible value for routeSource of method RoutingTable.list().

+
+ +
+
+LIST_ROUTE_SOURCE_STATIC = 'STATIC'
+

Possible value for routeSource of method RoutingTable.list().

+
+ +
+
+LIST_SOURCE_CACHED = 'cached'
+

Possible value for source of method RoutingTable.list().

+
+ +
+
+LIST_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method RoutingTable.list().

+
+ +
+
+list(logical_router_id, transport_node_id, cursor=None, included_fields=None, network_prefix=None, page_size=None, route_source=None, sort_ascending=None, sort_by=None, source=None)
+
+++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • logical_router_id (str) – (required)
    • +
  • transport_node_id (str) – TransportNode Id (required)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • network_prefix (str or None) – IPv4 CIDR Block (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • route_source (str or None) – To filter the RIB table based on the source from which route is +learned. (optional)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.LogicalRouterRouteTable

+
Returns:

com.vmware.nsx.model.LogicalRouterRouteTable

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.logical_routers.routing_client.StaticRoutes(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(logical_router_id, static_route)
+

Adds a new static route on a Logical Router

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.StaticRoute

+
Returns:

com.vmware.nsx.model.StaticRoute

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+delete(logical_router_id, id)
+

Deletes a specific static route on the specified logical router.

+ +++ + + + + + + + + + + + + + +
Parameters:
    +
  • logical_router_id (str) – (required)
    • +
  • id (str) – (required)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get(logical_router_id, id)
+

Read a specific static routes on the specified logical router.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • logical_router_id (str) – (required)
    • +
  • id (str) – (required)
    • +
+
Return type:

com.vmware.nsx.model_client.StaticRoute

+
Returns:

com.vmware.nsx.model.StaticRoute

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+list(logical_router_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Returns information about configured static routes, including the +network address and next hops for each static route.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • logical_router_id (str) – (required)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.StaticRouteListResult

+
Returns:

com.vmware.nsx.model.StaticRouteListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(logical_router_id, id, static_route)
+

Update a specific static route on the specified logical router.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.StaticRoute

+
Returns:

com.vmware.nsx.model.StaticRoute

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.logical_routers.routing_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/com.vmware.nsx.logical_routers.nat.html b/nsx/nsx/com.vmware.nsx.logical_routers.nat.html new file mode 100644 index 00000000..93b5f413 --- /dev/null +++ b/nsx/nsx/com.vmware.nsx.logical_routers.nat.html @@ -0,0 +1,388 @@ + + + + + + + + + + + com.vmware.nsx.logical_routers.nat package — NSX-T SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

com.vmware.nsx.logical_routers.nat package

+
+

Submodules

+
+
+

com.vmware.nsx.logical_routers.nat.rules_client module

+
+
+class com.vmware.nsx.logical_routers.nat.rules_client.Statistics(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+GETPERLOGICALROUTER_SOURCE_CACHED = 'cached'
+

Possible value for source of method Statistics.getperlogicalrouter().

+
+ +
+
+GETPERLOGICALROUTER_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Statistics.getperlogicalrouter().

+
+ +
+
+GETPERRULE_SOURCE_CACHED = 'cached'
+

Possible value for source of method Statistics.getperrule().

+
+ +
+
+GETPERRULE_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Statistics.getperrule().

+
+ +
+
+getperlogicalrouter(logical_router_id, source=None)
+

Returns the summation of statistics for all rules from all nodes for +the Specified Logical Router. Also gives the per transport node +statistics for provided logical router. The query parameter +"source=realtime" is not supported.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • logical_router_id (str) – (required)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.NatStatisticsPerLogicalRouter

+
Returns:

com.vmware.nsx.model.NatStatisticsPerLogicalRouter

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+getperrule(logical_router_id, rule_id, source=None)
+

Returns the summation of statistics from all nodes for the Specified +Logical Router NAT Rule. Query parameter "source=realtime" is +the only supported source.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • logical_router_id (str) – (required)
    • +
  • rule_id (str) – (required)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.NatStatisticsPerRule

+
Returns:

com.vmware.nsx.model.NatStatisticsPerRule

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.logical_routers.nat.rules_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/com.vmware.nsx.logical_routers.routing.bgp.html b/nsx/nsx/com.vmware.nsx.logical_routers.routing.bgp.html new file mode 100644 index 00000000..f195ac9b --- /dev/null +++ b/nsx/nsx/com.vmware.nsx.logical_routers.routing.bgp.html @@ -0,0 +1,336 @@ + + + + + + + + + + + com.vmware.nsx.logical_routers.routing.bgp package — NSX-T SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

com.vmware.nsx.logical_routers.routing.bgp package

+
+

Submodules

+
+
+

com.vmware.nsx.logical_routers.routing.bgp.neighbors_client module

+
+
+class com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+LIST_SOURCE_CACHED = 'cached'
+

Possible value for source of method Status.list().

+
+ +
+
+LIST_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Status.list().

+
+ +
+
+list(logical_router_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, source=None, transport_node_id=None)
+
+++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • logical_router_id (str) – (required)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
  • source (str or None) – Data source type. (optional)
    • +
  • transport_node_id (str or None) – Transport node id (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.BgpNeighborsStatusListResult

+
Returns:

com.vmware.nsx.model.BgpNeighborsStatusListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/com.vmware.nsx.logical_routers.routing.html b/nsx/nsx/com.vmware.nsx.logical_routers.routing.html new file mode 100644 index 00000000..e6e6ed16 --- /dev/null +++ b/nsx/nsx/com.vmware.nsx.logical_routers.routing.html @@ -0,0 +1,1333 @@ + + + + + + + + + + + com.vmware.nsx.logical_routers.routing package — NSX-T SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

com.vmware.nsx.logical_routers.routing package

+ +
+

Submodules

+
+
+

com.vmware.nsx.logical_routers.routing.advertisement_client module

+
+
+class com.vmware.nsx.logical_routers.routing.advertisement_client.Rules(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(logical_router_id)
+

Returns the advertisement rule list for the specified TIER1 logical +router.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:logical_router_id (str) – (required)
Return type:com.vmware.nsx.model_client.AdvertiseRuleList
Returns:com.vmware.nsx.model.AdvertiseRuleList
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+update(logical_router_id, advertise_rule_list)
+

Modifies the advertisement rules on the specified logical router. The +PUT request must include all the rules with the networks parameter. +Modifiable parameters are networks, display_name, and description. Set +the rules list to empty to delete/clear all rules.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.AdvertiseRuleList

+
Returns:

com.vmware.nsx.model.AdvertiseRuleList

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.logical_routers.routing.advertisement_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+

com.vmware.nsx.logical_routers.routing.bgp_client module

+
+
+class com.vmware.nsx.logical_routers.routing.bgp_client.CommunityLists(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(logical_router_id, b_gp_community_list)
+

Add a new BGP Community List on a Logical Router

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.BGPCommunityList

+
Returns:

com.vmware.nsx.model.BGPCommunityList

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+delete(logical_router_id, community_list_id)
+

Delete a specific BGP community list from a Logical Router

+ +++ + + + + + + + + + + + + + +
Parameters:
    +
  • logical_router_id (str) – (required)
    • +
  • community_list_id (str) – (required)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get(logical_router_id, community_list_id)
+

Read a specific BGP community list from a Logical Router

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • logical_router_id (str) – (required)
    • +
  • community_list_id (str) – (required)
    • +
+
Return type:

com.vmware.nsx.model_client.BGPCommunityList

+
Returns:

com.vmware.nsx.model.BGPCommunityList

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+list(logical_router_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Paginated list of BGP Community Lists on a Logical Router

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • logical_router_id (str) – (required)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.BGPCommunityListListResult

+
Returns:

com.vmware.nsx.model.BGPCommunityListListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.logical_routers.routing.bgp_client.CommuntyLists(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+update(logical_router_id, community_list_id, b_gp_community_list)
+

Update a specific BGP community list from a Logical Router

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.BGPCommunityList

+
Returns:

com.vmware.nsx.model.BGPCommunityList

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.logical_routers.routing.bgp_client.Neighbors(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+UNSETPASSWORD_ACTION_PASSWORD = 'clear_password'
+

Possible value for action of method Neighbors.unsetpassword().

+
+ +
+
+create(logical_router_id, bgp_neighbor)
+

Add a new BGP Neighbor on a Logical Router

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.BgpNeighbor

+
Returns:

com.vmware.nsx.model.BgpNeighbor

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+delete(logical_router_id, id)
+

Delete a specific BGP Neighbor on a Logical Router

+ +++ + + + + + + + + + + + + + +
Parameters:
    +
  • logical_router_id (str) – (required)
    • +
  • id (str) – (required)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get(logical_router_id, id)
+

Read a specific BGP Neighbor on a Logical Router

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • logical_router_id (str) – (required)
    • +
  • id (str) – (required)
    • +
+
Return type:

com.vmware.nsx.model_client.BgpNeighbor

+
Returns:

com.vmware.nsx.model.BgpNeighbor

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+list(logical_router_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Paginated list of BGP Neighbors on a Logical Router

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • logical_router_id (str) – (required)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.BgpNeighborListResult

+
Returns:

com.vmware.nsx.model.BgpNeighborListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+showsensitivedata(logical_router_id, id)
+

Read a specific BGP Neighbor details with password on a Logical Router

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • logical_router_id (str) – (required)
    • +
  • id (str) – (required)
    • +
+
Return type:

com.vmware.nsx.model_client.BgpNeighbor

+
Returns:

com.vmware.nsx.model.BgpNeighbor

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+unsetpassword(logical_router_id, id, action=None)
+

Unset/Delete the password property on the specific BGP Neighbor. No +other property of the BgpNeighbor can be updated using this API

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • logical_router_id (str) – (required)
    • +
  • id (str) – (required)
    • +
  • action (str or None) – (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.BgpNeighbor

+
Returns:

com.vmware.nsx.model.BgpNeighbor

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(logical_router_id, id, bgp_neighbor)
+

Update a specific BGP Neighbor on a Logical Router

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.BgpNeighbor

+
Returns:

com.vmware.nsx.model.BgpNeighbor

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.logical_routers.routing.bgp_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+

com.vmware.nsx.logical_routers.routing.redistribution_client module

+
+
+class com.vmware.nsx.logical_routers.routing.redistribution_client.Rules(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(logical_router_id)
+

Returns all the route redistribution rules for the specified logical +router.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:logical_router_id (str) – (required)
Return type:com.vmware.nsx.model_client.RedistributionRuleList
Returns:com.vmware.nsx.model.RedistributionRuleList
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+update(logical_router_id, redistribution_rule_list)
+

Modifies all route redistribution rules for the specified TIER0 logical +router. Set the rules list to empty to delete/clear all rules.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.RedistributionRuleList

+
Returns:

com.vmware.nsx.model.RedistributionRuleList

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.logical_routers.routing.redistribution_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+

com.vmware.nsx.logical_routers.routing.static_routes_client module

+
+
+class com.vmware.nsx.logical_routers.routing.static_routes_client.BfdPeers(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(logical_router_id, static_hop_bfd_peer)
+

Creates a BFD peer for static route. The required parameters includes +peer IP address.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.StaticHopBfdPeer

+
Returns:

com.vmware.nsx.model.StaticHopBfdPeer

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+delete(logical_router_id, bfd_peer_id, force=None)
+

Deletes the specified BFD peer present on specified logical router.

+ +++ + + + + + + + + + + + + + +
Parameters:
    +
  • logical_router_id (str) – (required)
    • +
  • bfd_peer_id (str) – (required)
    • +
  • force (bool or None) – Force delete the resource even if it is being used somewhere +(optional, default to false)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get(logical_router_id, bfd_peer_id)
+

Read the BFD peer having specified ID.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • logical_router_id (str) – (required)
    • +
  • bfd_peer_id (str) – (required)
    • +
+
Return type:

com.vmware.nsx.model_client.StaticHopBfdPeer

+
Returns:

com.vmware.nsx.model.StaticHopBfdPeer

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+list(logical_router_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Returns information about all BFD peers created on specified logical +router for static routes.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • logical_router_id (str) – (required)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.StaticHopBfdPeerListResult

+
Returns:

com.vmware.nsx.model.StaticHopBfdPeerListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(logical_router_id, bfd_peer_id, static_hop_bfd_peer)
+

Modifies the static route BFD peer. Modifiable parameters includes peer +IP, enable flag and configuration of the BFD peer.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.StaticHopBfdPeer

+
Returns:

com.vmware.nsx.model.StaticHopBfdPeer

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.logical_routers.routing.static_routes_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/com.vmware.nsx.migration.html b/nsx/nsx/com.vmware.nsx.migration.html new file mode 100644 index 00000000..090a8679 --- /dev/null +++ b/nsx/nsx/com.vmware.nsx.migration.html @@ -0,0 +1,727 @@ + + + + + + + + + + + com.vmware.nsx.migration package — NSX-T SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

com.vmware.nsx.migration package

+
+

Submodules

+
+
+

com.vmware.nsx.migration.bundles_client module

+
+
+class com.vmware.nsx.migration.bundles_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+class com.vmware.nsx.migration.bundles_client.UploadStatus(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(bundle_id)
+

Get uploaded migration bundle upload status

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:bundle_id (str) – (required)
Return type:com.vmware.nsx.model_client.MigrationBundleUploadStatus
Returns:com.vmware.nsx.model.MigrationBundleUploadStatus
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+

com.vmware.nsx.migration.migration_unit_groups_client module

+
+
+class com.vmware.nsx.migration.migration_unit_groups_client.AggregateInfo(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+list(component_type=None, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, summary=None, sync=None)
+

Return aggregate information of all migration unit groups

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • component_type (str or None) – Component type based on which migration unit groups to be filtered +(optional)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
  • summary (bool or None) – Flag indicating whether to return summary (optional, default to +false)
    • +
  • sync (bool or None) – Synchronize before returning migration unit groups (optional, +default to false)
    • +
+
Return type:

com.vmware.nsx.model_client.MigrationUnitGroupAggregateInfoListResult

+
Returns:

com.vmware.nsx.model.MigrationUnitGroupAggregateInfoListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.migration.migration_unit_groups_client.MigrationUnit(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+reorder(group_id, migration_unit_id, reorder_migration_request)
+

Reorder an migration unit within the migration unit group

+ +++ + + + + + + + + + + + + + +
Parameters: +
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.migration.migration_unit_groups_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+list(group_id, cursor=None, has_errors=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Get migration status for group

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • group_id (str) – (required)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • has_errors (bool or None) – Flag to indicate whether to return only migration units with errors +(optional, default to false)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.MigrationUnitStatusListResult

+
Returns:

com.vmware.nsx.model.MigrationUnitStatusListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.migration.migration_unit_groups_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+

com.vmware.nsx.migration.migration_units_client module

+
+
+class com.vmware.nsx.migration.migration_units_client.AggregateInfo(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+LIST_SELECTION_STATUS_ALL = 'ALL'
+

Possible value for selectionStatus of method AggregateInfo.list().

+
+ +
+
+LIST_SELECTION_STATUS_DESELECTED = 'DESELECTED'
+

Possible value for selectionStatus of method AggregateInfo.list().

+
+ +
+
+LIST_SELECTION_STATUS_SELECTED = 'SELECTED'
+

Possible value for selectionStatus of method AggregateInfo.list().

+
+ +
+
+list(component_type=None, cursor=None, group_id=None, has_errors=None, included_fields=None, metadata=None, page_size=None, selection_status=None, sort_ascending=None, sort_by=None)
+

Get migration units aggregate-info

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • component_type (str or None) – Component type based on which migration units to be filtered +(optional)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • group_id (str or None) – Identifier of group based on which migration units to be filtered +(optional)
    • +
  • has_errors (bool or None) – Flag to indicate whether to return only migration units with errors +(optional, default to false)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • metadata (str or None) – Metadata about migration unit to filter on (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • selection_status (str or None) – Flag to indicate whether to return only selected, only deselected +or both type of migration units (optional, default to ALL)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.MigrationUnitAggregateInfoListResult

+
Returns:

com.vmware.nsx.model.MigrationUnitAggregateInfoListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.migration.migration_units_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+

com.vmware.nsx.migration.plan_client module

+
+
+class com.vmware.nsx.migration.plan_client.Settings(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(component_type)
+

Get the migration plan settings for the component.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:component_type (str) – (required)
Return type:com.vmware.nsx.model_client.MigrationPlanSettings
Returns:com.vmware.nsx.model.MigrationPlanSettings
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+update(component_type, migration_plan_settings)
+

Update the migration plan settings for the component.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.MigrationPlanSettings

+
Returns:

com.vmware.nsx.model.MigrationPlanSettings

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.migration.plan_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/com.vmware.nsx.node.aaa.html b/nsx/nsx/com.vmware.nsx.node.aaa.html new file mode 100644 index 00000000..ddbbf774 --- /dev/null +++ b/nsx/nsx/com.vmware.nsx.node.aaa.html @@ -0,0 +1,346 @@ + + + + + + + + + + + com.vmware.nsx.node.aaa package — NSX-T SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

com.vmware.nsx.node.aaa package

+ +
+

Submodules

+
+
+

com.vmware.nsx.node.aaa.providers_client module

+
+
+class com.vmware.nsx.node.aaa.providers_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+class com.vmware.nsx.node.aaa.providers_client.Vidm(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Read AAA provider vIDM properties

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeAuthProviderVidmProperties
Returns:com.vmware.nsx.model.NodeAuthProviderVidmProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+update(node_auth_provider_vidm_properties)
+

Update AAA provider vIDM properties

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:node_auth_provider_vidm_properties (com.vmware.nsx.model_client.NodeAuthProviderVidmProperties) – (required)
Return type:com.vmware.nsx.model_client.NodeAuthProviderVidmProperties
Returns:com.vmware.nsx.model.NodeAuthProviderVidmProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/com.vmware.nsx.node.aaa.providers.html b/nsx/nsx/com.vmware.nsx.node.aaa.providers.html new file mode 100644 index 00000000..7dcea258 --- /dev/null +++ b/nsx/nsx/com.vmware.nsx.node.aaa.providers.html @@ -0,0 +1,303 @@ + + + + + + + + + + + com.vmware.nsx.node.aaa.providers package — NSX-T SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

com.vmware.nsx.node.aaa.providers package

+
+

Submodules

+
+
+

com.vmware.nsx.node.aaa.providers.vidm_client module

+
+
+class com.vmware.nsx.node.aaa.providers.vidm_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Read AAA provider vIDM status

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeAuthProviderVidmStatus
Returns:com.vmware.nsx.model.NodeAuthProviderVidmStatus
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node.aaa.providers.vidm_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/com.vmware.nsx.node.html b/nsx/nsx/com.vmware.nsx.node.html new file mode 100644 index 00000000..e9668191 --- /dev/null +++ b/nsx/nsx/com.vmware.nsx.node.html @@ -0,0 +1,3830 @@ + + + + + + + + + + + com.vmware.nsx.node package — NSX-T SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

com.vmware.nsx.node package

+ +
+

Submodules

+
+
+

com.vmware.nsx.node.aaa_client module

+
+
+class com.vmware.nsx.node.aaa_client.AuthPolicy(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Returns information about the currently configured authentication +policies on the node.

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.AuthenticationPolicyProperties
Returns:com.vmware.nsx.model.AuthenticationPolicyProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+update(authentication_policy_properties)
+

Update the currently configured authentication policy on the node. If +any of api_max_auth_failures, api_failed_auth_reset_period, or +api_failed_auth_lockout_period are modified, the http service is +automatically restarted.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:authentication_policy_properties (com.vmware.nsx.model_client.AuthenticationPolicyProperties) – (required)
Return type:com.vmware.nsx.model_client.AuthenticationPolicyProperties
Returns:com.vmware.nsx.model.AuthenticationPolicyProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node.aaa_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+

com.vmware.nsx.node.file_store_client module

+
+
+class com.vmware.nsx.node.file_store_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+class com.vmware.nsx.node.file_store_client.Thumbprint(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(file_name)
+

Read file thumbprint

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:file_name (str) – Name of the file for which thumbprint should be computed (required)
Return type:com.vmware.nsx.model_client.FileThumbprint
Returns:com.vmware.nsx.model.FileThumbprint
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+

com.vmware.nsx.node.hardening_policy_client module

+
+
+class com.vmware.nsx.node.hardening_policy_client.MandatoryAccessControl(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Gets the enable status for Mandatory Access Control

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.MandatoryAccessControlProperties
Returns:com.vmware.nsx.model.MandatoryAccessControlProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+update(mandatory_access_control_properties)
+

Enable or disable Mandatory Access Control

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:mandatory_access_control_properties (com.vmware.nsx.model_client.MandatoryAccessControlProperties) – (required)
Return type:com.vmware.nsx.model_client.MandatoryAccessControlProperties
Returns:com.vmware.nsx.model.MandatoryAccessControlProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node.hardening_policy_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+

com.vmware.nsx.node.network_client module

+
+
+class com.vmware.nsx.node.network_client.Interfaces(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(interface_id)
+

Returns detailed information about the specified interface. Interface +information includes MTU, broadcast and host IP addresses, link and +admin status, MAC address, network mask, and the IP configuration +method.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:interface_id (str) – ID of interface to read (required)
Return type:com.vmware.nsx.model_client.NodeNetworkInterfaceProperties
Returns:com.vmware.nsx.model.NodeNetworkInterfaceProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list()
+

Returns the number of interfaces on the NSX Manager appliance and +detailed information about each interface. Interface information +includes MTU, broadcast and host IP addresses, link and admin status, +MAC address, network mask, and the IP configuration method (static or +DHCP).

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeNetworkInterfacePropertiesListResult
Returns:com.vmware.nsx.model.NodeNetworkInterfacePropertiesListResult
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+update(interface_id, node_network_interface_properties)
+

Updates the specified interface properties. You cannot change the +properties ip_configuration, ip_addresses, or plane. NSX +Manager must have a static IP address. You must use NSX CLI to +configure a controller or an edge node.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.NodeNetworkInterfaceProperties

+
Returns:

com.vmware.nsx.model.NodeNetworkInterfaceProperties

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.node.network_client.NameServers(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Returns the list of servers that the NSX Manager node uses to look up +IP addresses associated with given domain names.

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeNameServersProperties
Returns:com.vmware.nsx.model.NodeNameServersProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+update(node_name_servers_properties)
+

Modifies the list of servers that the NSX Manager node uses to look up +IP addresses associated with given domain names. If DHCP is configured, +this method returns a 409 CONFLICT error, because DHCP manages the list +of name servers.

+ +++ + + + + + + + + + + + + + + + + + + + +
Parameters:node_name_servers_properties (com.vmware.nsx.model_client.NodeNameServersProperties) – (required)
Return type:com.vmware.nsx.model_client.NodeNameServersProperties
Returns:com.vmware.nsx.model.NodeNameServersProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.ConcurrentChange +Conflict
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node.network_client.Routes(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(node_route_properties)
+

Add a route to the NSX Manager routing table. For static routes, the +route_type, interface_id, netmask, and destination are required +parameters. For default routes, the route_type, gateway address, and +interface_id are required. For blackhole routes, the route_type and +destination are required. All other parameters are optional. When you +add a static route, the scope and route_id are created automatically. +When you add a default or blackhole route, the route_id is created +automatically. The route_id is read-only, meaning that it cannot be +modified. All other properties can be modified by deleting and readding +the route.

+ +++ + + + + + + + + + + + + + + + + + + + +
Parameters:node_route_properties (com.vmware.nsx.model_client.NodeRouteProperties) – (required)
Return type:com.vmware.nsx.model_client.NodeRouteProperties
Returns:com.vmware.nsx.model.NodeRouteProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.ConcurrentChange +Conflict
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(route_id)
+

Delete a route from the NSX Manager routing table. You can modify an +existing route by deleting it and then posting the modified version of +the route. To verify, remove the route ID from the URI, issue a GET +request, and note the absense of the deleted route.

+ +++ + + + + + + + + + + + + + +
Parameters:route_id (str) – ID of route to delete (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(route_id)
+

Returns detailed information about a specified route in the NSX Manager +routing table.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:route_id (str) – ID of route to read (required)
Return type:com.vmware.nsx.model_client.NodeRouteProperties
Returns:com.vmware.nsx.model.NodeRouteProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list()
+

Returns detailed information about each route in the NSX Manager +routing table. Route information includes the route type (default, +static, and so on), a unique route identifier, the route metric, the +protocol from which the route was learned, the route source (which is +the preferred egress interface), the route destination, and the route +scope. The route scope refers to the distance to the destination +network: The "host" scope leads to a destination address on the +NSX Manager, such as a loopback address; the "link" scope leads +to a destination on the local network; and the "global" scope +leads to addresses that are more than one hop away.

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeRoutePropertiesListResult
Returns:com.vmware.nsx.model.NodeRoutePropertiesListResult
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node.network_client.SearchDomains(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Returns the domain list that the NSX Manager node uses to complete +unqualified host names. When a host name does not include a fully +qualified domain name (FQDN), the NSX Management node appends the +first-listed domain name to the host name before the host name is +looked up. The NSX Management node continues this for each entry in the +domain list until it finds a match.

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeSearchDomainsProperties
Returns:com.vmware.nsx.model.NodeSearchDomainsProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+update(node_search_domains_properties)
+

Modifies the list of domain names that the NSX Manager node uses to +complete unqualified host names. If DHCP is configured, this method +returns a 409 CONFLICT error, because DHCP manages the list of name +servers.

+ +++ + + + + + + + + + + + + + + + + + + + +
Parameters:node_search_domains_properties (com.vmware.nsx.model_client.NodeSearchDomainsProperties) – (required)
Return type:com.vmware.nsx.model_client.NodeSearchDomainsProperties
Returns:com.vmware.nsx.model.NodeSearchDomainsProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.ConcurrentChange +Conflict
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node.network_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+

com.vmware.nsx.node.services_client module

+
+
+class com.vmware.nsx.node.services_client.ClusterManager(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Read cluster boot manager service properties

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceProperties
Returns:com.vmware.nsx.model.NodeServiceProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+restart()
+

Restart, start or stop the cluster boot manager service

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+start()
+

Restart, start or stop the cluster boot manager service

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+stop()
+

Restart, start or stop the cluster boot manager service

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node.services_client.CmInventory(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Read cm inventory service properties

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceProperties
Returns:com.vmware.nsx.model.NodeServiceProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+restart()
+

Restart, start or stop the manager service

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+start()
+

Restart, start or stop the manager service

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+stop()
+

Restart, start or stop the manager service

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node.services_client.Http(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+applycertificate(certificate_id)
+

Applies a security certificate to the http service. In the POST +request, the CERTIFICATE_ID references a certificate created with the +/api/v1/trust-management APIs. Issuing this request causes the http +service to restart so that the service can begin using the new +certificate. When the POST request succeeds, it doesn’t return a valid +response. The request times out because of the restart.

+ +++ + + + + + + + + + + + + + +
Parameters:certificate_id (str) – Certificate ID (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get()
+

Read http service properties

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeHttpServiceProperties
Returns:com.vmware.nsx.model.NodeHttpServiceProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+restart()
+

Restart the http service

+ +++ + + + + + + + + + + + +
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+start()
+

Start the http service

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+stop()
+

Stop the http service

+ +++ + + + + + + + + + + + +
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+update(node_http_service_properties)
+

Update http service properties

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:node_http_service_properties (com.vmware.nsx.model_client.NodeHttpServiceProperties) – (required)
Return type:com.vmware.nsx.model_client.NodeHttpServiceProperties
Returns:com.vmware.nsx.model.NodeHttpServiceProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node.services_client.InstallUpgrade(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Read NSX install-upgrade service properties

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeInstallUpgradeServiceProperties
Returns:com.vmware.nsx.model.NodeInstallUpgradeServiceProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+restart()
+

Restart, start or stop the NSX install-upgrade service

+ +++ + + + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.ConcurrentChange +Conflict
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+start()
+

Restart, start or stop the NSX install-upgrade service

+ +++ + + + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.ConcurrentChange +Conflict
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+stop()
+

Restart, start or stop the NSX install-upgrade service

+ +++ + + + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.ConcurrentChange +Conflict
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+update(node_install_upgrade_service_properties)
+

Update NSX install-upgrade service properties

+ +++ + + + + + + + + + + + + + + + + + + + +
Parameters:node_install_upgrade_service_properties (com.vmware.nsx.model_client.NodeInstallUpgradeServiceProperties) – (required)
Return type:com.vmware.nsx.model_client.NodeInstallUpgradeServiceProperties
Returns:com.vmware.nsx.model.NodeInstallUpgradeServiceProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.ConcurrentChange +Conflict
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node.services_client.Liagent(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Read liagent service properties

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceProperties
Returns:com.vmware.nsx.model.NodeServiceProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+restart()
+

Restart, start or stop the liagent service

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+start()
+

Restart, start or stop the liagent service

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+stop()
+

Restart, start or stop the liagent service

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node.services_client.Manager(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Read service properties

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeProtonServiceProperties
Returns:com.vmware.nsx.model.NodeProtonServiceProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+resetmanagerlogginglevels()
+

Reset the logging levels to default values

+ +++ + + + + + + + + + + + +
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+restart()
+

Restart, start or stop the service

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+start()
+

Restart, start or stop the service

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+stop()
+

Restart, start or stop the service

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+update(node_proton_service_properties)
+

Update service properties

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:node_proton_service_properties (com.vmware.nsx.model_client.NodeProtonServiceProperties) – (required)
Return type:com.vmware.nsx.model_client.NodeProtonServiceProperties
Returns:com.vmware.nsx.model.NodeProtonServiceProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node.services_client.MgmtPlaneBus(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Read Rabbit MQ service properties

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceProperties
Returns:com.vmware.nsx.model.NodeServiceProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+restart()
+

Restart, start or stop the Rabbit MQ service

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+start()
+

Restart, start or stop the Rabbit MQ service

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+stop()
+

Restart, start or stop the Rabbit MQ service

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node.services_client.NodeMgmt(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Read appliance management service properties

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceProperties
Returns:com.vmware.nsx.model.NodeServiceProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+restart()
+

Restart the node management service

+ +++ + + + + + + + + + + + +
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node.services_client.NsxMessageBus(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Read NSX Message Bus service properties

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceProperties
Returns:com.vmware.nsx.model.NodeServiceProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+restart()
+

Restart, start or stop the NSX Message Bus service

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+start()
+

Restart, start or stop the NSX Message Bus service

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+stop()
+

Restart, start or stop the NSX Message Bus service

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node.services_client.NsxUpgradeAgent(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Read NSX upgrade Agent service properties

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceProperties
Returns:com.vmware.nsx.model.NodeServiceProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+restart()
+

Restart, start or stop the NSX upgrade agent service

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+start()
+

Restart, start or stop the NSX upgrade agent service

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+stop()
+

Restart, start or stop the NSX upgrade agent service

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node.services_client.Ntp(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Read NTP service properties

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeNtpServiceProperties
Returns:com.vmware.nsx.model.NodeNtpServiceProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+restart()
+

Restart, start or stop the NTP service

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+start()
+

Restart, start or stop the NTP service

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+stop()
+

Restart, start or stop the NTP service

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+update(node_ntp_service_properties)
+

Update NTP service properties

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:node_ntp_service_properties (com.vmware.nsx.model_client.NodeNtpServiceProperties) – (required)
Return type:com.vmware.nsx.model_client.NodeNtpServiceProperties
Returns:com.vmware.nsx.model.NodeNtpServiceProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node.services_client.Search(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Read NSX Search service properties

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceProperties
Returns:com.vmware.nsx.model.NodeServiceProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+restart()
+

Restart, start or stop the NSX Search service

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+start()
+

Restart, start or stop the NSX Search service

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+stop()
+

Restart, start or stop the NSX Search service

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node.services_client.Snmp(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Read SNMP service properties

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeSnmpServiceProperties
Returns:com.vmware.nsx.model.NodeSnmpServiceProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+restart()
+

Restart, start or stop the SNMP service

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+start()
+

Restart, start or stop the SNMP service

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+stop()
+

Restart, start or stop the SNMP service

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+update(node_snmp_service_properties)
+

Update SNMP service properties

+ +++ + + + + + + + + + + + + + + + + + + + +
Parameters:node_snmp_service_properties (com.vmware.nsx.model_client.NodeSnmpServiceProperties) – (required)
Return type:com.vmware.nsx.model_client.NodeSnmpServiceProperties
Returns:com.vmware.nsx.model.NodeSnmpServiceProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.ConcurrentChange +Conflict
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node.services_client.Ssh(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Read ssh service properties

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeSshServiceProperties
Returns:com.vmware.nsx.model.NodeSshServiceProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+removehostfingerprint(known_host_parameter)
+

Remove a host’s fingerprint from known hosts file

+ +++ + + + + + + + + + + + + + +
Parameters:known_host_parameter (com.vmware.nsx.model_client.KnownHostParameter) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+restart()
+

Restart, start or stop the ssh service

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+start()
+

Restart, start or stop the ssh service

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+stop()
+

Restart, start or stop the ssh service

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+update(node_ssh_service_properties)
+

Update ssh service properties

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:node_ssh_service_properties (com.vmware.nsx.model_client.NodeSshServiceProperties) – (required)
Return type:com.vmware.nsx.model_client.NodeSshServiceProperties
Returns:com.vmware.nsx.model.NodeSshServiceProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node.services_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+class com.vmware.nsx.node.services_client.Syslog(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Read syslog service properties

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceProperties
Returns:com.vmware.nsx.model.NodeServiceProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+restart()
+

Restart, start or stop the syslog service

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+start()
+

Restart, start or stop the syslog service

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+stop()
+

Restart, start or stop the syslog service

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node.services_client.Telemetry(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Read Telemetry service properties

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceProperties
Returns:com.vmware.nsx.model.NodeServiceProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+restart()
+

Restart, start or stop Telemetry service

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+start()
+

Restart, start or stop Telemetry service

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+stop()
+

Restart, start or stop Telemetry service

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node.services_client.UiService(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Read ui service properties

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceProperties
Returns:com.vmware.nsx.model.NodeServiceProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+restart()
+

Restart, Start and Stop the ui service

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+start()
+

Restart, Start and Stop the ui service

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+stop()
+

Restart, Start and Stop the ui service

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+

com.vmware.nsx.node.tasks_client module

+
+
+class com.vmware.nsx.node.tasks_client.Response(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(task_id)
+

Read asynchronous task response

+ +++ + + + + + + + + + + + + + + + +
Parameters:task_id (str) – ID of task to read (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error, Bad Gateway
Raise:com.vmware.vapi.std.errors_client.ConcurrentChange +Conflict
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found, Gone
+
+ +
+ +
+
+class com.vmware.nsx.node.tasks_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+

com.vmware.nsx.node.users_client module

+
+
+class com.vmware.nsx.node.users_client.SshKeys(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+addsshkey(userid, ssh_key_properties)
+

Add SSH public key to authorized_keys file for node user

+ +++ + + + + + + + + + + + + + +
Parameters: +
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+list(userid)
+

Returns a list of all SSH keys from authorized_keys file for node user

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:userid (str) – User id of the user (required)
Return type:com.vmware.nsx.model_client.SshKeyPropertiesListResult
Returns:com.vmware.nsx.model.SshKeyPropertiesListResult
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+removesshkey(userid, ssh_key_base_properties)
+

Remove SSH public key from authorized_keys file for node user

+ +++ + + + + + + + + + + + + + +
Parameters: +
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.node.users_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/com.vmware.nsx.node.network.html b/nsx/nsx/com.vmware.nsx.node.network.html new file mode 100644 index 00000000..9c1dc60a --- /dev/null +++ b/nsx/nsx/com.vmware.nsx.node.network.html @@ -0,0 +1,306 @@ + + + + + + + + + + + com.vmware.nsx.node.network package — NSX-T SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

com.vmware.nsx.node.network package

+
+

Submodules

+
+
+

com.vmware.nsx.node.network.interfaces_client module

+
+
+class com.vmware.nsx.node.network.interfaces_client.Stats(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(interface_id)
+

On the specified interface, returns the number of received (rx), +transmitted (tx), and dropped packets; the number of bytes and errors +received and transmitted on the interface; and the number of detected +collisions.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:interface_id (str) – ID of interface to read (required)
Return type:com.vmware.nsx.model_client.NodeInterfaceStatisticsProperties
Returns:com.vmware.nsx.model.NodeInterfaceStatisticsProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node.network.interfaces_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/com.vmware.nsx.node.services.html b/nsx/nsx/com.vmware.nsx.node.services.html new file mode 100644 index 00000000..23150415 --- /dev/null +++ b/nsx/nsx/com.vmware.nsx.node.services.html @@ -0,0 +1,1461 @@ + + + + + + + + + + + com.vmware.nsx.node.services package — NSX-T SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

com.vmware.nsx.node.services package

+
+

Submodules

+
+
+

com.vmware.nsx.node.services.cluster_manager_client module

+
+
+class com.vmware.nsx.node.services.cluster_manager_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Read cluster boot manager service status

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node.services.cluster_manager_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+

com.vmware.nsx.node.services.cm_inventory_client module

+
+
+class com.vmware.nsx.node.services.cm_inventory_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Read manager service status

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node.services.cm_inventory_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+

com.vmware.nsx.node.services.http_client module

+
+
+class com.vmware.nsx.node.services.http_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Read http service status

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node.services.http_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+

com.vmware.nsx.node.services.install_upgrade_client module

+
+
+class com.vmware.nsx.node.services.install_upgrade_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Read NSX install-upgrade service status

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node.services.install_upgrade_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+

com.vmware.nsx.node.services.liagent_client module

+
+
+class com.vmware.nsx.node.services.liagent_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Read liagent service status

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node.services.liagent_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+

com.vmware.nsx.node.services.manager_client module

+
+
+class com.vmware.nsx.node.services.manager_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Read service status

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node.services.manager_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+

com.vmware.nsx.node.services.mgmt_plane_bus_client module

+
+
+class com.vmware.nsx.node.services.mgmt_plane_bus_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Read Rabbit MQ service status

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node.services.mgmt_plane_bus_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+

com.vmware.nsx.node.services.node_mgmt_client module

+
+
+class com.vmware.nsx.node.services.node_mgmt_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Read appliance management service status

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node.services.node_mgmt_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+

com.vmware.nsx.node.services.nsx_message_bus_client module

+
+
+class com.vmware.nsx.node.services.nsx_message_bus_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Read NSX Message Bus service status

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node.services.nsx_message_bus_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+

com.vmware.nsx.node.services.nsx_upgrade_agent_client module

+
+
+class com.vmware.nsx.node.services.nsx_upgrade_agent_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Read Nsx upgrade agent service status

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node.services.nsx_upgrade_agent_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+

com.vmware.nsx.node.services.ntp_client module

+
+
+class com.vmware.nsx.node.services.ntp_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Read NTP service status

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node.services.ntp_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+

com.vmware.nsx.node.services.search_client module

+
+
+class com.vmware.nsx.node.services.search_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Read NSX Search service status

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node.services.search_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+

com.vmware.nsx.node.services.snmp_client module

+
+
+class com.vmware.nsx.node.services.snmp_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Read SNMP service status

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node.services.snmp_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+

com.vmware.nsx.node.services.ssh_client module

+
+
+class com.vmware.nsx.node.services.ssh_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Read ssh service status

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node.services.ssh_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+

com.vmware.nsx.node.services.syslog_client module

+
+
+class com.vmware.nsx.node.services.syslog_client.Exporters(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(node_syslog_exporter_properties)
+

Adds a rule for exporting syslog information to a specified server. The +required parameters are the rule name (exporter_name); severity level +(emerg, alert, crit, and so on); transmission protocol (TCP or UDP); +and server IP address or hostname. The optional parameters are the +syslog port number, which can be 1 through 65,535 (514, by default); +facility level to use when logging messages to syslog (kern, user, +mail, and so on); and message IDs (msgids), which identify the types of +messages to export.

+ +++ + + + + + + + + + + + + + + + + + + + +
Parameters:node_syslog_exporter_properties (com.vmware.nsx.model_client.NodeSyslogExporterProperties) – (required)
Return type:com.vmware.nsx.model_client.NodeSyslogExporterProperties
Returns:com.vmware.nsx.model.NodeSyslogExporterProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.ConcurrentChange +Conflict
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(exporter_name)
+

Removes a specified rule from the collection of syslog exporter rules.

+ +++ + + + + + + + + + + + + + +
Parameters:exporter_name (str) – Name of syslog exporter to delete (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(exporter_name)
+

Returns information about a specific syslog collection point.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:exporter_name (str) – Name of syslog exporter (required)
Return type:com.vmware.nsx.model_client.NodeSyslogExporterProperties
Returns:com.vmware.nsx.model.NodeSyslogExporterProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list()
+

Returns the collection of registered syslog exporter rules, if any. The +rules specify the collector IP address and port, and the protocol to +use.

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeSyslogExporterPropertiesListResult
Returns:com.vmware.nsx.model.NodeSyslogExporterPropertiesListResult
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node.services.syslog_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Read syslog service status

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node.services.syslog_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+

com.vmware.nsx.node.services.telemetry_client module

+
+
+class com.vmware.nsx.node.services.telemetry_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Read Telemetry service status

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node.services.telemetry_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+

com.vmware.nsx.node.services.ui_service_client module

+
+
+class com.vmware.nsx.node.services.ui_service_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Read ui service status

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.NodeServiceStatusProperties
Returns:com.vmware.nsx.model.NodeServiceStatusProperties
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.node.services.ui_service_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/com.vmware.nsx.pools.html b/nsx/nsx/com.vmware.nsx.pools.html new file mode 100644 index 00000000..df3bca5d --- /dev/null +++ b/nsx/nsx/com.vmware.nsx.pools.html @@ -0,0 +1,302 @@ + + + + + + + + + + + com.vmware.nsx.pools package — NSX-T SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

com.vmware.nsx.pools package

+
+

Submodules

+
+
+

com.vmware.nsx.pools.ip_pools_client module

+
+
+class com.vmware.nsx.pools.ip_pools_client.Allocations(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+list(pool_id)
+

Returns information about which addresses have been allocated from a +specified IP address pool.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:pool_id (str) – IP pool ID (required)
Return type:com.vmware.nsx.model_client.AllocationIpAddressListResult
Returns:com.vmware.nsx.model.AllocationIpAddressListResult
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.pools.ip_pools_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/com.vmware.nsx.serviceinsertion.html b/nsx/nsx/com.vmware.nsx.serviceinsertion.html new file mode 100644 index 00000000..95c2e143 --- /dev/null +++ b/nsx/nsx/com.vmware.nsx.serviceinsertion.html @@ -0,0 +1,962 @@ + + + + + + + + + + + com.vmware.nsx.serviceinsertion package — NSX-T SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

com.vmware.nsx.serviceinsertion package

+ +
+

Submodules

+
+
+

com.vmware.nsx.serviceinsertion.sections_client module

+
+
+class com.vmware.nsx.serviceinsertion.sections_client.Rules(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+CREATEMULTIPLE_OPERATION_AFTER = 'insert_after'
+

Possible value for operation of method Rules.createmultiple().

+
+ +
+
+CREATEMULTIPLE_OPERATION_BEFORE = 'insert_before'
+

Possible value for operation of method Rules.createmultiple().

+
+ +
+
+CREATEMULTIPLE_OPERATION_BOTTOM = 'insert_bottom'
+

Possible value for operation of method Rules.createmultiple().

+
+ +
+
+CREATEMULTIPLE_OPERATION_TOP = 'insert_top'
+

Possible value for operation of method Rules.createmultiple().

+
+ +
+
+CREATE_OPERATION_AFTER = 'insert_after'
+

Possible value for operation of method Rules.create().

+
+ +
+
+CREATE_OPERATION_BEFORE = 'insert_before'
+

Possible value for operation of method Rules.create().

+
+ +
+
+CREATE_OPERATION_BOTTOM = 'insert_bottom'
+

Possible value for operation of method Rules.create().

+
+ +
+
+CREATE_OPERATION_TOP = 'insert_top'
+

Possible value for operation of method Rules.create().

+
+ +
+
+LIST_FILTER_TYPE_FILTER = 'FILTER'
+

Possible value for filterType of method Rules.list().

+
+ +
+ +

Possible value for filterType of method Rules.list().

+
+ +
+
+REVISE_OPERATION_AFTER = 'insert_after'
+

Possible value for operation of method Rules.revise().

+
+ +
+
+REVISE_OPERATION_BEFORE = 'insert_before'
+

Possible value for operation of method Rules.revise().

+
+ +
+
+REVISE_OPERATION_BOTTOM = 'insert_bottom'
+

Possible value for operation of method Rules.revise().

+
+ +
+
+REVISE_OPERATION_TOP = 'insert_top'
+

Possible value for operation of method Rules.revise().

+
+ +
+
+create(section_id, service_insertion_rule, id=None, operation=None)
+

Adds a new serviceinsertion rule in existing serviceinsertion section.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • section_id (str) – (required)
    • +
  • service_insertion_rule (com.vmware.nsx.model_client.ServiceInsertionRule) – (required)
    • +
  • id (str or None) – Identifier of the anchor rule or section. This is a required field +in case operation like ‘insert_before’ and ‘insert_after’. +(optional)
    • +
  • operation (str or None) – Operation (optional, default to insert_top)
    • +
+
Return type:

com.vmware.nsx.model_client.ServiceInsertionRule

+
Returns:

com.vmware.nsx.model.ServiceInsertionRule

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+createmultiple(section_id, service_insertion_rule_list, id=None, operation=None)
+

Create multiple serviceinsertion rules in existing serviceinsertion +section bounded by limit of 1000 serviceinsertion rules per section.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • section_id (str) – (required)
    • +
  • service_insertion_rule_list (com.vmware.nsx.model_client.ServiceInsertionRuleList) – (required)
    • +
  • id (str or None) – Identifier of the anchor rule or section. This is a required field +in case operation like ‘insert_before’ and ‘insert_after’. +(optional)
    • +
  • operation (str or None) – Operation (optional, default to insert_top)
    • +
+
Return type:

com.vmware.nsx.model_client.ServiceInsertionRuleList

+
Returns:

com.vmware.nsx.model.ServiceInsertionRuleList

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+delete(section_id, rule_id)
+

Delete existing serviceinsertion rule in a serviceinsertion section.

+ +++ + + + + + + + + + + + + + +
Parameters:
    +
  • section_id (str) – (required)
    • +
  • rule_id (str) – (required)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get(section_id, rule_id)
+

Return existing serviceinsertion rule information in a serviceinsertion +section.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • section_id (str) – (required)
    • +
  • rule_id (str) – (required)
    • +
+
Return type:

com.vmware.nsx.model_client.ServiceInsertionRule

+
Returns:

com.vmware.nsx.model.ServiceInsertionRule

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+list(section_id, applied_tos=None, cursor=None, destinations=None, filter_type=None, included_fields=None, page_size=None, services=None, sort_ascending=None, sort_by=None, sources=None)
+

Return all serviceinsertion rule(s) information for a given +serviceinsertion section.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • section_id (str) – (required)
    • +
  • applied_tos (str or None) – AppliedTo’s referenced by this section or section’s Distributed +Service Rules . (optional)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • destinations (str or None) – Destinations referenced by this section’s Distributed Service Rules +. (optional)
    • +
  • filter_type (str or None) – Filter type (optional, default to FILTER)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • services (str or None) – NSService referenced by this section’s Distributed Service Rules . +(optional)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
  • sources (str or None) – Sources referenced by this section’s Distributed Service Rules . +(optional)
    • +
+
Return type:

com.vmware.nsx.model_client.ServiceInsertionRuleListResult

+
Returns:

com.vmware.nsx.model.ServiceInsertionRuleListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+revise(section_id, rule_id, service_insertion_rule, id=None, operation=None)
+

Modifies existing serviceinsertion rule along with relative position +among other serviceinsertion rules inside a serviceinsertion section.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • section_id (str) – (required)
    • +
  • rule_id (str) – (required)
    • +
  • service_insertion_rule (com.vmware.nsx.model_client.ServiceInsertionRule) – (required)
    • +
  • id (str or None) – Identifier of the anchor rule or section. This is a required field +in case operation like ‘insert_before’ and ‘insert_after’. +(optional)
    • +
  • operation (str or None) – Operation (optional, default to insert_top)
    • +
+
Return type:

com.vmware.nsx.model_client.ServiceInsertionRule

+
Returns:

com.vmware.nsx.model.ServiceInsertionRule

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(section_id, rule_id, service_insertion_rule)
+

Modifies existing serviceinsertion rule in a serviceinsertion section.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.ServiceInsertionRule

+
Returns:

com.vmware.nsx.model.ServiceInsertionRule

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.serviceinsertion.sections_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+

com.vmware.nsx.serviceinsertion.services_client module

+
+
+class com.vmware.nsx.serviceinsertion.services_client.ServiceInstances(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(service_id, base_service_instance)
+

Adds a new Service-Instance under the specified Service.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

vmware.vapi.struct.VapiStruct

+
Returns:

com.vmware.nsx.model.BaseServiceInstance +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.BaseServiceInstance.

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+delete(service_id, service_instance_id)
+

Delete existing Service-Instance for a given Service-Insertion Service.

+ +++ + + + + + + + + + + + + + +
Parameters:
    +
  • service_id (str) – (required)
    • +
  • service_instance_id (str) – (required)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get(service_id, service_instance_id)
+

Returns Service-Instance information for a given Service-Insertion +Service.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • service_id (str) – (required)
    • +
  • service_instance_id (str) – (required)
    • +
+
Return type:

vmware.vapi.struct.VapiStruct

+
Returns:

com.vmware.nsx.model.BaseServiceInstance +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.BaseServiceInstance.

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+list(service_id)
+

Returns all Service-Instance(s) for a given Service-Insertion Service.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:service_id (str) – (required)
Return type:com.vmware.nsx.model_client.ServiceInstanceListResult
Returns:com.vmware.nsx.model.ServiceInstanceListResult
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+update(service_id, service_instance_id, base_service_instance)
+

Modifies an existing Service-Instance for a given Service-Insertion +Service.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • service_id (str) – (required)
    • +
  • service_instance_id (str) – (required)
    • +
  • base_service_instance (vmware.vapi.struct.VapiStruct) – (required) +The parameter must contain all the attributes defined in +com.vmware.nsx.model_client.BaseServiceInstance.
    • +
+
Return type:

vmware.vapi.struct.VapiStruct

+
Returns:

com.vmware.nsx.model.BaseServiceInstance +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.BaseServiceInstance.

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.serviceinsertion.services_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/com.vmware.nsx.serviceinsertion.services.html b/nsx/nsx/com.vmware.nsx.serviceinsertion.services.html new file mode 100644 index 00000000..0758c551 --- /dev/null +++ b/nsx/nsx/com.vmware.nsx.serviceinsertion.services.html @@ -0,0 +1,645 @@ + + + + + + + + + + + com.vmware.nsx.serviceinsertion.services package — NSX-T SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

com.vmware.nsx.serviceinsertion.services package

+ +
+

Submodules

+
+
+

com.vmware.nsx.serviceinsertion.services.service_instances_client module

+
+
+class com.vmware.nsx.serviceinsertion.services.service_instances_client.InstanceEndpoints(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(service_id, service_instance_id, instance_endpoint)
+

Adds a new instance endpoint. It belongs to one service instance and is +attached to one service attachment. It represents a redirection target +for a Rule.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.InstanceEndpoint

+
Returns:

com.vmware.nsx.model.InstanceEndpoint

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+delete(service_id, service_instance_id, instance_endpoint)
+

Delete instance endpoint information for a given instace endpoint. +Please make sure to delete all the Service Insertion Rules, which refer +to this Endpoint as ‘redirect_tos’ target.

+ +++ + + + + + + + + + + + + + +
Parameters:
    +
  • service_id (str) – (required)
    • +
  • service_instance_id (str) – (required)
    • +
  • instance_endpoint (str) – (required)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get(service_id, service_instance_id, instance_endpoint)
+

Returns detailed Endpoint information for a given InstanceEndpoint.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • service_id (str) – (required)
    • +
  • service_instance_id (str) – (required)
    • +
  • instance_endpoint (str) – (required)
    • +
+
Return type:

com.vmware.nsx.model_client.InstanceEndpoint

+
Returns:

com.vmware.nsx.model.InstanceEndpoint

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+list(service_id, service_instance_id)
+

List all InstanceEndpoints of a service instance.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • service_id (str) – (required)
    • +
  • service_instance_id (str) – (required)
    • +
+
Return type:

com.vmware.nsx.model_client.InstanceEndpointListResult

+
Returns:

com.vmware.nsx.model.InstanceEndpointListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.serviceinsertion.services.service_instances_client.InstanceRuntimes(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+delete(service_id, service_instance_id)
+

Undeploy one service VM as standalone or two service VMs as HA. +Associated deployment information and instance runtime will also be +deleted once service VMs have been un-deployed successfully.

+ +++ + + + + + + + + + + + + + +
Parameters:
    +
  • service_id (str) – (required)
    • +
  • service_instance_id (str) – (required)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+deploy(service_id, service_instance_id)
+

Deploys one service VM as standalone, or two service VMs as HA where +one VM is active and another one is standby. During the deployment of +service VMs, service will be set up based on deployment events using +callbacks.

+ +++ + + + + + + + + + + + + + +
Parameters:
    +
  • service_id (str) – (required)
    • +
  • service_instance_id (str) – (required)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+list(service_id, service_instance_id)
+

Returns list of instance runtimes of service VMs being deployed for a +given service instance id

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • service_id (str) – (required)
    • +
  • service_instance_id (str) – (required)
    • +
+
Return type:

com.vmware.nsx.model_client.InstanceRuntimeListResult

+
Returns:

com.vmware.nsx.model.InstanceRuntimeListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+upgrade(service_id, service_instance_id)
+

Upgrade service VMs using newer version of OVF. In case of HA, the +stand-by service VM will be upgrade first. Once it has been upgraded, +it switches to be the Active one and then the other VM will be upgrade.

+ +++ + + + + + + + + + + + + + +
Parameters:
    +
  • service_id (str) – (required)
    • +
  • service_instance_id (str) – (required)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.serviceinsertion.services.service_instances_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/com.vmware.nsx.serviceinsertion.services.service_instances.html b/nsx/nsx/com.vmware.nsx.serviceinsertion.services.service_instances.html new file mode 100644 index 00000000..4799e2d1 --- /dev/null +++ b/nsx/nsx/com.vmware.nsx.serviceinsertion.services.service_instances.html @@ -0,0 +1,249 @@ + + + + + + + + + + + com.vmware.nsx.serviceinsertion.services.service_instances package — NSX-T SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+ + +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.html b/nsx/nsx/com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.html new file mode 100644 index 00000000..206fbc28 --- /dev/null +++ b/nsx/nsx/com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.html @@ -0,0 +1,408 @@ + + + + + + + + + + + com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes package — NSX-T SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes package

+
+

Submodules

+
+
+

com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.interfaces_client module

+
+
+class com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.interfaces_client.Statistics(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+GET_SOURCE_CACHED = 'cached'
+

Possible value for source of method Statistics.get().

+
+ +
+
+GET_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Statistics.get().

+
+ +
+
+get(service_id, service_instance_id, instance_runtime_id, interface_index, source=None)
+

Returns statistics of a specified interface via associated logical +port. If the logical port is attached to a logical router port, query +parameter "source=realtime" is not supported.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • service_id (str) – (required)
    • +
  • service_instance_id (str) – (required)
    • +
  • instance_runtime_id (str) – (required)
    • +
  • interface_index (str) – (required)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.RuntimeInterfaceStatistics

+
Returns:

com.vmware.nsx.model.RuntimeInterfaceStatistics

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.interfaces_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+GET_SOURCE_CACHED = 'cached'
+

Possible value for source of method Status.get().

+
+ +
+
+GET_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Status.get().

+
+ +
+
+get(service_id, service_instance_id, instance_runtime_id, interface_index, source=None)
+

Returns operational status of a specified interface

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • service_id (str) – (required)
    • +
  • service_instance_id (str) – (required)
    • +
  • instance_runtime_id (str) – (required)
    • +
  • interface_index (str) – (required)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.RuntimeInterfaceOperationalStatus

+
Returns:

com.vmware.nsx.model.RuntimeInterfaceOperationalStatus

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.interfaces_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/com.vmware.nsx.transport_nodes.html b/nsx/nsx/com.vmware.nsx.transport_nodes.html new file mode 100644 index 00000000..c4a3dc07 --- /dev/null +++ b/nsx/nsx/com.vmware.nsx.transport_nodes.html @@ -0,0 +1,327 @@ + + + + + + + + + + + com.vmware.nsx.transport_nodes package — NSX-T SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

com.vmware.nsx.transport_nodes package

+
+

Submodules

+
+
+

com.vmware.nsx.transport_nodes.statistics_client module

+
+
+class com.vmware.nsx.transport_nodes.statistics_client.NatRules(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+GET_SOURCE_CACHED = 'cached'
+

Possible value for source of method NatRules.get().

+
+ +
+
+GET_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method NatRules.get().

+
+ +
+
+get(node_id, source=None)
+

Returns the summation of statistics for all rules from all logical +routers which are present on given transport node. Only cached +statistics are supported. The query parameter "source=realtime" +is not supported.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • node_id (str) – (required)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.NatStatisticsPerTransportNode

+
Returns:

com.vmware.nsx.model.NatStatisticsPerTransportNode

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.transport_nodes.statistics_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/com.vmware.nsx.upgrade.html b/nsx/nsx/com.vmware.nsx.upgrade.html new file mode 100644 index 00000000..5bc7711e --- /dev/null +++ b/nsx/nsx/com.vmware.nsx.upgrade.html @@ -0,0 +1,897 @@ + + + + + + + + + + + com.vmware.nsx.upgrade package — NSX-T SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

com.vmware.nsx.upgrade package

+
+

Submodules

+
+
+

com.vmware.nsx.upgrade.bundles_client module

+
+
+class com.vmware.nsx.upgrade.bundles_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+class com.vmware.nsx.upgrade.bundles_client.UploadStatus(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(bundle_id)
+

Get uploaded upgrade bundle upload status

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:bundle_id (str) – (required)
Return type:com.vmware.nsx.model_client.UpgradeBundleUploadStatus
Returns:com.vmware.nsx.model.UpgradeBundleUploadStatus
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+

com.vmware.nsx.upgrade.eula_client module

+
+
+class com.vmware.nsx.upgrade.eula_client.Accept(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create()
+

Accept end user license agreement

+ +++ + + + + + + + + + + + +
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.upgrade.eula_client.Acceptance(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get()
+

Return the acceptance status of end user license agreement

+ +++ + + + + + + + + + + + + + + + +
Return type:com.vmware.nsx.model_client.EULAAcceptance
Returns:com.vmware.nsx.model.EULAAcceptance
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.upgrade.eula_client.Content(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(cursor=None, format=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Return the content of end user license agreement in the specified +format. By default, it’s pure string without line break

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • format (str or None) – End User License Agreement content output format (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.EULAContent

+
Returns:

com.vmware.nsx.model.EULAContent

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.upgrade.eula_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+

com.vmware.nsx.upgrade.plan_client module

+
+
+class com.vmware.nsx.upgrade.plan_client.Settings(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(component_type)
+

Get the upgrade plan settings for the component.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:component_type (str) – (required)
Return type:com.vmware.nsx.model_client.UpgradePlanSettings
Returns:com.vmware.nsx.model.UpgradePlanSettings
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+update(component_type, upgrade_plan_settings)
+

Update the upgrade plan settings for the component.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.UpgradePlanSettings

+
Returns:

com.vmware.nsx.model.UpgradePlanSettings

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.upgrade.plan_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+

com.vmware.nsx.upgrade.upgrade_unit_groups_client module

+
+
+class com.vmware.nsx.upgrade.upgrade_unit_groups_client.AggregateInfo(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+list(component_type=None, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, summary=None, sync=None)
+

Return aggregate information of all upgrade unit groups

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • component_type (str or None) – Component type based on which upgrade unit groups to be filtered +(optional)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
  • summary (bool or None) – Flag indicating whether to return summary (optional, default to +false)
    • +
  • sync (bool or None) – Synchronize before returning upgrade unit groups (optional, default +to false)
    • +
+
Return type:

com.vmware.nsx.model_client.UpgradeUnitGroupAggregateInfoListResult

+
Returns:

com.vmware.nsx.model.UpgradeUnitGroupAggregateInfoListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.upgrade.upgrade_unit_groups_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+list(group_id, cursor=None, has_errors=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Get upgrade status for group

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • group_id (str) – (required)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • has_errors (bool or None) – Flag to indicate whether to return only upgrade units with errors +(optional, default to false)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.UpgradeUnitStatusListResult

+
Returns:

com.vmware.nsx.model.UpgradeUnitStatusListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.upgrade.upgrade_unit_groups_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+class com.vmware.nsx.upgrade.upgrade_unit_groups_client.UpgradeUnit(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+reorder(group_id, upgrade_unit_id, reorder_request)
+

Reorder an upgrade unit within the upgrade unit group

+ +++ + + + + + + + + + + + + + +
Parameters: +
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+

com.vmware.nsx.upgrade.upgrade_units_client module

+
+
+class com.vmware.nsx.upgrade.upgrade_units_client.AggregateInfo(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+LIST_SELECTION_STATUS_ALL = 'ALL'
+

Possible value for selectionStatus of method AggregateInfo.list().

+
+ +
+
+LIST_SELECTION_STATUS_DESELECTED = 'DESELECTED'
+

Possible value for selectionStatus of method AggregateInfo.list().

+
+ +
+
+LIST_SELECTION_STATUS_SELECTED = 'SELECTED'
+

Possible value for selectionStatus of method AggregateInfo.list().

+
+ +
+
+list(component_type=None, cursor=None, group_id=None, has_errors=None, included_fields=None, metadata=None, page_size=None, selection_status=None, sort_ascending=None, sort_by=None)
+

Get upgrade units aggregate-info

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • component_type (str or None) – Component type based on which upgrade units to be filtered +(optional)
    • +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • group_id (str or None) – Identifier of group based on which upgrade units to be filtered +(optional)
    • +
  • has_errors (bool or None) – Flag to indicate whether to return only upgrade units with errors +(optional, default to false)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • metadata (str or None) – Metadata about upgrade unit to filter on (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • selection_status (str or None) – Flag to indicate whether to return only selected, only deselected +or both type of upgrade units (optional, default to ALL)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.UpgradeUnitAggregateInfoListResult

+
Returns:

com.vmware.nsx.model.UpgradeUnitAggregateInfoListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.upgrade.upgrade_units_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/com.vmware.nsx.vpn.html b/nsx/nsx/com.vmware.nsx.vpn.html new file mode 100644 index 00000000..7eaf90c2 --- /dev/null +++ b/nsx/nsx/com.vmware.nsx.vpn.html @@ -0,0 +1,2364 @@ + + + + + + + + + + + com.vmware.nsx.vpn package — NSX-T SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

com.vmware.nsx.vpn package

+ +
+

Submodules

+
+
+

com.vmware.nsx.vpn.ipsec_client module

+
+
+class com.vmware.nsx.vpn.ipsec_client.DpdProfiles(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(ip_sec_vpndpd_profile)
+

Create dead peer detection (DPD) profile. Any change in profile affects +all sessions consuming this profile.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:ip_sec_vpndpd_profile (com.vmware.nsx.model_client.IPSecVPNDPDProfile) – (required)
Return type:com.vmware.nsx.model_client.IPSecVPNDPDProfile
Returns:com.vmware.nsx.model.IPSecVPNDPDProfile
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(ipsec_vpn_dpd_profile_id, force=None)
+

Delete dead peer detection (DPD) profile.

+ +++ + + + + + + + + + + + + + +
Parameters:
    +
  • ipsec_vpn_dpd_profile_id (str) – (required)
    • +
  • force (bool or None) – Force delete the resource even if it is being used somewhere +(optional, default to false)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get(ipsec_vpn_dpd_profile_id)
+

Get IPSec dead peer detection (DPD) profile.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:ipsec_vpn_dpd_profile_id (str) – (required)
Return type:com.vmware.nsx.model_client.IPSecVPNDPDProfile
Returns:com.vmware.nsx.model.IPSecVPNDPDProfile
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Get paginated list of all dead peer detection (DPD) profiles.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.IPSecVPNDPDProfileListResult

+
Returns:

com.vmware.nsx.model.IPSecVPNDPDProfileListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(ipsec_vpn_dpd_profile_id, ip_sec_vpndpd_profile)
+

Edit IPSec dead peer detection (DPD) profile.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.IPSecVPNDPDProfile

+
Returns:

com.vmware.nsx.model.IPSecVPNDPDProfile

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.vpn.ipsec_client.IkeProfiles(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(ip_sec_vpnike_profile)
+

Create custom internet key exchange (IKE) Profile. IKE Profile is a +reusable profile that captures IKE and phase one negotiation +parameters. System will be pre provisioned with system owned non +editable default IKE profile and suggested set of profiles that can be +used for peering with popular remote peers like AWS VPN. User can +create custom profiles as needed. Any change in profile affects all +sessions consuming this profile.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:ip_sec_vpnike_profile (com.vmware.nsx.model_client.IPSecVPNIKEProfile) – (required)
Return type:com.vmware.nsx.model_client.IPSecVPNIKEProfile
Returns:com.vmware.nsx.model.IPSecVPNIKEProfile
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(ipsec_vpn_ike_profile_id, force=None)
+

Delete custom IKE Profile. Profile can not be deleted if profile has +references to it.

+ +++ + + + + + + + + + + + + + +
Parameters:
    +
  • ipsec_vpn_ike_profile_id (str) – (required)
    • +
  • force (bool or None) – Force delete the resource even if it is being used somewhere +(optional, default to false)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get(ipsec_vpn_ike_profile_id)
+

Get custom IKE Profile, given the particular id.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:ipsec_vpn_ike_profile_id (str) – (required)
Return type:com.vmware.nsx.model_client.IPSecVPNIKEProfile
Returns:com.vmware.nsx.model.IPSecVPNIKEProfile
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Get paginated list of all IKE Profiles.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.IPSecVPNIKEProfileListResult

+
Returns:

com.vmware.nsx.model.IPSecVPNIKEProfileListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(ipsec_vpn_ike_profile_id, ip_sec_vpnike_profile)
+

Edit custom IKE Profile. System owned profiles are non editable.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.IPSecVPNIKEProfile

+
Returns:

com.vmware.nsx.model.IPSecVPNIKEProfile

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.vpn.ipsec_client.LocalEndpoints(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(ip_sec_vpn_local_endpoint)
+

Create custom IPSec local endpoint.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:ip_sec_vpn_local_endpoint (com.vmware.nsx.model_client.IPSecVPNLocalEndpoint) – (required)
Return type:com.vmware.nsx.model_client.IPSecVPNLocalEndpoint
Returns:com.vmware.nsx.model.IPSecVPNLocalEndpoint
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(ipsec_vpn_local_endpoint_id, force=None)
+

Delete custom IPSec local endpoint.

+ +++ + + + + + + + + + + + + + +
Parameters:
    +
  • ipsec_vpn_local_endpoint_id (str) – (required)
    • +
  • force (bool or None) – Force delete the resource even if it is being used somewhere +(optional, default to false)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get(ipsec_vpn_local_endpoint_id)
+

Get custom IPSec local endpoint.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:ipsec_vpn_local_endpoint_id (str) – (required)
Return type:com.vmware.nsx.model_client.IPSecVPNLocalEndpoint
Returns:com.vmware.nsx.model.IPSecVPNLocalEndpoint
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, ipsec_vpn_service_id=None, logical_router_id=None, page_size=None, sort_ascending=None, sort_by=None)
+

Get paginated list of all local endpoints.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • ipsec_vpn_service_id (str or None) – Id of the IPSec VPN service (optional)
    • +
  • logical_router_id (str or None) – Id of logical router (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.IPSecVPNLocalEndpointListResult

+
Returns:

com.vmware.nsx.model.IPSecVPNLocalEndpointListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(ipsec_vpn_local_endpoint_id, ip_sec_vpn_local_endpoint)
+

Edit custom IPSec local endpoint.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.IPSecVPNLocalEndpoint

+
Returns:

com.vmware.nsx.model.IPSecVPNLocalEndpoint

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.vpn.ipsec_client.PeerEndpoints(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(ip_sec_vpn_peer_endpoint)
+

Create custom IPSec peer endpoint.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:ip_sec_vpn_peer_endpoint (com.vmware.nsx.model_client.IPSecVPNPeerEndpoint) – (required)
Return type:com.vmware.nsx.model_client.IPSecVPNPeerEndpoint
Returns:com.vmware.nsx.model.IPSecVPNPeerEndpoint
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(ipsec_vpn_peer_endpoint_id, force=None)
+

Delete custom IPSec VPN peer endpoint. All references are strong +references and dependent peer endpoints can not be deleted if being +referenced.

+ +++ + + + + + + + + + + + + + +
Parameters:
    +
  • ipsec_vpn_peer_endpoint_id (str) – (required)
    • +
  • force (bool or None) – Force delete the resource even if it is being used somewhere +(optional, default to false)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get(ipsec_vpn_peer_endpoint_id)
+

Get custom IPSec VPN peer endpoint.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:ipsec_vpn_peer_endpoint_id (str) – (required)
Return type:com.vmware.nsx.model_client.IPSecVPNPeerEndpoint
Returns:com.vmware.nsx.model.IPSecVPNPeerEndpoint
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Get paginated list of all peer endpoint.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.IPSecVPNPeerEndpointListResult

+
Returns:

com.vmware.nsx.model.IPSecVPNPeerEndpointListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+showsensitivedata(ipsec_vpn_peer_endpoint_id)
+

Get custom IPSec VPN peer endpoint with PSK.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:ipsec_vpn_peer_endpoint_id (str) – (required)
Return type:com.vmware.nsx.model_client.IPSecVPNPeerEndpoint
Returns:com.vmware.nsx.model.IPSecVPNPeerEndpoint
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+update(ipsec_vpn_peer_endpoint_id, ip_sec_vpn_peer_endpoint)
+

Edit custom IPSec peer endpoint. System owned endpoints are non +editable.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.IPSecVPNPeerEndpoint

+
Returns:

com.vmware.nsx.model.IPSecVPNPeerEndpoint

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.vpn.ipsec_client.Services(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(ip_sec_vpn_service)
+

Create VPN service for given logical router.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:ip_sec_vpn_service (com.vmware.nsx.model_client.IPSecVPNService) – (required)
Return type:com.vmware.nsx.model_client.IPSecVPNService
Returns:com.vmware.nsx.model.IPSecVPNService
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(ipsec_vpn_service_id, force=None)
+

Delete IPSec VPN service for given router.

+ +++ + + + + + + + + + + + + + +
Parameters:
    +
  • ipsec_vpn_service_id (str) – (required)
    • +
  • force (bool or None) – Force delete the resource even if it is being used somewhere +(optional, default to false)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get(ipsec_vpn_service_id)
+

Get IPSec VPN service for given logical router.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:ipsec_vpn_service_id (str) – (required)
Return type:com.vmware.nsx.model_client.IPSecVPNService
Returns:com.vmware.nsx.model.IPSecVPNService
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Get paginated list of all IPSec VPN services.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.IPSecVPNServiceListResult

+
Returns:

com.vmware.nsx.model.IPSecVPNServiceListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(ipsec_vpn_service_id, ip_sec_vpn_service)
+

Edit IPSec VPN service for given logical router.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.IPSecVPNService

+
Returns:

com.vmware.nsx.model.IPSecVPNService

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.vpn.ipsec_client.Sessions(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+LIST_SESSION_TYPE_POLICYBASEDIPSECVPNSESSION = 'PolicyBasedIPSecVPNSession'
+

Possible value for sessionType of method Sessions.list().

+
+ +
+
+LIST_SESSION_TYPE_ROUTEBASEDIPSECVPNSESSION = 'RouteBasedIPSecVPNSession'
+

Possible value for sessionType of method Sessions.list().

+
+ +
+
+create(ip_sec_vpn_session)
+

Create new VPN session.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:ip_sec_vpn_session (vmware.vapi.struct.VapiStruct) – (required) +The parameter must contain all the attributes defined in +com.vmware.nsx.model_client.IPSecVPNSession.
Return type:vmware.vapi.struct.VapiStruct
Returns:com.vmware.nsx.model.IPSecVPNSession +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.IPSecVPNSession.
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(ipsec_vpn_session_id, force=None)
+

Delete IPSec VPN session.

+ +++ + + + + + + + + + + + + + +
Parameters:
    +
  • ipsec_vpn_session_id (str) – (required)
    • +
  • force (bool or None) – Force delete the resource even if it is being used somewhere +(optional, default to false)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get(ipsec_vpn_session_id)
+

Fetch IPSec VPN session.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:ipsec_vpn_session_id (str) – (required)
Return type:vmware.vapi.struct.VapiStruct
Returns:com.vmware.nsx.model.IPSecVPNSession +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.IPSecVPNSession.
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, ipsec_vpn_service_id=None, logical_router_id=None, page_size=None, session_type=None, sort_ascending=None, sort_by=None)
+

Get paginated list of all IPSec VPN sessions.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • ipsec_vpn_service_id (str or None) – Id of the IPSec VPN service (optional)
    • +
  • logical_router_id (str or None) – Id of logical router (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • session_type (str or None) – Resource types of IPsec VPN session (optional)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.IPSecVPNSessionListResult

+
Returns:

com.vmware.nsx.model.IPSecVPNSessionListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(ipsec_vpn_session_id, ip_sec_vpn_session)
+

Edit IPSec VPN session.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • ipsec_vpn_session_id (str) – (required)
    • +
  • ip_sec_vpn_session (vmware.vapi.struct.VapiStruct) – (required) +The parameter must contain all the attributes defined in +com.vmware.nsx.model_client.IPSecVPNSession.
    • +
+
Return type:

vmware.vapi.struct.VapiStruct

+
Returns:

com.vmware.nsx.model.IPSecVPNSession +The return value will contain all the attributes defined in +com.vmware.nsx.model_client.IPSecVPNSession.

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.vpn.ipsec_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+class com.vmware.nsx.vpn.ipsec_client.TunnelProfiles(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(ip_sec_vpn_tunnel_profile)
+

Create custom IPSec tunnel profile. IPSec tunnel profile is a reusable +profile that captures phase two negotiation parameters and tunnel +properties. System will be provisioned with system owned non editable +default IPSec tunnel profile. Any change in profile affects all +sessions consuming this profile.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:ip_sec_vpn_tunnel_profile (com.vmware.nsx.model_client.IPSecVPNTunnelProfile) – (required)
Return type:com.vmware.nsx.model_client.IPSecVPNTunnelProfile
Returns:com.vmware.nsx.model.IPSecVPNTunnelProfile
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(ipsec_vpn_tunnel_profile_id, force=None)
+

Delete custom IPSec Tunnel Profile.

+ +++ + + + + + + + + + + + + + +
Parameters:
    +
  • ipsec_vpn_tunnel_profile_id (str) – (required)
    • +
  • force (bool or None) – Force delete the resource even if it is being used somewhere +(optional, default to false)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get(ipsec_vpn_tunnel_profile_id)
+

Get custom IPSec Tunnel Profile.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:ipsec_vpn_tunnel_profile_id (str) – (required)
Return type:com.vmware.nsx.model_client.IPSecVPNTunnelProfile
Returns:com.vmware.nsx.model.IPSecVPNTunnelProfile
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Get paginated list of all IPSecTunnelProfiles.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.IPSecVPNTunnelProfileListResult

+
Returns:

com.vmware.nsx.model.IPSecVPNTunnelProfileListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(ipsec_vpn_tunnel_profile_id, ip_sec_vpn_tunnel_profile)
+

Edit custom IPSec Tunnel Profile. System owned profiles are non +editable.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.IPSecVPNTunnelProfile

+
Returns:

com.vmware.nsx.model.IPSecVPNTunnelProfile

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+

com.vmware.nsx.vpn.l2vpn_client module

+
+
+class com.vmware.nsx.vpn.l2vpn_client.Services(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(l2_vpn_service)
+

Create L2VPN service for a given logical router

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:l2_vpn_service (com.vmware.nsx.model_client.L2VpnService) – (required)
Return type:com.vmware.nsx.model_client.L2VpnService
Returns:com.vmware.nsx.model.L2VpnService
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(l2vpn_service_id, force=None)
+

Delete a specific L2VPN service. If there are any L2VpnSessions on this +L2VpnService, those needs to be deleted first.

+ +++ + + + + + + + + + + + + + +
Parameters:
    +
  • l2vpn_service_id (str) – (required)
    • +
  • force (bool or None) – Force delete the resource even if it is being used somewhere +(optional, default to false)
    • +
+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+get(l2vpn_service_id)
+

Get a specific L2VPN service

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:l2vpn_service_id (str) – (required)
Return type:com.vmware.nsx.model_client.L2VpnService
Returns:com.vmware.nsx.model.L2VpnService
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
+

Get paginated list of all L2VPN services

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.L2VpnServiceListResult

+
Returns:

com.vmware.nsx.model.L2VpnServiceListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(l2vpn_service_id, l2_vpn_service)
+

Edit a specific L2VPN service

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.L2VpnService

+
Returns:

com.vmware.nsx.model.L2VpnService

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.vpn.l2vpn_client.Sessions(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+create(l2_vpn_session)
+

Create L2VPN session and bind to a L2VPNService

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:l2_vpn_session (com.vmware.nsx.model_client.L2VpnSession) – (required)
Return type:com.vmware.nsx.model_client.L2VpnSession
Returns:com.vmware.nsx.model.L2VpnSession
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+delete(l2vpn_session_id)
+

Delete a specific L2VPN session. If there are any logical switch ports +attached to it, those needs to be deleted first.

+ +++ + + + + + + + + + + + + + +
Parameters:l2vpn_session_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+get(l2vpn_session_id)
+

Get a specific L2VPN session

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:l2vpn_session_id (str) – (required)
Return type:com.vmware.nsx.model_client.L2VpnSession
Returns:com.vmware.nsx.model.L2VpnSession
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+
+list(cursor=None, included_fields=None, l2vpn_service_id=None, page_size=None, sort_ascending=None, sort_by=None)
+

Get paginated list of all L2VPN sessions

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
    • +
  • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
    • +
  • l2vpn_service_id (str or None) – Id of the L2Vpn Service (optional)
    • +
  • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
    • +
  • sort_ascending (bool or None) – (optional)
    • +
  • sort_by (str or None) – Field by which records are sorted (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.L2VpnSessionListResult

+
Returns:

com.vmware.nsx.model.L2VpnSessionListResult

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+update(l2vpn_session_id, l2_vpn_session)
+

Edit a specific L2VPN session

+ +++ + + + + + + + + + + + + + + + + + +
Parameters: +
Return type:

com.vmware.nsx.model_client.L2VpnSession

+
Returns:

com.vmware.nsx.model.L2VpnSession

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.vpn.l2vpn_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+

com.vmware.nsx.vpn.services_client module

+
+
+class com.vmware.nsx.vpn.services_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+class com.vmware.nsx.vpn.services_client.Summary(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+GET_SOURCE_CACHED = 'cached'
+

Possible value for source of method Summary.get().

+
+ +
+
+GET_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Summary.get().

+
+ +
+
+get(service_id, source=None)
+

Cumulative statistics for one IKE service instance. Query parameter +source supports only cached mode.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • service_id (str) – (required)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.IPSecVPNIKEServiceSummary

+
Returns:

com.vmware.nsx.model.IPSecVPNIKEServiceSummary

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/com.vmware.nsx.vpn.ipsec.html b/nsx/nsx/com.vmware.nsx.vpn.ipsec.html new file mode 100644 index 00000000..b0867531 --- /dev/null +++ b/nsx/nsx/com.vmware.nsx.vpn.ipsec.html @@ -0,0 +1,498 @@ + + + + + + + + + + + com.vmware.nsx.vpn.ipsec package — NSX-T SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

com.vmware.nsx.vpn.ipsec package

+
+

Submodules

+
+
+

com.vmware.nsx.vpn.ipsec.sessions_client module

+
+
+class com.vmware.nsx.vpn.ipsec.sessions_client.Statistics(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+GET_SOURCE_CACHED = 'cached'
+

Possible value for source of method Statistics.get().

+
+ +
+
+GET_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Statistics.get().

+
+ +
+
+get(session_id, source=None)
+

Get statistics of a vpn session across all tunnels and IKE session. +Query parameter "source=realtime" is the only supported source.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • session_id (str) – (required)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.IPSecVPNSessionStatistics

+
Returns:

com.vmware.nsx.model.IPSecVPNSessionStatistics

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+
+reset(session_id)
+

Reset the statistics of the given VPN session.

+ +++ + + + + + + + + + + + + + +
Parameters:session_id (str) – (required)
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.vpn.ipsec.sessions_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+GET_SOURCE_CACHED = 'cached'
+

Possible value for source of method Status.get().

+
+ +
+
+GET_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Status.get().

+
+ +
+
+get(session_id, source=None)
+

List status of IPSec session. Query parameter source supports both +realtime and cached mode.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • session_id (str) – (required)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.IPSecVPNSessionStatus

+
Returns:

com.vmware.nsx.model.IPSecVPNSessionStatus

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.vpn.ipsec.sessions_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+class com.vmware.nsx.vpn.ipsec.sessions_client.Summary(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+GET_SOURCE_CACHED = 'cached'
+

Possible value for source of method Summary.get().

+
+ +
+
+GET_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Summary.get().

+
+ +
+
+get(site_id=None, source=None)
+

VPN session summary gets summary per vpn sessions and IKE session. +Query parameter source supports only cached mode.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • site_id (str or None) – Peer site id (optional)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.IPSecVPNSessionSummary

+
Returns:

com.vmware.nsx.model.IPSecVPNSessionSummary

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/com.vmware.nsx.vpn.l2vpn.html b/nsx/nsx/com.vmware.nsx.vpn.l2vpn.html new file mode 100644 index 00000000..e6e7c233 --- /dev/null +++ b/nsx/nsx/com.vmware.nsx.vpn.l2vpn.html @@ -0,0 +1,561 @@ + + + + + + + + + + + com.vmware.nsx.vpn.l2vpn package — NSX-T SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

com.vmware.nsx.vpn.l2vpn package

+
+

Submodules

+
+
+

com.vmware.nsx.vpn.l2vpn.sessions_client module

+
+
+class com.vmware.nsx.vpn.l2vpn.sessions_client.PeerCodes(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(l2vpn_session_id)
+

Get peer codes for the L2VPN session to program the remote side of the +tunnel.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:l2vpn_session_id (str) – (required)
Return type:com.vmware.nsx.model_client.L2VpnSessionPeerCodes
Returns:com.vmware.nsx.model.L2VpnSessionPeerCodes
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+class com.vmware.nsx.vpn.l2vpn.sessions_client.RemoteMac(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(session_id, logical_switch_id=None)
+

Get L2VPN session remote mac for logical switch.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • session_id (str) – (required)
    • +
  • logical_switch_id (str or None) – logical switch identifier (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.L2VPNSessionRemoteMacs

+
Returns:

com.vmware.nsx.model.L2VPNSessionRemoteMacs

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.vpn.l2vpn.sessions_client.Statistics(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+GET_SOURCE_CACHED = 'cached'
+

Possible value for source of method Statistics.get().

+
+ +
+
+GET_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Statistics.get().

+
+ +
+
+get(session_id, source=None)
+

Get statistics of a L2VPN session. Query parameter source=realtime is +the only supported source.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • session_id (str) – (required)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.L2VPNSessionStatistics

+
Returns:

com.vmware.nsx.model.L2VPNSessionStatistics

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.vpn.l2vpn.sessions_client.Status(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+GET_SOURCE_CACHED = 'cached'
+

Possible value for source of method Status.get().

+
+ +
+
+GET_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Status.get().

+
+ +
+
+get(session_id, source=None)
+

Aggregated status of L2VPN session. Query parameter +source=realtime|cached is supported.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:
    +
  • session_id (str) – (required)
    • +
  • source (str or None) – Data source type. (optional)
    • +
+
Return type:

com.vmware.nsx.model_client.L2VPNSessionStatus

+
Returns:

com.vmware.nsx.model.L2VPNSessionStatus

+
Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

+
Raise:

com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

+
Raise:

com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not Found

+
+
+ +
+ +
+
+class com.vmware.nsx.vpn.l2vpn.sessions_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+ +++ + + + +
Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
+ +
+
+class com.vmware.nsx.vpn.l2vpn.sessions_client.Summary(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+GET_SOURCE_CACHED = 'cached'
+

Possible value for source of method Summary.get().

+
+ +
+
+GET_SOURCE_REALTIME = 'realtime'
+

Possible value for source of method Summary.get().

+
+ +
+
+get(source=None)
+

Load all the existing L2VPN sessions and return the status summary of +all L2VPN sessions.

+ +++ + + + + + + + + + + + + + + + + + +
Parameters:source (str or None) – Data source type. (optional)
Return type:com.vmware.nsx.model_client.L2VPNSessionSummary
Returns:com.vmware.nsx.model.L2VPNSessionSummary
Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
+
+ +
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/enumeration.html b/nsx/nsx/enumeration.html new file mode 100644 index 00000000..6142c60f --- /dev/null +++ b/nsx/nsx/enumeration.html @@ -0,0 +1,280 @@ + + + + + + + + + + + Interface definition language to python mapping for enumerated types — NSX-T SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Interface definition language to python mapping for enumerated types
    • + + +
  • + + + View page source + + +
    • + +
+ + +
+
+
+
+ +
+

Interface definition language to python mapping for enumerated types

+

The interface language definition type system includes enumerated types. Python +SDK supports both 2.x and 3.x versions of Python. Since Python 2.x does +not have first class support for enumerations, special classes are +generated to represent enumerated types from the interface definition +language. The special class contains class attributes which represent +the values of the enumerated type.

+

This documentation explains the following:

+
    +
  • How the class variables are defined in the module. This specifies the names that you can use in your program.
    • +
  • How you instantiate a class to use it for communication with future versions of the service.
    • +
+
+

Example of an enumerated type documentation

+
+
class com.vmware.vapi.metadata_client. SourceType (string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Metadata source type

+
+

Note

+

This class represents an enumerated type in the interface language definition type system. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports a newer version of the API, you instantiate this class. See enumerated type description page.

+
+

Parameters : string (str) – String value for the SourceType instance.

+
+
FILE = SourceType(string=’FILE’)
+
If the source is backed by a file.
+
REMOTE = SourceType(string=’REMOTE’)
+
If the source is backed by a remote service.
+
+
+
+
+
+

Code Examples

+

The enumerated type classes are defined in python modules that your code +imports. You can use these in your code.

+
    +
  1. If you want to pass an enumerated type value in a method to a server, specify the class variable of the enumerated type class.
    2. +
+
# SourceType is an enumerated type
+from com.vmware.vapi.metadata_client import SourceType
+
+# SourceType has two class attrites, SourceType.FILE and SourceType.REMOTE
+spec = Source.CreateSpec(type=SourceType.FILE, filepath='entity_metadata.json', description='Entity service')
+source_svc.create(id='entity', spec=spec)
+
+
+
    +
  1. When you receive an enumerated type value in the response from a server, allow for unknown enumerated type values.
    2. +
+
# SourceType is an enumerated type
+from com.vmware.vapi.metadata_client import SourceType
+
+source_info = source_svc.get(id='entity')
+if (source_info.type == SourceType.FILE) {
+    print 'Source is a file'
+} else if (source_info.type == SourceType.REMOTE) {
+    print 'Source is a remote provider'
+} else {
+    print 'Unknown source type: %s' % str(source_info.type)
+}
+
+
+
    +
  1. Sending a new enumerated type value to a server that has a newer version of the enumerated type.
    2. +
+

To use new values of the enumerated type in communication with a server that supports a newer version of the API, you instantiate the +enumerated type class.

+
# If a newer version of SourceType has a new value FOLDER, FOLDER would be one
+# of the class attributes for SourceType. In the older version, SourceType has
+# only two class attributes, FILE and REMOTE
+from com.vmware.vapi.metadata_client import SourceType
+spec = Source.CreateSpec(type=SourceType('FOLDER'), filepath='entity_metadata', description='Entity service')
+source_svc.create(id='entity', spec=spec)
+
+
+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/genindex.html b/nsx/nsx/genindex.html new file mode 100644 index 00000000..014526e7 --- /dev/null +++ b/nsx/nsx/genindex.html @@ -0,0 +1,11097 @@ + + + + + + + + + + + + Index — NSX-T SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Index
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ + +

Index

+ +
+ A + | B + | C + | D + | E + | F + | G + | H + | I + | K + | L + | M + | N + | O + | P + | Q + | R + | S + | T + | U + | V + | W + | X + +
+

A

+ + + +
+ +

B

+ + + +
+ +

C

+ + + +
+ +

D

+ + + +
+ +

E

+ + + +
+ +

F

+ + + +
+ +

G

+ + + +
+ +

H

+ + + +
+ +

I

+ + + +
+ +

K

+ + + +
+ +

L

+ + + +
+ +

M

+ + + +
+ +

N

+ + + +
+ +

O

+ + + +
+ +

P

+ + + +
+ +

Q

+ + + +
+ +

R

+ + + +
+ +

S

+ + + +
+ +

T

+ + + +
+ +

U

+ + + +
+ +

V

+ + + +
+ +

W

+ + + +
+ +

X

+ + + +
+ + + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/index.html b/nsx/nsx/index.html new file mode 100644 index 00000000..f79ab026 --- /dev/null +++ b/nsx/nsx/index.html @@ -0,0 +1,524 @@ + + + + + + + + + + + Welcome to NSX-T SDK’s documentation! — NSX-T SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

Welcome to NSX-T SDK’s documentation!

+
+

Contents:

+ +
+
+
+

Indices and tables

+ +
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/objects.inv b/nsx/nsx/objects.inv new file mode 100644 index 00000000..84c5fe00 Binary files /dev/null and b/nsx/nsx/objects.inv differ diff --git a/nsx/nsx/py-modindex.html b/nsx/nsx/py-modindex.html new file mode 100644 index 00000000..a3693e52 --- /dev/null +++ b/nsx/nsx/py-modindex.html @@ -0,0 +1,1038 @@ + + + + + + + + + + + Python Module Index — NSX-T SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Python Module Index
    • + + +
  • + +
    • + +
+ + +
+
+
+
+ + +

Python Module Index

+ +
+ c +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 
+ c
+ com +
    + com.vmware +
    + com.vmware.nsx +
    + com.vmware.nsx.aaa +
    + com.vmware.nsx.aaa.vidm_client +
    + com.vmware.nsx.aaa_client +
    + com.vmware.nsx.administration_client +
    + com.vmware.nsx.app_discovery +
    + com.vmware.nsx.app_discovery.sessions +
    + com.vmware.nsx.app_discovery.sessions.ns_groups_client +
    + com.vmware.nsx.app_discovery.sessions_client +
    + com.vmware.nsx.app_discovery_client +
    + com.vmware.nsx.bridge_clusters_client +
    + com.vmware.nsx.bridge_endpoints_client +
    + com.vmware.nsx.cluster +
    + com.vmware.nsx.cluster.backups_client +
    + com.vmware.nsx.cluster.nodes +
    + com.vmware.nsx.cluster.nodes.deployments_client +
    + com.vmware.nsx.cluster.nodes.network +
    + com.vmware.nsx.cluster.nodes.network.interfaces_client +
    + com.vmware.nsx.cluster.nodes.network_client +
    + com.vmware.nsx.cluster.nodes.repo_sync_client +
    + com.vmware.nsx.cluster.nodes_client +
    + com.vmware.nsx.cluster.restore_client +
    + com.vmware.nsx.cluster_client +
    + com.vmware.nsx.compute_collection_transport_node_templates_client +
    + com.vmware.nsx.configs_client +
    + com.vmware.nsx.dhcp +
    + com.vmware.nsx.dhcp.servers_client +
    + com.vmware.nsx.dhcp_client +
    + com.vmware.nsx.dns +
    + com.vmware.nsx.dns.forwarders_client +
    + com.vmware.nsx.dns_client +
    + com.vmware.nsx.eula_client +
    + com.vmware.nsx.fabric +
    + com.vmware.nsx.fabric.compute_collections +
    + com.vmware.nsx.fabric.compute_collections.network_client +
    + com.vmware.nsx.fabric.compute_managers_client +
    + com.vmware.nsx.fabric.nodes +
    + com.vmware.nsx.fabric.nodes.network +
    + com.vmware.nsx.fabric.nodes.network.interfaces_client +
    + com.vmware.nsx.fabric.nodes.network_client +
    + com.vmware.nsx.fabric.nodes_client +
    + com.vmware.nsx.fabric_client +
    + com.vmware.nsx.firewall +
    + com.vmware.nsx.firewall.rules_client +
    + com.vmware.nsx.firewall.sections +
    + com.vmware.nsx.firewall.sections.rules_client +
    + com.vmware.nsx.firewall.sections_client +
    + com.vmware.nsx.firewall_client +
    + com.vmware.nsx.hpm_client +
    + com.vmware.nsx.ipfix_client +
    + com.vmware.nsx.ipfix_obs_points_client +
    + com.vmware.nsx.licenses_client +
    + com.vmware.nsx.lldp +
    + com.vmware.nsx.lldp.transport_nodes_client +
    + com.vmware.nsx.loadbalancer +
    + com.vmware.nsx.loadbalancer.services +
    + com.vmware.nsx.loadbalancer.services.pools_client +
    + com.vmware.nsx.loadbalancer.services.virtual_servers_client +
    + com.vmware.nsx.loadbalancer.services_client +
    + com.vmware.nsx.loadbalancer.ssl_client +
    + com.vmware.nsx.loadbalancer_client +
    + com.vmware.nsx.logical_ports_client +
    + com.vmware.nsx.logical_router_ports +
    + com.vmware.nsx.logical_router_ports.statistics_client +
    + com.vmware.nsx.logical_router_ports_client +
    + com.vmware.nsx.logical_routers +
    + com.vmware.nsx.logical_routers.nat +
    + com.vmware.nsx.logical_routers.nat.rules_client +
    + com.vmware.nsx.logical_routers.nat_client +
    + com.vmware.nsx.logical_routers.routing +
    + com.vmware.nsx.logical_routers.routing.advertisement_client +
    + com.vmware.nsx.logical_routers.routing.bgp +
    + com.vmware.nsx.logical_routers.routing.bgp.neighbors_client +
    + com.vmware.nsx.logical_routers.routing.bgp_client +
    + com.vmware.nsx.logical_routers.routing.redistribution_client +
    + com.vmware.nsx.logical_routers.routing.static_routes_client +
    + com.vmware.nsx.logical_routers.routing_client +
    + com.vmware.nsx.logical_routers_client +
    + com.vmware.nsx.logical_switches_client +
    + com.vmware.nsx.mac_sets_client +
    + com.vmware.nsx.md_proxies_client +
    + com.vmware.nsx.migration +
    + com.vmware.nsx.migration.bundles_client +
    + com.vmware.nsx.migration.migration_unit_groups_client +
    + com.vmware.nsx.migration.migration_units_client +
    + com.vmware.nsx.migration.plan_client +
    + com.vmware.nsx.migration_client +
    + com.vmware.nsx.model_client +
    + com.vmware.nsx.node +
    + com.vmware.nsx.node.aaa +
    + com.vmware.nsx.node.aaa.providers +
    + com.vmware.nsx.node.aaa.providers.vidm_client +
    + com.vmware.nsx.node.aaa.providers_client +
    + com.vmware.nsx.node.aaa_client +
    + com.vmware.nsx.node.file_store_client +
    + com.vmware.nsx.node.hardening_policy_client +
    + com.vmware.nsx.node.network +
    + com.vmware.nsx.node.network.interfaces_client +
    + com.vmware.nsx.node.network_client +
    + com.vmware.nsx.node.services +
    + com.vmware.nsx.node.services.cluster_manager_client +
    + com.vmware.nsx.node.services.cm_inventory_client +
    + com.vmware.nsx.node.services.http_client +
    + com.vmware.nsx.node.services.install_upgrade_client +
    + com.vmware.nsx.node.services.liagent_client +
    + com.vmware.nsx.node.services.manager_client +
    + com.vmware.nsx.node.services.mgmt_plane_bus_client +
    + com.vmware.nsx.node.services.node_mgmt_client +
    + com.vmware.nsx.node.services.nsx_message_bus_client +
    + com.vmware.nsx.node.services.nsx_upgrade_agent_client +
    + com.vmware.nsx.node.services.ntp_client +
    + com.vmware.nsx.node.services.search_client +
    + com.vmware.nsx.node.services.snmp_client +
    + com.vmware.nsx.node.services.ssh_client +
    + com.vmware.nsx.node.services.syslog_client +
    + com.vmware.nsx.node.services.telemetry_client +
    + com.vmware.nsx.node.services.ui_service_client +
    + com.vmware.nsx.node.services_client +
    + com.vmware.nsx.node.tasks_client +
    + com.vmware.nsx.node.users_client +
    + com.vmware.nsx.node_client +
    + com.vmware.nsx.ns_groups_client +
    + com.vmware.nsx.pktcap_client +
    + com.vmware.nsx.pools +
    + com.vmware.nsx.pools.ip_pools_client +
    + com.vmware.nsx.pools_client +
    + com.vmware.nsx.realization_state_barrier_client +
    + com.vmware.nsx.serviceinsertion +
    + com.vmware.nsx.serviceinsertion.sections_client +
    + com.vmware.nsx.serviceinsertion.services +
    + com.vmware.nsx.serviceinsertion.services.service_instances +
    + com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes +
    + com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.interfaces_client +
    + com.vmware.nsx.serviceinsertion.services.service_instances_client +
    + com.vmware.nsx.serviceinsertion.services_client +
    + com.vmware.nsx.serviceinsertion_client +
    + com.vmware.nsx.switching_profiles_client +
    + com.vmware.nsx.tasks_client +
    + com.vmware.nsx.telemetry_client +
    + com.vmware.nsx.traceflows_client +
    + com.vmware.nsx.transport_nodes +
    + com.vmware.nsx.transport_nodes.statistics_client +
    + com.vmware.nsx.transport_nodes_client +
    + com.vmware.nsx.transport_zones_client +
    + com.vmware.nsx.trust_management_client +
    + com.vmware.nsx.ui_views_client +
    + com.vmware.nsx.upgrade +
    + com.vmware.nsx.upgrade.bundles_client +
    + com.vmware.nsx.upgrade.eula_client +
    + com.vmware.nsx.upgrade.plan_client +
    + com.vmware.nsx.upgrade.upgrade_unit_groups_client +
    + com.vmware.nsx.upgrade.upgrade_units_client +
    + com.vmware.nsx.upgrade_client +
    + com.vmware.nsx.vpn +
    + com.vmware.nsx.vpn.ipsec +
    + com.vmware.nsx.vpn.ipsec.sessions_client +
    + com.vmware.nsx.vpn.ipsec_client +
    + com.vmware.nsx.vpn.l2vpn +
    + com.vmware.nsx.vpn.l2vpn.sessions_client +
    + com.vmware.nsx.vpn.l2vpn_client +
    + com.vmware.nsx.vpn.services_client +
    + com.vmware.nsx_client +
    + com.vmware.nsx_client_for_vmc +
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/search.html b/nsx/nsx/search.html new file mode 100644 index 00000000..8b138a5e --- /dev/null +++ b/nsx/nsx/search.html @@ -0,0 +1,219 @@ + + + + + + + + + + + Search — NSX-T SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Search
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ + + + +
+ +
+ +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx/searchindex.js b/nsx/nsx/searchindex.js new file mode 100644 index 00000000..8b9ddefe --- /dev/null +++ b/nsx/nsx/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({docnames:["com","com.vmware","com.vmware.nsx","com.vmware.nsx.aaa","com.vmware.nsx.app_discovery","com.vmware.nsx.app_discovery.sessions","com.vmware.nsx.cluster","com.vmware.nsx.cluster.nodes","com.vmware.nsx.cluster.nodes.network","com.vmware.nsx.dhcp","com.vmware.nsx.dns","com.vmware.nsx.fabric","com.vmware.nsx.fabric.compute_collections","com.vmware.nsx.fabric.nodes","com.vmware.nsx.fabric.nodes.network","com.vmware.nsx.firewall","com.vmware.nsx.firewall.sections","com.vmware.nsx.lldp","com.vmware.nsx.loadbalancer","com.vmware.nsx.loadbalancer.services","com.vmware.nsx.logical_router_ports","com.vmware.nsx.logical_routers","com.vmware.nsx.logical_routers.nat","com.vmware.nsx.logical_routers.routing","com.vmware.nsx.logical_routers.routing.bgp","com.vmware.nsx.migration","com.vmware.nsx.node","com.vmware.nsx.node.aaa","com.vmware.nsx.node.aaa.providers","com.vmware.nsx.node.network","com.vmware.nsx.node.services","com.vmware.nsx.pools","com.vmware.nsx.serviceinsertion","com.vmware.nsx.serviceinsertion.services","com.vmware.nsx.serviceinsertion.services.service_instances","com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes","com.vmware.nsx.transport_nodes","com.vmware.nsx.upgrade","com.vmware.nsx.vpn","com.vmware.nsx.vpn.ipsec","com.vmware.nsx.vpn.l2vpn","enumeration","index"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":1,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,sphinx:55},filenames:["com.rst","com.vmware.rst","com.vmware.nsx.rst","com.vmware.nsx.aaa.rst","com.vmware.nsx.app_discovery.rst","com.vmware.nsx.app_discovery.sessions.rst","com.vmware.nsx.cluster.rst","com.vmware.nsx.cluster.nodes.rst","com.vmware.nsx.cluster.nodes.network.rst","com.vmware.nsx.dhcp.rst","com.vmware.nsx.dns.rst","com.vmware.nsx.fabric.rst","com.vmware.nsx.fabric.compute_collections.rst","com.vmware.nsx.fabric.nodes.rst","com.vmware.nsx.fabric.nodes.network.rst","com.vmware.nsx.firewall.rst","com.vmware.nsx.firewall.sections.rst","com.vmware.nsx.lldp.rst","com.vmware.nsx.loadbalancer.rst","com.vmware.nsx.loadbalancer.services.rst","com.vmware.nsx.logical_router_ports.rst","com.vmware.nsx.logical_routers.rst","com.vmware.nsx.logical_routers.nat.rst","com.vmware.nsx.logical_routers.routing.rst","com.vmware.nsx.logical_routers.routing.bgp.rst","com.vmware.nsx.migration.rst","com.vmware.nsx.node.rst","com.vmware.nsx.node.aaa.rst","com.vmware.nsx.node.aaa.providers.rst","com.vmware.nsx.node.network.rst","com.vmware.nsx.node.services.rst","com.vmware.nsx.pools.rst","com.vmware.nsx.serviceinsertion.rst","com.vmware.nsx.serviceinsertion.services.rst","com.vmware.nsx.serviceinsertion.services.service_instances.rst","com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.rst","com.vmware.nsx.transport_nodes.rst","com.vmware.nsx.upgrade.rst","com.vmware.nsx.vpn.rst","com.vmware.nsx.vpn.ipsec.rst","com.vmware.nsx.vpn.l2vpn.rst","enumeration.rst","index.rst"],objects:{"":{com:[0,0,0,"-"]},"com.vmware":{nsx:[2,0,0,"-"],nsx_client:[1,0,0,"-"],nsx_client_for_vmc:[1,0,0,"-"]},"com.vmware.nsx":{aaa:[3,0,0,"-"],aaa_client:[2,0,0,"-"],administration_client:[2,0,0,"-"],app_discovery:[4,0,0,"-"],app_discovery_client:[2,0,0,"-"],bridge_clusters_client:[2,0,0,"-"],bridge_endpoints_client:[2,0,0,"-"],cluster:[6,0,0,"-"],cluster_client:[2,0,0,"-"],compute_collection_transport_node_templates_client:[2,0,0,"-"],configs_client:[2,0,0,"-"],dhcp:[9,0,0,"-"],dhcp_client:[2,0,0,"-"],dns:[10,0,0,"-"],dns_client:[2,0,0,"-"],eula_client:[2,0,0,"-"],fabric:[11,0,0,"-"],fabric_client:[2,0,0,"-"],firewall:[15,0,0,"-"],firewall_client:[2,0,0,"-"],hpm_client:[2,0,0,"-"],ipfix_client:[2,0,0,"-"],ipfix_obs_points_client:[2,0,0,"-"],licenses_client:[2,0,0,"-"],lldp:[17,0,0,"-"],loadbalancer:[18,0,0,"-"],loadbalancer_client:[2,0,0,"-"],logical_ports_client:[2,0,0,"-"],logical_router_ports:[20,0,0,"-"],logical_router_ports_client:[2,0,0,"-"],logical_routers:[21,0,0,"-"],logical_routers_client:[2,0,0,"-"],logical_switches_client:[2,0,0,"-"],mac_sets_client:[2,0,0,"-"],md_proxies_client:[2,0,0,"-"],migration:[25,0,0,"-"],migration_client:[2,0,0,"-"],model_client:[2,0,0,"-"],node:[26,0,0,"-"],node_client:[2,0,0,"-"],ns_groups_client:[2,0,0,"-"],pktcap_client:[2,0,0,"-"],pools:[31,0,0,"-"],pools_client:[2,0,0,"-"],realization_state_barrier_client:[2,0,0,"-"],serviceinsertion:[32,0,0,"-"],serviceinsertion_client:[2,0,0,"-"],switching_profiles_client:[2,0,0,"-"],tasks_client:[2,0,0,"-"],telemetry_client:[2,0,0,"-"],traceflows_client:[2,0,0,"-"],transport_nodes:[36,0,0,"-"],transport_nodes_client:[2,0,0,"-"],transport_zones_client:[2,0,0,"-"],trust_management_client:[2,0,0,"-"],ui_views_client:[2,0,0,"-"],upgrade:[37,0,0,"-"],upgrade_client:[2,0,0,"-"],vpn:[38,0,0,"-"]},"com.vmware.nsx.aaa":{vidm_client:[3,0,0,"-"]},"com.vmware.nsx.aaa.vidm_client":{Groups:[3,1,1,""],Search:[3,1,1,""],StubFactory:[3,1,1,""],Users:[3,1,1,""]},"com.vmware.nsx.aaa.vidm_client.Groups":{list:[3,2,1,""]},"com.vmware.nsx.aaa.vidm_client.Search":{create:[3,2,1,""]},"com.vmware.nsx.aaa.vidm_client.Users":{list:[3,2,1,""]},"com.vmware.nsx.aaa_client":{RegistrationToken:[2,1,1,""],RoleBindings:[2,1,1,""],Roles:[2,1,1,""],StubFactory:[2,1,1,""],UserInfo:[2,1,1,""]},"com.vmware.nsx.aaa_client.RegistrationToken":{"delete":[2,2,1,""],create:[2,2,1,""],get:[2,2,1,""]},"com.vmware.nsx.aaa_client.RoleBindings":{"delete":[2,2,1,""],LIST_TYPE_LOCAL_USER:[2,3,1,""],LIST_TYPE_PRINCIPAL_IDENTITY:[2,3,1,""],LIST_TYPE_REMOTE_GROUP:[2,3,1,""],LIST_TYPE_REMOTE_USER:[2,3,1,""],create:[2,2,1,""],deletestalebindings:[2,2,1,""],get:[2,2,1,""],list:[2,2,1,""],update:[2,2,1,""]},"com.vmware.nsx.aaa_client.Roles":{get:[2,2,1,""],list:[2,2,1,""]},"com.vmware.nsx.aaa_client.UserInfo":{get:[2,2,1,""]},"com.vmware.nsx.administration_client":{AuditLogs:[2,1,1,""],StubFactory:[2,1,1,""],SupportBundles:[2,1,1,""]},"com.vmware.nsx.administration_client.AuditLogs":{create:[2,2,1,""]},"com.vmware.nsx.administration_client.SupportBundles":{collect:[2,2,1,""]},"com.vmware.nsx.app_discovery":{sessions:[5,0,0,"-"],sessions_client:[4,0,0,"-"]},"com.vmware.nsx.app_discovery.sessions":{ns_groups_client:[5,0,0,"-"]},"com.vmware.nsx.app_discovery.sessions.ns_groups_client":{Members:[5,1,1,""],StubFactory:[5,1,1,""]},"com.vmware.nsx.app_discovery.sessions.ns_groups_client.Members":{list:[5,2,1,""]},"com.vmware.nsx.app_discovery.sessions_client":{AppProfiles:[4,1,1,""],InstalledApps:[4,1,1,""],NsGroups:[4,1,1,""],ReClassify:[4,1,1,""],StubFactory:[4,1,1,""],Summary:[4,1,1,""]},"com.vmware.nsx.app_discovery.sessions_client.AppProfiles":{list:[4,2,1,""]},"com.vmware.nsx.app_discovery.sessions_client.InstalledApps":{list:[4,2,1,""]},"com.vmware.nsx.app_discovery.sessions_client.NsGroups":{list:[4,2,1,""]},"com.vmware.nsx.app_discovery.sessions_client.ReClassify":{create:[4,2,1,""]},"com.vmware.nsx.app_discovery.sessions_client.Summary":{get:[4,2,1,""]},"com.vmware.nsx.app_discovery_client":{AppProfiles:[2,1,1,""],Sessions:[2,1,1,""],StubFactory:[2,1,1,""]},"com.vmware.nsx.app_discovery_client.AppProfiles":{"delete":[2,2,1,""],create:[2,2,1,""],get:[2,2,1,""],list:[2,2,1,""],update:[2,2,1,""]},"com.vmware.nsx.app_discovery_client.Sessions":{"delete":[2,2,1,""],LIST_STATUS_FAILED:[2,3,1,""],LIST_STATUS_FINISHED:[2,3,1,""],LIST_STATUS_RUNNING:[2,3,1,""],LIST_STATUS_STARTING:[2,3,1,""],create:[2,2,1,""],get:[2,2,1,""],list:[2,2,1,""]},"com.vmware.nsx.bridge_clusters_client":{Status:[2,1,1,""],StubFactory:[2,1,1,""]},"com.vmware.nsx.bridge_clusters_client.Status":{GET_SOURCE_CACHED:[2,3,1,""],GET_SOURCE_REALTIME:[2,3,1,""],get:[2,2,1,""]},"com.vmware.nsx.bridge_endpoints_client":{Statistics:[2,1,1,""],Status:[2,1,1,""],StubFactory:[2,1,1,""]},"com.vmware.nsx.bridge_endpoints_client.Statistics":{GET_SOURCE_CACHED:[2,3,1,""],GET_SOURCE_REALTIME:[2,3,1,""],get:[2,2,1,""]},"com.vmware.nsx.bridge_endpoints_client.Status":{GET_SOURCE_CACHED:[2,3,1,""],GET_SOURCE_REALTIME:[2,3,1,""],get:[2,2,1,""]},"com.vmware.nsx.cluster":{backups_client:[6,0,0,"-"],nodes:[7,0,0,"-"],nodes_client:[6,0,0,"-"],restore_client:[6,0,0,"-"]},"com.vmware.nsx.cluster.backups_client":{Config:[6,1,1,""],History:[6,1,1,""],Status:[6,1,1,""],StubFactory:[6,1,1,""]},"com.vmware.nsx.cluster.backups_client.Config":{get:[6,2,1,""],update:[6,2,1,""]},"com.vmware.nsx.cluster.backups_client.History":{get:[6,2,1,""]},"com.vmware.nsx.cluster.backups_client.Status":{get:[6,2,1,""]},"com.vmware.nsx.cluster.nodes":{deployments_client:[7,0,0,"-"],network:[8,0,0,"-"],network_client:[7,0,0,"-"],repo_sync_client:[7,0,0,"-"]},"com.vmware.nsx.cluster.nodes.deployments_client":{Status:[7,1,1,""],StubFactory:[7,1,1,""]},"com.vmware.nsx.cluster.nodes.deployments_client.Status":{get:[7,2,1,""]},"com.vmware.nsx.cluster.nodes.network":{interfaces_client:[8,0,0,"-"]},"com.vmware.nsx.cluster.nodes.network.interfaces_client":{Stats:[8,1,1,""],StubFactory:[8,1,1,""]},"com.vmware.nsx.cluster.nodes.network.interfaces_client.Stats":{GET_SOURCE_CACHED:[8,3,1,""],GET_SOURCE_REALTIME:[8,3,1,""],get:[8,2,1,""]},"com.vmware.nsx.cluster.nodes.network_client":{Interfaces:[7,1,1,""],StubFactory:[7,1,1,""]},"com.vmware.nsx.cluster.nodes.network_client.Interfaces":{GET_SOURCE_CACHED:[7,3,1,""],GET_SOURCE_REALTIME:[7,3,1,""],LIST_SOURCE_CACHED:[7,3,1,""],LIST_SOURCE_REALTIME:[7,3,1,""],get:[7,2,1,""],list:[7,2,1,""]},"com.vmware.nsx.cluster.nodes.repo_sync_client":{Status:[7,1,1,""],StubFactory:[7,1,1,""]},"com.vmware.nsx.cluster.nodes.repo_sync_client.Status":{get:[7,2,1,""]},"com.vmware.nsx.cluster.nodes_client":{Deployments:[6,1,1,""],Status:[6,1,1,""],StubFactory:[6,1,1,""]},"com.vmware.nsx.cluster.nodes_client.Deployments":{"delete":[6,2,1,""],create:[6,2,1,""],get:[6,2,1,""],list:[6,2,1,""]},"com.vmware.nsx.cluster.nodes_client.Status":{GET_SOURCE_CACHED:[6,3,1,""],GET_SOURCE_REALTIME:[6,3,1,""],get:[6,2,1,""],getall:[6,2,1,""]},"com.vmware.nsx.cluster.restore_client":{Backuptimestamps:[6,1,1,""],Config:[6,1,1,""],InstructionResources:[6,1,1,""],Status:[6,1,1,""],StubFactory:[6,1,1,""]},"com.vmware.nsx.cluster.restore_client.Backuptimestamps":{get:[6,2,1,""]},"com.vmware.nsx.cluster.restore_client.Config":{get:[6,2,1,""],update:[6,2,1,""]},"com.vmware.nsx.cluster.restore_client.InstructionResources":{get:[6,2,1,""]},"com.vmware.nsx.cluster.restore_client.Status":{get:[6,2,1,""]},"com.vmware.nsx.cluster_client":{Backups:[2,1,1,""],Node:[2,1,1,""],Nodes:[2,1,1,""],Restore:[2,1,1,""],Status:[2,1,1,""],StubFactory:[2,1,1,""]},"com.vmware.nsx.cluster_client.Backups":{retrievesshfingerprint:[2,2,1,""]},"com.vmware.nsx.cluster_client.Node":{reposync:[2,2,1,""]},"com.vmware.nsx.cluster_client.Nodes":{"delete":[2,2,1,""],CREATE_ACTION_NODE:[2,3,1,""],create:[2,2,1,""],get:[2,2,1,""],list:[2,2,1,""]},"com.vmware.nsx.cluster_client.Restore":{advance:[2,2,1,""],cancel:[2,2,1,""],retry:[2,2,1,""],start:[2,2,1,""],suspend:[2,2,1,""]},"com.vmware.nsx.cluster_client.Status":{GET_SOURCE_CACHED:[2,3,1,""],GET_SOURCE_REALTIME:[2,3,1,""],get:[2,2,1,""]},"com.vmware.nsx.compute_collection_transport_node_templates_client":{State:[2,1,1,""],StubFactory:[2,1,1,""]},"com.vmware.nsx.compute_collection_transport_node_templates_client.State":{list:[2,2,1,""]},"com.vmware.nsx.configs_client":{Inventory:[2,1,1,""],Management:[2,1,1,""],StubFactory:[2,1,1,""]},"com.vmware.nsx.configs_client.Inventory":{get:[2,2,1,""]},"com.vmware.nsx.configs_client.Management":{get:[2,2,1,""],update:[2,2,1,""]},"com.vmware.nsx.dhcp":{servers_client:[9,0,0,"-"]},"com.vmware.nsx.dhcp.servers_client":{IpPools:[9,1,1,""],Leases:[9,1,1,""],StaticBindings:[9,1,1,""],Statistics:[9,1,1,""],Status:[9,1,1,""],StubFactory:[9,1,1,""]},"com.vmware.nsx.dhcp.servers_client.IpPools":{"delete":[9,2,1,""],create:[9,2,1,""],get:[9,2,1,""],list:[9,2,1,""],update:[9,2,1,""]},"com.vmware.nsx.dhcp.servers_client.Leases":{GET_SOURCE_CACHED:[9,3,1,""],GET_SOURCE_REALTIME:[9,3,1,""],get:[9,2,1,""]},"com.vmware.nsx.dhcp.servers_client.StaticBindings":{"delete":[9,2,1,""],create:[9,2,1,""],get:[9,2,1,""],list:[9,2,1,""],update:[9,2,1,""]},"com.vmware.nsx.dhcp.servers_client.Statistics":{get:[9,2,1,""]},"com.vmware.nsx.dhcp.servers_client.Status":{get:[9,2,1,""]},"com.vmware.nsx.dhcp_client":{RelayProfiles:[2,1,1,""],Relays:[2,1,1,""],ServerProfiles:[2,1,1,""],Servers:[2,1,1,""],StubFactory:[2,1,1,""]},"com.vmware.nsx.dhcp_client.RelayProfiles":{"delete":[2,2,1,""],create:[2,2,1,""],get:[2,2,1,""],list:[2,2,1,""],update:[2,2,1,""]},"com.vmware.nsx.dhcp_client.Relays":{"delete":[2,2,1,""],create:[2,2,1,""],get:[2,2,1,""],list:[2,2,1,""],update:[2,2,1,""]},"com.vmware.nsx.dhcp_client.ServerProfiles":{"delete":[2,2,1,""],create:[2,2,1,""],get:[2,2,1,""],list:[2,2,1,""],update:[2,2,1,""]},"com.vmware.nsx.dhcp_client.Servers":{"delete":[2,2,1,""],create:[2,2,1,""],get:[2,2,1,""],list:[2,2,1,""],update:[2,2,1,""]},"com.vmware.nsx.dns":{forwarders_client:[10,0,0,"-"]},"com.vmware.nsx.dns.forwarders_client":{Nslookup:[10,1,1,""],StubFactory:[10,1,1,""]},"com.vmware.nsx.dns.forwarders_client.Nslookup":{get:[10,2,1,""]},"com.vmware.nsx.dns_client":{Forwarders:[2,1,1,""],StubFactory:[2,1,1,""]},"com.vmware.nsx.dns_client.Forwarders":{"delete":[2,2,1,""],clearcache:[2,2,1,""],create:[2,2,1,""],get:[2,2,1,""],list:[2,2,1,""],update:[2,2,1,""]},"com.vmware.nsx.eula_client":{Accept:[2,1,1,""],Acceptance:[2,1,1,""],Content:[2,1,1,""],StubFactory:[2,1,1,""]},"com.vmware.nsx.eula_client.Accept":{create:[2,2,1,""]},"com.vmware.nsx.eula_client.Acceptance":{get:[2,2,1,""]},"com.vmware.nsx.eula_client.Content":{get:[2,2,1,""]},"com.vmware.nsx.fabric":{compute_collections:[12,0,0,"-"],compute_managers_client:[11,0,0,"-"],nodes:[13,0,0,"-"],nodes_client:[11,0,0,"-"]},"com.vmware.nsx.fabric.compute_collections":{network_client:[12,0,0,"-"]},"com.vmware.nsx.fabric.compute_collections.network_client":{PhysicalInterfaces:[12,1,1,""],StubFactory:[12,1,1,""]},"com.vmware.nsx.fabric.compute_collections.network_client.PhysicalInterfaces":{list:[12,2,1,""]},"com.vmware.nsx.fabric.compute_managers_client":{State:[11,1,1,""],Status:[11,1,1,""],StubFactory:[11,1,1,""]},"com.vmware.nsx.fabric.compute_managers_client.State":{get:[11,2,1,""]},"com.vmware.nsx.fabric.compute_managers_client.Status":{get:[11,2,1,""]},"com.vmware.nsx.fabric.nodes":{network:[14,0,0,"-"],network_client:[13,0,0,"-"]},"com.vmware.nsx.fabric.nodes.network":{interfaces_client:[14,0,0,"-"]},"com.vmware.nsx.fabric.nodes.network.interfaces_client":{Stats:[14,1,1,""],StubFactory:[14,1,1,""]},"com.vmware.nsx.fabric.nodes.network.interfaces_client.Stats":{GET_SOURCE_CACHED:[14,3,1,""],GET_SOURCE_REALTIME:[14,3,1,""],get:[14,2,1,""]},"com.vmware.nsx.fabric.nodes.network_client":{Interfaces:[13,1,1,""],StubFactory:[13,1,1,""]},"com.vmware.nsx.fabric.nodes.network_client.Interfaces":{GET_SOURCE_CACHED:[13,3,1,""],GET_SOURCE_REALTIME:[13,3,1,""],LIST_SOURCE_CACHED:[13,3,1,""],LIST_SOURCE_REALTIME:[13,3,1,""],get:[13,2,1,""],list:[13,2,1,""]},"com.vmware.nsx.fabric.nodes_client":{Capabilities:[11,1,1,""],Modules:[11,1,1,""],State:[11,1,1,""],Status:[11,1,1,""],StubFactory:[11,1,1,""]},"com.vmware.nsx.fabric.nodes_client.Capabilities":{get:[11,2,1,""]},"com.vmware.nsx.fabric.nodes_client.Modules":{get:[11,2,1,""]},"com.vmware.nsx.fabric.nodes_client.State":{get:[11,2,1,""]},"com.vmware.nsx.fabric.nodes_client.Status":{GET_SOURCE_CACHED:[11,3,1,""],GET_SOURCE_REALTIME:[11,3,1,""],get:[11,2,1,""],getall:[11,2,1,""]},"com.vmware.nsx.fabric_client":{ComputeCollectionFabricTemplates:[2,1,1,""],ComputeCollections:[2,1,1,""],ComputeManagers:[2,1,1,""],DiscoveredNodes:[2,1,1,""],Nodes:[2,1,1,""],StubFactory:[2,1,1,""],Vifs:[2,1,1,""],VirtualMachines:[2,1,1,""]},"com.vmware.nsx.fabric_client.ComputeCollectionFabricTemplates":{"delete":[2,2,1,""],create:[2,2,1,""],get:[2,2,1,""],list:[2,2,1,""],update:[2,2,1,""]},"com.vmware.nsx.fabric_client.ComputeCollections":{CREATE_ACTION_NSX:[2,3,1,""],create:[2,2,1,""],get:[2,2,1,""],list:[2,2,1,""]},"com.vmware.nsx.fabric_client.ComputeManagers":{"delete":[2,2,1,""],create:[2,2,1,""],get:[2,2,1,""],list:[2,2,1,""],update:[2,2,1,""]},"com.vmware.nsx.fabric_client.DiscoveredNodes":{LIST_HAS_PARENT_FALSE:[2,3,1,""],LIST_HAS_PARENT_TRUE:[2,3,1,""],get:[2,2,1,""],hostprep:[2,2,1,""],list:[2,2,1,""]},"com.vmware.nsx.fabric_client.Nodes":{"delete":[2,2,1,""],LIST_HYPERVISOR_OS_TYPE_CENTOSKVM:[2,3,1,""],LIST_HYPERVISOR_OS_TYPE_CENTOSSERVER:[2,3,1,""],LIST_HYPERVISOR_OS_TYPE_ESXI:[2,3,1,""],LIST_HYPERVISOR_OS_TYPE_HYPERV:[2,3,1,""],LIST_HYPERVISOR_OS_TYPE_RHELCONTAINER:[2,3,1,""],LIST_HYPERVISOR_OS_TYPE_RHELKVM:[2,3,1,""],LIST_HYPERVISOR_OS_TYPE_RHELSERVER:[2,3,1,""],LIST_HYPERVISOR_OS_TYPE_UBUNTUKVM:[2,3,1,""],LIST_HYPERVISOR_OS_TYPE_UBUNTUSERVER:[2,3,1,""],LIST_RESOURCE_TYPE_EDGENODE:[2,3,1,""],LIST_RESOURCE_TYPE_HOSTNODE:[2,3,1,""],LIST_RESOURCE_TYPE_PUBLICCLOUDGATEWAYNODE:[2,3,1,""],PERFORMACTION_ACTION_ENTER_MAINTENANCE_MODE:[2,3,1,""],PERFORMACTION_ACTION_EXIT_MAINTENANCE_MODE:[2,3,1,""],create:[2,2,1,""],create_0:[2,2,1,""],delete_0:[2,2,1,""],get:[2,2,1,""],get_0:[2,2,1,""],list:[2,2,1,""],performaction:[2,2,1,""],restartinventorysync:[2,2,1,""],update:[2,2,1,""],update_0:[2,2,1,""],upgradeinfra:[2,2,1,""]},"com.vmware.nsx.fabric_client.Vifs":{list:[2,2,1,""]},"com.vmware.nsx.fabric_client.VirtualMachines":{list:[2,2,1,""],updatetags:[2,2,1,""]},"com.vmware.nsx.firewall":{rules_client:[15,0,0,"-"],sections:[16,0,0,"-"],sections_client:[15,0,0,"-"]},"com.vmware.nsx.firewall.rules_client":{State:[15,1,1,""],StubFactory:[15,1,1,""]},"com.vmware.nsx.firewall.rules_client.State":{get:[15,2,1,""]},"com.vmware.nsx.firewall.sections":{rules_client:[16,0,0,"-"]},"com.vmware.nsx.firewall.sections.rules_client":{Stats:[16,1,1,""],StubFactory:[16,1,1,""]},"com.vmware.nsx.firewall.sections.rules_client.Stats":{GET_0_SOURCE_CACHED:[16,3,1,""],GET_0_SOURCE_REALTIME:[16,3,1,""],GET_SOURCE_CACHED:[16,3,1,""],GET_SOURCE_REALTIME:[16,3,1,""],get:[16,2,1,""],get_0:[16,2,1,""]},"com.vmware.nsx.firewall.sections_client":{Rules:[15,1,1,""],State:[15,1,1,""],StubFactory:[15,1,1,""],Summary:[15,1,1,""]},"com.vmware.nsx.firewall.sections_client.Rules":{"delete":[15,2,1,""],CREATEMULTIPLE_OPERATION_AFTER:[15,3,1,""],CREATEMULTIPLE_OPERATION_BEFORE:[15,3,1,""],CREATEMULTIPLE_OPERATION_BOTTOM:[15,3,1,""],CREATEMULTIPLE_OPERATION_TOP:[15,3,1,""],CREATE_OPERATION_AFTER:[15,3,1,""],CREATE_OPERATION_BEFORE:[15,3,1,""],CREATE_OPERATION_BOTTOM:[15,3,1,""],CREATE_OPERATION_TOP:[15,3,1,""],LIST_FILTER_TYPE_FILTER:[15,3,1,""],LIST_FILTER_TYPE_SEARCH:[15,3,1,""],REVISE_OPERATION_AFTER:[15,3,1,""],REVISE_OPERATION_BEFORE:[15,3,1,""],REVISE_OPERATION_BOTTOM:[15,3,1,""],REVISE_OPERATION_TOP:[15,3,1,""],create:[15,2,1,""],createmultiple:[15,2,1,""],get:[15,2,1,""],list:[15,2,1,""],revise:[15,2,1,""],update:[15,2,1,""]},"com.vmware.nsx.firewall.sections_client.State":{get:[15,2,1,""]},"com.vmware.nsx.firewall.sections_client.Summary":{GET_SOURCE_CACHED:[15,3,1,""],GET_SOURCE_REALTIME:[15,3,1,""],get:[15,2,1,""]},"com.vmware.nsx.firewall_client":{Excludelist:[2,1,1,""],Rules:[2,1,1,""],Sections:[2,1,1,""],Stats:[2,1,1,""],Status:[2,1,1,""],StubFactory:[2,1,1,""]},"com.vmware.nsx.firewall_client.Excludelist":{addmember:[2,2,1,""],checkifexists:[2,2,1,""],get:[2,2,1,""],removemember:[2,2,1,""],update:[2,2,1,""]},"com.vmware.nsx.firewall_client.Rules":{get:[2,2,1,""]},"com.vmware.nsx.firewall_client.Sections":{"delete":[2,2,1,""],CREATEWITHRULES_OPERATION_AFTER:[2,3,1,""],CREATEWITHRULES_OPERATION_BEFORE:[2,3,1,""],CREATEWITHRULES_OPERATION_BOTTOM:[2,3,1,""],CREATEWITHRULES_OPERATION_TOP:[2,3,1,""],CREATE_OPERATION_AFTER:[2,3,1,""],CREATE_OPERATION_BEFORE:[2,3,1,""],CREATE_OPERATION_BOTTOM:[2,3,1,""],CREATE_OPERATION_TOP:[2,3,1,""],LIST_ENFORCED_ON_BRIDGEENDPOINT:[2,3,1,""],LIST_ENFORCED_ON_DHCP_SERVICE:[2,3,1,""],LIST_ENFORCED_ON_L2VPN_SESSION:[2,3,1,""],LIST_ENFORCED_ON_LOGICALROUTER:[2,3,1,""],LIST_ENFORCED_ON_METADATA_PROXY:[2,3,1,""],LIST_ENFORCED_ON_NONE:[2,3,1,""],LIST_ENFORCED_ON_VIF:[2,3,1,""],LIST_EXCLUDE_APPLIED_TO_TYPE_LOGICALPORT:[2,3,1,""],LIST_EXCLUDE_APPLIED_TO_TYPE_LOGICALROUTER:[2,3,1,""],LIST_EXCLUDE_APPLIED_TO_TYPE_LOGICALSWITCH:[2,3,1,""],LIST_EXCLUDE_APPLIED_TO_TYPE_NSGROUP:[2,3,1,""],LIST_FILTER_TYPE_FILTER:[2,3,1,""],LIST_FILTER_TYPE_SEARCH:[2,3,1,""],LIST_INCLUDE_APPLIED_TO_TYPE_LOGICALPORT:[2,3,1,""],LIST_INCLUDE_APPLIED_TO_TYPE_LOGICALROUTER:[2,3,1,""],LIST_INCLUDE_APPLIED_TO_TYPE_LOGICALSWITCH:[2,3,1,""],LIST_INCLUDE_APPLIED_TO_TYPE_NSGROUP:[2,3,1,""],LIST_TYPE_LAYER2:[2,3,1,""],LIST_TYPE_LAYER3:[2,3,1,""],REVISEWITHRULES_OPERATION_AFTER:[2,3,1,""],REVISEWITHRULES_OPERATION_BEFORE:[2,3,1,""],REVISEWITHRULES_OPERATION_BOTTOM:[2,3,1,""],REVISEWITHRULES_OPERATION_TOP:[2,3,1,""],REVISE_OPERATION_AFTER:[2,3,1,""],REVISE_OPERATION_BEFORE:[2,3,1,""],REVISE_OPERATION_BOTTOM:[2,3,1,""],REVISE_OPERATION_TOP:[2,3,1,""],create:[2,2,1,""],createwithrules:[2,2,1,""],get:[2,2,1,""],list:[2,2,1,""],listwithrules:[2,2,1,""],lock:[2,2,1,""],revise:[2,2,1,""],revisewithrules:[2,2,1,""],unlock:[2,2,1,""],update:[2,2,1,""],updatewithrules:[2,2,1,""]},"com.vmware.nsx.firewall_client.Stats":{RESET_CATEGORY_L3BRIDGEPORT:[2,3,1,""],RESET_CATEGORY_L3DFW:[2,3,1,""],RESET_CATEGORY_L3EDGE:[2,3,1,""],reset:[2,2,1,""]},"com.vmware.nsx.firewall_client.Status":{disablefirewall:[2,2,1,""],enablefirewall:[2,2,1,""],get:[2,2,1,""],get_0:[2,2,1,""],list:[2,2,1,""],update:[2,2,1,""]},"com.vmware.nsx.hpm_client":{Alarms:[2,1,1,""],Features:[2,1,1,""],GlobalConfig:[2,1,1,""],StubFactory:[2,1,1,""]},"com.vmware.nsx.hpm_client.Alarms":{list:[2,2,1,""]},"com.vmware.nsx.hpm_client.Features":{RESETCOLLECTIONFREQUENCY_ACTION_FREQUENCY:[2,3,1,""],get:[2,2,1,""],list:[2,2,1,""],resetcollectionfrequency:[2,2,1,""],update:[2,2,1,""]},"com.vmware.nsx.hpm_client.GlobalConfig":{get:[2,2,1,""],update:[2,2,1,""]},"com.vmware.nsx.ipfix_client":{Collectorconfigs:[2,1,1,""],Configs:[2,1,1,""],StubFactory:[2,1,1,""]},"com.vmware.nsx.ipfix_client.Collectorconfigs":{"delete":[2,2,1,""],create:[2,2,1,""],get:[2,2,1,""],list:[2,2,1,""],update:[2,2,1,""]},"com.vmware.nsx.ipfix_client.Configs":{"delete":[2,2,1,""],LIST_IPFIX_CONFIG_TYPE_IPFIXDFWCONFIG:[2,3,1,""],LIST_IPFIX_CONFIG_TYPE_IPFIXSWITCHCONFIG:[2,3,1,""],create:[2,2,1,""],get:[2,2,1,""],list:[2,2,1,""],update:[2,2,1,""]},"com.vmware.nsx.ipfix_obs_points_client":{StubFactory:[2,1,1,""],SwitchGlobal:[2,1,1,""]},"com.vmware.nsx.ipfix_obs_points_client.SwitchGlobal":{get:[2,2,1,""],update:[2,2,1,""]},"com.vmware.nsx.licenses_client":{LicensesUsage:[2,1,1,""],StubFactory:[2,1,1,""]},"com.vmware.nsx.licenses_client.LicensesUsage":{get:[2,2,1,""]},"com.vmware.nsx.lldp":{transport_nodes_client:[17,0,0,"-"]},"com.vmware.nsx.lldp.transport_nodes_client":{Interfaces:[17,1,1,""],StubFactory:[17,1,1,""]},"com.vmware.nsx.lldp.transport_nodes_client.Interfaces":{get:[17,2,1,""],list:[17,2,1,""]},"com.vmware.nsx.loadbalancer":{services:[19,0,0,"-"],services_client:[18,0,0,"-"],ssl_client:[18,0,0,"-"]},"com.vmware.nsx.loadbalancer.services":{pools_client:[19,0,0,"-"],virtual_servers_client:[19,0,0,"-"]},"com.vmware.nsx.loadbalancer.services.pools_client":{Statistics:[19,1,1,""],Status:[19,1,1,""],StubFactory:[19,1,1,""]},"com.vmware.nsx.loadbalancer.services.pools_client.Statistics":{GET_SOURCE_CACHED:[19,3,1,""],GET_SOURCE_REALTIME:[19,3,1,""],LIST_SOURCE_CACHED:[19,3,1,""],LIST_SOURCE_REALTIME:[19,3,1,""],get:[19,2,1,""],list:[19,2,1,""]},"com.vmware.nsx.loadbalancer.services.pools_client.Status":{GET_SOURCE_CACHED:[19,3,1,""],GET_SOURCE_REALTIME:[19,3,1,""],LIST_SOURCE_CACHED:[19,3,1,""],LIST_SOURCE_REALTIME:[19,3,1,""],get:[19,2,1,""],list:[19,2,1,""]},"com.vmware.nsx.loadbalancer.services.virtual_servers_client":{Statistics:[19,1,1,""],Status:[19,1,1,""],StubFactory:[19,1,1,""]},"com.vmware.nsx.loadbalancer.services.virtual_servers_client.Statistics":{GET_SOURCE_CACHED:[19,3,1,""],GET_SOURCE_REALTIME:[19,3,1,""],LIST_SOURCE_CACHED:[19,3,1,""],LIST_SOURCE_REALTIME:[19,3,1,""],get:[19,2,1,""],list:[19,2,1,""]},"com.vmware.nsx.loadbalancer.services.virtual_servers_client.Status":{GET_SOURCE_CACHED:[19,3,1,""],GET_SOURCE_REALTIME:[19,3,1,""],LIST_SOURCE_CACHED:[19,3,1,""],LIST_SOURCE_REALTIME:[19,3,1,""],get:[19,2,1,""],list:[19,2,1,""]},"com.vmware.nsx.loadbalancer.services_client":{DebugInfo:[18,1,1,""],Statistics:[18,1,1,""],Status:[18,1,1,""],StubFactory:[18,1,1,""],Usage:[18,1,1,""]},"com.vmware.nsx.loadbalancer.services_client.DebugInfo":{get:[18,2,1,""]},"com.vmware.nsx.loadbalancer.services_client.Statistics":{GET_SOURCE_CACHED:[18,3,1,""],GET_SOURCE_REALTIME:[18,3,1,""],get:[18,2,1,""]},"com.vmware.nsx.loadbalancer.services_client.Status":{GET_SOURCE_CACHED:[18,3,1,""],GET_SOURCE_REALTIME:[18,3,1,""],get:[18,2,1,""]},"com.vmware.nsx.loadbalancer.services_client.Usage":{get:[18,2,1,""]},"com.vmware.nsx.loadbalancer.ssl_client":{CiphersAndProtocols:[18,1,1,""],StubFactory:[18,1,1,""]},"com.vmware.nsx.loadbalancer.ssl_client.CiphersAndProtocols":{list:[18,2,1,""]},"com.vmware.nsx.loadbalancer_client":{ApplicationProfiles:[2,1,1,""],ClientSslProfiles:[2,1,1,""],Monitors:[2,1,1,""],PersistenceProfiles:[2,1,1,""],Pools:[2,1,1,""],Rules:[2,1,1,""],ServerSslProfiles:[2,1,1,""],Services:[2,1,1,""],StubFactory:[2,1,1,""],TcpProfiles:[2,1,1,""],VirtualServers:[2,1,1,""]},"com.vmware.nsx.loadbalancer_client.ApplicationProfiles":{"delete":[2,2,1,""],LIST_TYPE_LBFASTTCPPROFILE:[2,3,1,""],LIST_TYPE_LBFASTUDPPROFILE:[2,3,1,""],LIST_TYPE_LBHTTPPROFILE:[2,3,1,""],create:[2,2,1,""],get:[2,2,1,""],list:[2,2,1,""],update:[2,2,1,""]},"com.vmware.nsx.loadbalancer_client.ClientSslProfiles":{"delete":[2,2,1,""],create:[2,2,1,""],get:[2,2,1,""],list:[2,2,1,""],update:[2,2,1,""]},"com.vmware.nsx.loadbalancer_client.Monitors":{"delete":[2,2,1,""],LIST_TYPE_LBACTIVEMONITOR:[2,3,1,""],LIST_TYPE_LBHTTPMONITOR:[2,3,1,""],LIST_TYPE_LBHTTPSMONITOR:[2,3,1,""],LIST_TYPE_LBICMPMONITOR:[2,3,1,""],LIST_TYPE_LBPASSIVEMONITOR:[2,3,1,""],LIST_TYPE_LBTCPMONITOR:[2,3,1,""],LIST_TYPE_LBUDPMONITOR:[2,3,1,""],create:[2,2,1,""],get:[2,2,1,""],list:[2,2,1,""],update:[2,2,1,""]},"com.vmware.nsx.loadbalancer_client.PersistenceProfiles":{"delete":[2,2,1,""],LIST_TYPE_LBCOOKIEPERSISTENCEPROFILE:[2,3,1,""],LIST_TYPE_LBSOURCEIPPERSISTENCEPROFILE:[2,3,1,""],create:[2,2,1,""],get:[2,2,1,""],list:[2,2,1,""],update:[2,2,1,""]},"com.vmware.nsx.loadbalancer_client.Pools":{"delete":[2,2,1,""],CREATE_0_ACTION_ADD_MEMBERS:[2,3,1,""],CREATE_0_ACTION_REMOVE_MEMBERS:[2,3,1,""],CREATE_0_ACTION_UPDATE_MEMBERS:[2,3,1,""],create:[2,2,1,""],create_0:[2,2,1,""],get:[2,2,1,""],list:[2,2,1,""],update:[2,2,1,""]},"com.vmware.nsx.loadbalancer_client.Rules":{"delete":[2,2,1,""],create:[2,2,1,""],get:[2,2,1,""],list:[2,2,1,""],update:[2,2,1,""]},"com.vmware.nsx.loadbalancer_client.ServerSslProfiles":{"delete":[2,2,1,""],create:[2,2,1,""],get:[2,2,1,""],list:[2,2,1,""],update:[2,2,1,""]},"com.vmware.nsx.loadbalancer_client.Services":{"delete":[2,2,1,""],create:[2,2,1,""],get:[2,2,1,""],list:[2,2,1,""],update:[2,2,1,""]},"com.vmware.nsx.loadbalancer_client.TcpProfiles":{"delete":[2,2,1,""],create:[2,2,1,""],get:[2,2,1,""],list:[2,2,1,""],update:[2,2,1,""]},"com.vmware.nsx.loadbalancer_client.VirtualServers":{"delete":[2,2,1,""],create:[2,2,1,""],createwithrules:[2,2,1,""],get:[2,2,1,""],list:[2,2,1,""],update:[2,2,1,""],updatewithrules:[2,2,1,""]},"com.vmware.nsx.logical_ports_client":{ForwardingPath:[2,1,1,""],MacTable:[2,1,1,""],State:[2,1,1,""],Statistics:[2,1,1,""],Status:[2,1,1,""],StubFactory:[2,1,1,""]},"com.vmware.nsx.logical_ports_client.ForwardingPath":{get:[2,2,1,""]},"com.vmware.nsx.logical_ports_client.MacTable":{LIST_SOURCE_CACHED:[2,3,1,""],LIST_SOURCE_REALTIME:[2,3,1,""],list:[2,2,1,""]},"com.vmware.nsx.logical_ports_client.State":{get:[2,2,1,""]},"com.vmware.nsx.logical_ports_client.Statistics":{GET_SOURCE_CACHED:[2,3,1,""],GET_SOURCE_REALTIME:[2,3,1,""],get:[2,2,1,""]},"com.vmware.nsx.logical_ports_client.Status":{GETALL_ATTACHMENT_TYPE_BRIDGEENDPOINT:[2,3,1,""],GETALL_ATTACHMENT_TYPE_DHCP_SERVICE:[2,3,1,""],GETALL_ATTACHMENT_TYPE_L2VPN_SESSION:[2,3,1,""],GETALL_ATTACHMENT_TYPE_LOGICALROUTER:[2,3,1,""],GETALL_ATTACHMENT_TYPE_METADATA_PROXY:[2,3,1,""],GETALL_ATTACHMENT_TYPE_NONE:[2,3,1,""],GETALL_ATTACHMENT_TYPE_VIF:[2,3,1,""],GETALL_SOURCE_CACHED:[2,3,1,""],GETALL_SOURCE_REALTIME:[2,3,1,""],GET_SOURCE_CACHED:[2,3,1,""],GET_SOURCE_REALTIME:[2,3,1,""],get:[2,2,1,""],getall:[2,2,1,""]},"com.vmware.nsx.logical_router_ports":{statistics_client:[20,0,0,"-"]},"com.vmware.nsx.logical_router_ports.statistics_client":{StubFactory:[20,1,1,""],Summary:[20,1,1,""]},"com.vmware.nsx.logical_router_ports.statistics_client.Summary":{GET_SOURCE_CACHED:[20,3,1,""],GET_SOURCE_REALTIME:[20,3,1,""],get:[20,2,1,""]},"com.vmware.nsx.logical_router_ports_client":{ArpTable:[2,1,1,""],Statistics:[2,1,1,""],StubFactory:[2,1,1,""]},"com.vmware.nsx.logical_router_ports_client.ArpTable":{LIST_SOURCE_CACHED:[2,3,1,""],LIST_SOURCE_REALTIME:[2,3,1,""],list:[2,2,1,""]},"com.vmware.nsx.logical_router_ports_client.Statistics":{GET_SOURCE_CACHED:[2,3,1,""],GET_SOURCE_REALTIME:[2,3,1,""],get:[2,2,1,""]},"com.vmware.nsx.logical_routers":{nat:[22,0,0,"-"],nat_client:[21,0,0,"-"],routing:[23,0,0,"-"],routing_client:[21,0,0,"-"]},"com.vmware.nsx.logical_routers.nat":{rules_client:[22,0,0,"-"]},"com.vmware.nsx.logical_routers.nat.rules_client":{Statistics:[22,1,1,""],StubFactory:[22,1,1,""]},"com.vmware.nsx.logical_routers.nat.rules_client.Statistics":{GETPERLOGICALROUTER_SOURCE_CACHED:[22,3,1,""],GETPERLOGICALROUTER_SOURCE_REALTIME:[22,3,1,""],GETPERRULE_SOURCE_CACHED:[22,3,1,""],GETPERRULE_SOURCE_REALTIME:[22,3,1,""],getperlogicalrouter:[22,2,1,""],getperrule:[22,2,1,""]},"com.vmware.nsx.logical_routers.nat_client":{Rules:[21,1,1,""],StubFactory:[21,1,1,""]},"com.vmware.nsx.logical_routers.nat_client.Rules":{"delete":[21,2,1,""],create:[21,2,1,""],get:[21,2,1,""],list:[21,2,1,""],update:[21,2,1,""]},"com.vmware.nsx.logical_routers.routing":{advertisement_client:[23,0,0,"-"],bgp:[24,0,0,"-"],bgp_client:[23,0,0,"-"],redistribution_client:[23,0,0,"-"],static_routes_client:[23,0,0,"-"]},"com.vmware.nsx.logical_routers.routing.advertisement_client":{Rules:[23,1,1,""],StubFactory:[23,1,1,""]},"com.vmware.nsx.logical_routers.routing.advertisement_client.Rules":{get:[23,2,1,""],update:[23,2,1,""]},"com.vmware.nsx.logical_routers.routing.bgp":{neighbors_client:[24,0,0,"-"]},"com.vmware.nsx.logical_routers.routing.bgp.neighbors_client":{Status:[24,1,1,""],StubFactory:[24,1,1,""]},"com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.Status":{LIST_SOURCE_CACHED:[24,3,1,""],LIST_SOURCE_REALTIME:[24,3,1,""],list:[24,2,1,""]},"com.vmware.nsx.logical_routers.routing.bgp_client":{CommunityLists:[23,1,1,""],CommuntyLists:[23,1,1,""],Neighbors:[23,1,1,""],StubFactory:[23,1,1,""]},"com.vmware.nsx.logical_routers.routing.bgp_client.CommunityLists":{"delete":[23,2,1,""],create:[23,2,1,""],get:[23,2,1,""],list:[23,2,1,""]},"com.vmware.nsx.logical_routers.routing.bgp_client.CommuntyLists":{update:[23,2,1,""]},"com.vmware.nsx.logical_routers.routing.bgp_client.Neighbors":{"delete":[23,2,1,""],UNSETPASSWORD_ACTION_PASSWORD:[23,3,1,""],create:[23,2,1,""],get:[23,2,1,""],list:[23,2,1,""],showsensitivedata:[23,2,1,""],unsetpassword:[23,2,1,""],update:[23,2,1,""]},"com.vmware.nsx.logical_routers.routing.redistribution_client":{Rules:[23,1,1,""],StubFactory:[23,1,1,""]},"com.vmware.nsx.logical_routers.routing.redistribution_client.Rules":{get:[23,2,1,""],update:[23,2,1,""]},"com.vmware.nsx.logical_routers.routing.static_routes_client":{BfdPeers:[23,1,1,""],StubFactory:[23,1,1,""]},"com.vmware.nsx.logical_routers.routing.static_routes_client.BfdPeers":{"delete":[23,2,1,""],create:[23,2,1,""],get:[23,2,1,""],list:[23,2,1,""],update:[23,2,1,""]},"com.vmware.nsx.logical_routers.routing_client":{Advertisement:[21,1,1,""],BfdConfig:[21,1,1,""],Bgp:[21,1,1,""],ForwardingTable:[21,1,1,""],IpPrefixLists:[21,1,1,""],Redistribution:[21,1,1,""],RouteMaps:[21,1,1,""],RouteTable:[21,1,1,""],RoutingTable:[21,1,1,""],StaticRoutes:[21,1,1,""],StubFactory:[21,1,1,""]},"com.vmware.nsx.logical_routers.routing_client.Advertisement":{get:[21,2,1,""],update:[21,2,1,""]},"com.vmware.nsx.logical_routers.routing_client.BfdConfig":{get:[21,2,1,""],update:[21,2,1,""]},"com.vmware.nsx.logical_routers.routing_client.Bgp":{get:[21,2,1,""],update:[21,2,1,""]},"com.vmware.nsx.logical_routers.routing_client.ForwardingTable":{LIST_SOURCE_CACHED:[21,3,1,""],LIST_SOURCE_REALTIME:[21,3,1,""],list:[21,2,1,""]},"com.vmware.nsx.logical_routers.routing_client.IpPrefixLists":{"delete":[21,2,1,""],create:[21,2,1,""],get:[21,2,1,""],list:[21,2,1,""],update:[21,2,1,""]},"com.vmware.nsx.logical_routers.routing_client.Redistribution":{get:[21,2,1,""],update:[21,2,1,""]},"com.vmware.nsx.logical_routers.routing_client.RouteMaps":{"delete":[21,2,1,""],create:[21,2,1,""],get:[21,2,1,""],list:[21,2,1,""],update:[21,2,1,""]},"com.vmware.nsx.logical_routers.routing_client.RouteTable":{LIST_SOURCE_CACHED:[21,3,1,""],LIST_SOURCE_REALTIME:[21,3,1,""],list:[21,2,1,""]},"com.vmware.nsx.logical_routers.routing_client.RoutingTable":{LIST_ROUTE_SOURCE_BGP:[21,3,1,""],LIST_ROUTE_SOURCE_CONNECTED:[21,3,1,""],LIST_ROUTE_SOURCE_STATIC:[21,3,1,""],LIST_SOURCE_CACHED:[21,3,1,""],LIST_SOURCE_REALTIME:[21,3,1,""],list:[21,2,1,""]},"com.vmware.nsx.logical_routers.routing_client.StaticRoutes":{"delete":[21,2,1,""],create:[21,2,1,""],get:[21,2,1,""],list:[21,2,1,""],update:[21,2,1,""]},"com.vmware.nsx.logical_routers_client":{Routing:[2,1,1,""],Status:[2,1,1,""],StubFactory:[2,1,1,""]},"com.vmware.nsx.logical_routers_client.Routing":{get:[2,2,1,""],update:[2,2,1,""]},"com.vmware.nsx.logical_routers_client.Status":{GET_SOURCE_CACHED:[2,3,1,""],GET_SOURCE_REALTIME:[2,3,1,""],get:[2,2,1,""]},"com.vmware.nsx.logical_switches_client":{MacTable:[2,1,1,""],State:[2,1,1,""],Statistics:[2,1,1,""],Status:[2,1,1,""],StubFactory:[2,1,1,""],Summary:[2,1,1,""],VtepTable:[2,1,1,""]},"com.vmware.nsx.logical_switches_client.MacTable":{LIST_SOURCE_CACHED:[2,3,1,""],LIST_SOURCE_REALTIME:[2,3,1,""],list:[2,2,1,""]},"com.vmware.nsx.logical_switches_client.State":{LIST_STATUS_IN_PROGRESS:[2,3,1,""],LIST_STATUS_PARTIAL_SUCCESS:[2,3,1,""],LIST_STATUS_PENDING:[2,3,1,""],LIST_STATUS_SUCCESS:[2,3,1,""],get:[2,2,1,""],list:[2,2,1,""]},"com.vmware.nsx.logical_switches_client.Statistics":{GET_SOURCE_CACHED:[2,3,1,""],GET_SOURCE_REALTIME:[2,3,1,""],get:[2,2,1,""]},"com.vmware.nsx.logical_switches_client.Status":{GET_SOURCE_CACHED:[2,3,1,""],GET_SOURCE_REALTIME:[2,3,1,""],GET_TRANSPORT_TYPE_OVERLAY:[2,3,1,""],GET_TRANSPORT_TYPE_VLAN:[2,3,1,""],get:[2,2,1,""]},"com.vmware.nsx.logical_switches_client.Summary":{get:[2,2,1,""]},"com.vmware.nsx.logical_switches_client.VtepTable":{LIST_SOURCE_CACHED:[2,3,1,""],LIST_SOURCE_REALTIME:[2,3,1,""],list:[2,2,1,""]},"com.vmware.nsx.mac_sets_client":{Members:[2,1,1,""],StubFactory:[2,1,1,""]},"com.vmware.nsx.mac_sets_client.Members":{"delete":[2,2,1,""],create:[2,2,1,""],list:[2,2,1,""]},"com.vmware.nsx.md_proxies_client":{Statistics:[2,1,1,""],Status:[2,1,1,""],StubFactory:[2,1,1,""]},"com.vmware.nsx.md_proxies_client.Statistics":{GET_SOURCE_CACHED:[2,3,1,""],GET_SOURCE_REALTIME:[2,3,1,""],get:[2,2,1,""]},"com.vmware.nsx.md_proxies_client.Status":{get:[2,2,1,""]},"com.vmware.nsx.migration":{bundles_client:[25,0,0,"-"],migration_unit_groups_client:[25,0,0,"-"],migration_units_client:[25,0,0,"-"],plan_client:[25,0,0,"-"]},"com.vmware.nsx.migration.bundles_client":{StubFactory:[25,1,1,""],UploadStatus:[25,1,1,""]},"com.vmware.nsx.migration.bundles_client.UploadStatus":{get:[25,2,1,""]},"com.vmware.nsx.migration.migration_unit_groups_client":{AggregateInfo:[25,1,1,""],MigrationUnit:[25,1,1,""],Status:[25,1,1,""],StubFactory:[25,1,1,""]},"com.vmware.nsx.migration.migration_unit_groups_client.AggregateInfo":{list:[25,2,1,""]},"com.vmware.nsx.migration.migration_unit_groups_client.MigrationUnit":{reorder:[25,2,1,""]},"com.vmware.nsx.migration.migration_unit_groups_client.Status":{list:[25,2,1,""]},"com.vmware.nsx.migration.migration_units_client":{AggregateInfo:[25,1,1,""],StubFactory:[25,1,1,""]},"com.vmware.nsx.migration.migration_units_client.AggregateInfo":{LIST_SELECTION_STATUS_ALL:[25,3,1,""],LIST_SELECTION_STATUS_DESELECTED:[25,3,1,""],LIST_SELECTION_STATUS_SELECTED:[25,3,1,""],list:[25,2,1,""]},"com.vmware.nsx.migration.plan_client":{Settings:[25,1,1,""],StubFactory:[25,1,1,""]},"com.vmware.nsx.migration.plan_client.Settings":{get:[25,2,1,""],update:[25,2,1,""]},"com.vmware.nsx.migration_client":{Bundles:[2,1,1,""],FeedbackRequests:[2,1,1,""],FeedbackResponse:[2,1,1,""],MigrationUnitGroups:[2,1,1,""],MigrationUnitGroupsStatus:[2,1,1,""],MigrationUnits:[2,1,1,""],MigrationUnitsStats:[2,1,1,""],Nodes:[2,1,1,""],NodesSummary:[2,1,1,""],Plan:[2,1,1,""],Setup:[2,1,1,""],StatusSummary:[2,1,1,""],StubFactory:[2,1,1,""],Summary:[2,1,1,""]},"com.vmware.nsx.migration_client.Bundles":{create:[2,2,1,""],get:[2,2,1,""]},"com.vmware.nsx.migration_client.FeedbackRequests":{list:[2,2,1,""]},"com.vmware.nsx.migration_client.FeedbackResponse":{update:[2,2,1,""]},"com.vmware.nsx.migration_client.MigrationUnitGroups":{"delete":[2,2,1,""],addmigrationunits:[2,2,1,""],create:[2,2,1,""],get:[2,2,1,""],list:[2,2,1,""],reorder:[2,2,1,""],update:[2,2,1,""]},"com.vmware.nsx.migration_client.MigrationUnitGroupsStatus":{getall:[2,2,1,""]},"com.vmware.nsx.migration_client.MigrationUnits":{get:[2,2,1,""],list:[2,2,1,""]},"com.vmware.nsx.migration_client.MigrationUnitsStats":{get:[2,2,1,""]},"com.vmware.nsx.migration_client.Nodes":{list:[2,2,1,""]},"com.vmware.nsx.migration_client.NodesSummary":{get:[2,2,1,""]},"com.vmware.nsx.migration_client.Plan":{continue_:[2,2,1,""],pause:[2,2,1,""],reset:[2,2,1,""],rollback:[2,2,1,""],start:[2,2,1,""]},"com.vmware.nsx.migration_client.Setup":{get:[2,2,1,""],update:[2,2,1,""]},"com.vmware.nsx.migration_client.StatusSummary":{get:[2,2,1,""]},"com.vmware.nsx.migration_client.Summary":{get:[2,2,1,""]},"com.vmware.nsx.model_client":{ALGTypeNSService:[2,1,1,""],AcceptableComponentVersion:[2,1,1,""],AcceptableComponentVersionList:[2,1,1,""],ActionableResource:[2,1,1,""],ActionableResourceListResult:[2,1,1,""],AddClusterNodeSpec:[2,1,1,""],AddClusterNodeVMInfo:[2,1,1,""],AddControllerNodeSpec:[2,1,1,""],AddManagementNodeSpec:[2,1,1,""],AddressBindingEntry:[2,1,1,""],AdvanceClusterRestoreInput:[2,1,1,""],AdvanceClusterRestoreRequest:[2,1,1,""],AdvertiseRule:[2,1,1,""],AdvertiseRuleList:[2,1,1,""],AdvertisedNetwork:[2,1,1,""],AdvertisedNetworksListResult:[2,1,1,""],AdvertisementConfig:[2,1,1,""],AdvertisementRuleFilter:[2,1,1,""],AggregateDataResponse:[2,1,1,""],AggregateRequest:[2,1,1,""],AggregateResponse:[2,1,1,""],AggregatedDataCounter:[2,1,1,""],AggregatedDataCounterEx:[2,1,1,""],AggregatedLogicalRouterPortCounters:[2,1,1,""],Alarm:[2,1,1,""],AlarmListResult:[2,1,1,""],AlarmSource:[2,1,1,""],AllClusterGroupStatus:[2,1,1,""],AllocationIpAddress:[2,1,1,""],AllocationIpAddressListResult:[2,1,1,""],ApiError:[2,1,1,""],AppDiscoveryAppProfileResultSummary:[2,1,1,""],AppDiscoverySession:[2,1,1,""],AppDiscoverySessionResultSummary:[2,1,1,""],AppDiscoverySessionsListResult:[2,1,1,""],AppDiscoveryVmInfo:[2,1,1,""],AppDiscoveryVmInfoListResult:[2,1,1,""],AppInfo:[2,1,1,""],AppInfoHostVmCsvRecord:[2,1,1,""],AppInfoHostVmListInCsvFormat:[2,1,1,""],AppInfoListResult:[2,1,1,""],AppProfile:[2,1,1,""],AppProfileListResult:[2,1,1,""],AppProfileMemberAppsCsvRecord:[2,1,1,""],AppProfileMemberAppsListInCsvFormat:[2,1,1,""],AppProfileMetaInfo:[2,1,1,""],ApplianceManagementTaskListResult:[2,1,1,""],ApplianceManagementTaskProperties:[2,1,1,""],AppliedTos:[2,1,1,""],AssignedByDhcp:[2,1,1,""],AssociationListResult:[2,1,1,""],AttachmentContext:[2,1,1,""],Attribute:[2,1,1,""],AuditLog:[2,1,1,""],AuditLogListResult:[2,1,1,""],AuditLogRequest:[2,1,1,""],AuthenticationPolicyProperties:[2,1,1,""],AuthenticationScheme:[2,1,1,""],BFDDiagnosticCount:[2,1,1,""],BFDProperties:[2,1,1,""],BFDStatusCount:[2,1,1,""],BGPCommunityList:[2,1,1,""],BGPCommunityListListResult:[2,1,1,""],BackupConfiguration:[2,1,1,""],BackupOperationHistory:[2,1,1,""],BackupOperationStatus:[2,1,1,""],BackupSchedule:[2,1,1,""],BaseHostSwitchProfile:[2,1,1,""],BaseNodeAggregateInfo:[2,1,1,""],BaseServiceInstance:[2,1,1,""],BaseSwitchingProfile:[2,1,1,""],BasicAuthenticationScheme:[2,1,1,""],BatchRequest:[2,1,1,""],BatchRequestItem:[2,1,1,""],BatchResponse:[2,1,1,""],BatchResponseItem:[2,1,1,""],BfdConfig:[2,1,1,""],BfdConfigParameters:[2,1,1,""],BfdHealthMonitoringProfile:[2,1,1,""],BgpConfig:[2,1,1,""],BgpNeighbor:[2,1,1,""],BgpNeighborAddressFamily:[2,1,1,""],BgpNeighborListResult:[2,1,1,""],BgpNeighborStatus:[2,1,1,""],BgpNeighborsStatusListResult:[2,1,1,""],BgpRouteAggregation:[2,1,1,""],BinaryPacketData:[2,1,1,""],BpduFilter:[2,1,1,""],BridgeCluster:[2,1,1,""],BridgeClusterListResult:[2,1,1,""],BridgeClusterNode:[2,1,1,""],BridgeClusterStatus:[2,1,1,""],BridgeEndpoint:[2,1,1,""],BridgeEndpointListResult:[2,1,1,""],BridgeEndpointProfile:[2,1,1,""],BridgeEndpointProfileListResult:[2,1,1,""],BridgeEndpointStatistics:[2,1,1,""],BridgeEndpointStatus:[2,1,1,""],BridgeHighAvailabilityClusterProfile:[2,1,1,""],ByodServiceInstance:[2,1,1,""],CCPUpgradeStatus:[2,1,1,""],CapacityUsage:[2,1,1,""],Certificate:[2,1,1,""],CertificateList:[2,1,1,""],CipherSuite:[2,1,1,""],ClasslessStaticRoute:[2,1,1,""],ClientSslProfileBinding:[2,1,1,""],ClientTypeCollectionConfiguration:[2,1,1,""],ClusterBackupInfo:[2,1,1,""],ClusterBackupInfoListResult:[2,1,1,""],ClusterConfig:[2,1,1,""],ClusterGroupMemberStatus:[2,1,1,""],ClusterGroupServiceLeader:[2,1,1,""],ClusterGroupStatus:[2,1,1,""],ClusterInitializationNodeInfo:[2,1,1,""],ClusterNodeConfig:[2,1,1,""],ClusterNodeConfigListResult:[2,1,1,""],ClusterNodeStatus:[2,1,1,""],ClusterNodeVMDeploymentConfig:[2,1,1,""],ClusterNodeVMDeploymentRequest:[2,1,1,""],ClusterNodeVMDeploymentRequestList:[2,1,1,""],ClusterNodeVMDeploymentStatusReport:[2,1,1,""],ClusterProfile:[2,1,1,""],ClusterProfileListResult:[2,1,1,""],ClusterProfileTypeIdEntry:[2,1,1,""],ClusterRestoreStatus:[2,1,1,""],ClusterRoleConfig:[2,1,1,""],ClusterStatus:[2,1,1,""],ClusteringConfig:[2,1,1,""],ClusteringInfo:[2,1,1,""],ClustersAggregateInfo:[2,1,1,""],ColumnItem:[2,1,1,""],CommunityMatchExpression:[2,1,1,""],CommunityMatchOperation:[2,1,1,""],ComponentMigrationStatus:[2,1,1,""],ComponentTargetVersion:[2,1,1,""],ComponentUpgradeStatus:[2,1,1,""],ComputeCollection:[2,1,1,""],ComputeCollectionFabricTemplate:[2,1,1,""],ComputeCollectionFabricTemplateListResult:[2,1,1,""],ComputeCollectionListResult:[2,1,1,""],ComputeCollectionNetworkInterfacesListResult:[2,1,1,""],ComputeCollectionTransportNodeTemplate:[2,1,1,""],ComputeCollectionTransportNodeTemplateState:[2,1,1,""],ComputeCollectionTransportNodeTemplateStateList:[2,1,1,""],ComputeManager:[2,1,1,""],ComputeManagerListResult:[2,1,1,""],ComputeManagerStatus:[2,1,1,""],ConditionalForwarderZone:[2,1,1,""],ConfigurationState:[2,1,1,""],ConfigurationStateElement:[2,1,1,""],ContainerConfiguration:[2,1,1,""],ControlClusterNodeStatus:[2,1,1,""],ControlClusteringConfig:[2,1,1,""],ControlConnStatus:[2,1,1,""],ControllerClusterRoleConfig:[2,1,1,""],ControllerClusterStatus:[2,1,1,""],ControllerNodeAggregateInfo:[2,1,1,""],CopyFromRemoteFileProperties:[2,1,1,""],CopyRemoteFileProperties:[2,1,1,""],CopyToRemoteFileProperties:[2,1,1,""],CpuCoreConfigForEnhancedNetworkingStackSwitch:[2,1,1,""],CreateRemoteDirectoryProperties:[2,1,1,""],Crl:[2,1,1,""],CrlList:[2,1,1,""],CrlObjectData:[2,1,1,""],CryptoAlgorithm:[2,1,1,""],Csr:[2,1,1,""],CsrList:[2,1,1,""],CsvListResult:[2,1,1,""],CsvRecord:[2,1,1,""],CurrentBackupOperationStatus:[2,1,1,""],CurrentRealizationStateBarrier:[2,1,1,""],DSInsertParameters:[2,1,1,""],DSRule:[2,1,1,""],DSRuleState:[2,1,1,""],DSSection:[2,1,1,""],DSSectionListResult:[2,1,1,""],DSSectionQueryParameters:[2,1,1,""],DSSectionState:[2,1,1,""],DSService:[2,1,1,""],DailyTelemetrySchedule:[2,1,1,""],DataCounter:[2,1,1,""],DataTypeCollectionConfiguration:[2,1,1,""],Datasource:[2,1,1,""],DeploymentConfig:[2,1,1,""],DeploymentSpec:[2,1,1,""],DeploymentTemplate:[2,1,1,""],DestinationFilteringConfiguration:[2,1,1,""],DestinationNsxApiEndpoint:[2,1,1,""],DhcpFilter:[2,1,1,""],DhcpHeader:[2,1,1,""],DhcpIpPool:[2,1,1,""],DhcpIpPoolListResult:[2,1,1,""],DhcpIpPoolUsage:[2,1,1,""],DhcpLeasePerIP:[2,1,1,""],DhcpLeases:[2,1,1,""],DhcpOption121:[2,1,1,""],DhcpOptions:[2,1,1,""],DhcpProfile:[2,1,1,""],DhcpProfileListResult:[2,1,1,""],DhcpRelayProfile:[2,1,1,""],DhcpRelayProfileListResult:[2,1,1,""],DhcpRelayService:[2,1,1,""],DhcpRelayServiceListResult:[2,1,1,""],DhcpServerStatus:[2,1,1,""],DhcpStaticBinding:[2,1,1,""],DhcpStaticBindingListResult:[2,1,1,""],DhcpStatistics:[2,1,1,""],DirectoryAdDomain:[2,1,1,""],DirectoryAdGroup:[2,1,1,""],DirectoryDomain:[2,1,1,""],DirectoryDomainListResults:[2,1,1,""],DirectoryDomainSyncNode:[2,1,1,""],DirectoryDomainSyncNodeListResults:[2,1,1,""],DirectoryDomainSyncRemoteNodes:[2,1,1,""],DirectoryDomainSyncSettings:[2,1,1,""],DirectoryDomainSyncStats:[2,1,1,""],DirectoryGroup:[2,1,1,""],DirectoryGroupListResults:[2,1,1,""],DirectoryGroupMember:[2,1,1,""],DirectoryGroupMemberListResults:[2,1,1,""],DirectoryLdapServer:[2,1,1,""],DirectoryLdapServerListResults:[2,1,1,""],DiscoveredNode:[2,1,1,""],DiscoveredNodeInterfaceProperties:[2,1,1,""],DiscoveredNodeListResult:[2,1,1,""],DiscoveredNodeNetworkInterfaces:[2,1,1,""],DiscoveredResource:[2,1,1,""],DnsAnswer:[2,1,1,""],DnsForwarder:[2,1,1,""],DnsForwarderListResult:[2,1,1,""],DnsHeader:[2,1,1,""],DnsQueryAnswer:[2,1,1,""],DonutConfiguration:[2,1,1,""],DonutPart:[2,1,1,""],DonutSection:[2,1,1,""],Dscp:[2,1,1,""],EULAAcceptance:[2,1,1,""],EULAContent:[2,1,1,""],EdgeCluster:[2,1,1,""],EdgeClusterListResult:[2,1,1,""],EdgeClusterMember:[2,1,1,""],EdgeClusterMemberAllocationPool:[2,1,1,""],EdgeClusterMemberAllocationProfile:[2,1,1,""],EdgeClusterMemberListResult:[2,1,1,""],EdgeClusterMemberTransportNode:[2,1,1,""],EdgeHighAvailabilityProfile:[2,1,1,""],EdgeNode:[2,1,1,""],EdgeNodeDeploymentConfig:[2,1,1,""],EdgeUpgradeStatus:[2,1,1,""],EffectiveIPAddressMemberListResult:[2,1,1,""],EffectiveMemberResourceListResult:[2,1,1,""],EffectiveMemberTypeListResult:[2,1,1,""],EgressRateShaper:[2,1,1,""],EmbeddedResource:[2,1,1,""],Endpoint:[2,1,1,""],ErrorInfo:[2,1,1,""],ErrorResolverInfo:[2,1,1,""],ErrorResolverInfoList:[2,1,1,""],ErrorResolverMetadata:[2,1,1,""],ErrorResolverMetadataList:[2,1,1,""],ErrorResolverSystemMetadata:[2,1,1,""],ErrorResolverUserInputData:[2,1,1,""],ErrorResolverUserMetadata:[2,1,1,""],EtherTypeNSService:[2,1,1,""],EthernetHeader:[2,1,1,""],ExcludeList:[2,1,1,""],ExtraConfig:[2,1,1,""],ExtraConfigHostSwitchProfile:[2,1,1,""],FabricModule:[2,1,1,""],FabricModuleListResult:[2,1,1,""],FailedNodeSupportBundleResult:[2,1,1,""],FeatureAccess:[2,1,1,""],FeatureAccessListResult:[2,1,1,""],FeatureInfo:[2,1,1,""],FeaturePermission:[2,1,1,""],FeaturePermissionListResult:[2,1,1,""],FeatureStackCollectionConfiguration:[2,1,1,""],FeatureStackCollectionConfigurationList:[2,1,1,""],FeatureUsage:[2,1,1,""],FeatureUsageCsvRecord:[2,1,1,""],FeatureUsageList:[2,1,1,""],FeatureUsageListInCsvFormat:[2,1,1,""],FieldsPacketData:[2,1,1,""],FileHash:[2,1,1,""],FileProperties:[2,1,1,""],FilePropertiesListResult:[2,1,1,""],FileThumbprint:[2,1,1,""],FileTransferAuthenticationScheme:[2,1,1,""],FileTransferProtocol:[2,1,1,""],Filter:[2,1,1,""],FilterRequest:[2,1,1,""],FireWallServiceAssociationListResult:[2,1,1,""],FirewallRule:[2,1,1,""],FirewallRuleList:[2,1,1,""],FirewallRuleListResult:[2,1,1,""],FirewallSection:[2,1,1,""],FirewallSectionListResult:[2,1,1,""],FirewallSectionLock:[2,1,1,""],FirewallSectionRuleList:[2,1,1,""],FirewallSectionState:[2,1,1,""],FirewallSectionsSummary:[2,1,1,""],FirewallSectionsSummaryList:[2,1,1,""],FirewallService:[2,1,1,""],FirewallStats:[2,1,1,""],FirewallStatsList:[2,1,1,""],FirewallStatus:[2,1,1,""],FirewallStatusListResult:[2,1,1,""],Footer:[2,1,1,""],FooterAction:[2,1,1,""],ForwarderZone:[2,1,1,""],GenericDhcpOption:[2,1,1,""],GlobalCollectionConfiguration:[2,1,1,""],GlobalRestoreStatus:[2,1,1,""],GridConfiguration:[2,1,1,""],HaVipConfig:[2,1,1,""],HeatMapTransportNodesAggregateStatus:[2,1,1,""],HeatMapTransportZoneStatus:[2,1,1,""],HostAggregateInfo:[2,1,1,""],HostAggregateInfoListResult:[2,1,1,""],HostInfraTrafficType:[2,1,1,""],HostNode:[2,1,1,""],HostNodeLoginCredential:[2,1,1,""],HostProfileNetworkMigrationSpec:[2,1,1,""],HostSwitch:[2,1,1,""],HostSwitchProfileTypeIdEntry:[2,1,1,""],HostSwitchProfilesListResult:[2,1,1,""],HostSwitchSpec:[2,1,1,""],HostSwitchState:[2,1,1,""],HostUpgradeStatus:[2,1,1,""],HttpProtocol:[2,1,1,""],HttpServiceProperties:[2,1,1,""],HttpsProtocol:[2,1,1,""],ICMPTypeNSService:[2,1,1,""],IGMPTypeNSService:[2,1,1,""],IPInfo:[2,1,1,""],IPMirrorDestination:[2,1,1,""],IPPrefixList:[2,1,1,""],IPPrefixListListResult:[2,1,1,""],IPProtocolNSService:[2,1,1,""],IPSecVPNDPDProfile:[2,1,1,""],IPSecVPNDPDProfileListResult:[2,1,1,""],IPSecVPNIKEProfile:[2,1,1,""],IPSecVPNIKEProfileListResult:[2,1,1,""],IPSecVPNIKEServiceSummary:[2,1,1,""],IPSecVPNIKESessionStatus:[2,1,1,""],IPSecVPNIKETrafficStatistics:[2,1,1,""],IPSecVPNLocalEndpoint:[2,1,1,""],IPSecVPNLocalEndpointListResult:[2,1,1,""],IPSecVPNPeerEndpoint:[2,1,1,""],IPSecVPNPeerEndpointListResult:[2,1,1,""],IPSecVPNPolicyRule:[2,1,1,""],IPSecVPNPolicySubnet:[2,1,1,""],IPSecVPNPolicyTrafficStatistics:[2,1,1,""],IPSecVPNService:[2,1,1,""],IPSecVPNServiceListResult:[2,1,1,""],IPSecVPNSession:[2,1,1,""],IPSecVPNSessionListResult:[2,1,1,""],IPSecVPNSessionStatistics:[2,1,1,""],IPSecVPNSessionStatus:[2,1,1,""],IPSecVPNSessionSummary:[2,1,1,""],IPSecVPNSessionTrafficSummary:[2,1,1,""],IPSecVPNTrafficCounters:[2,1,1,""],IPSecVPNTransportStatus:[2,1,1,""],IPSecVPNTunnelProfile:[2,1,1,""],IPSecVPNTunnelProfileListResult:[2,1,1,""],IPSecVPNTunnelTrafficStatistics:[2,1,1,""],IPSet:[2,1,1,""],IPSetListResult:[2,1,1,""],IPSubnet:[2,1,1,""],IPsecVPNIKESessionSummary:[2,1,1,""],IPv4AddressProperties:[2,1,1,""],IPv4DhcpServer:[2,1,1,""],IcmpEchoRequestHeader:[2,1,1,""],Icon:[2,1,1,""],IncludedFieldsParameters:[2,1,1,""],IngressBroadcastRateShaper:[2,1,1,""],IngressRateShaper:[2,1,1,""],InitiateClusterRestoreRequest:[2,1,1,""],InstallUpgradeServiceProperties:[2,1,1,""],InstanceDeploymentConfig:[2,1,1,""],InstanceEndpoint:[2,1,1,""],InstanceEndpointListResult:[2,1,1,""],InstanceRuntime:[2,1,1,""],InstanceRuntimeListResult:[2,1,1,""],InstructionInfo:[2,1,1,""],InterfaceNeighborProperties:[2,1,1,""],InterfaceNeighborPropertyListResult:[2,1,1,""],InterfaceStatistics:[2,1,1,""],IntervalBackupSchedule:[2,1,1,""],InventoryConfig:[2,1,1,""],IpAddressInfo:[2,1,1,""],IpAllocationBase:[2,1,1,""],IpAssignmentSpec:[2,1,1,""],IpBlock:[2,1,1,""],IpBlockListResult:[2,1,1,""],IpBlockSubnet:[2,1,1,""],IpBlockSubnetListResult:[2,1,1,""],IpDiscoverySwitchingProfile:[2,1,1,""],IpMacPair:[2,1,1,""],IpPool:[2,1,1,""],IpPoolListResult:[2,1,1,""],IpPoolRange:[2,1,1,""],IpPoolSubnet:[2,1,1,""],IpfixCollector:[2,1,1,""],IpfixCollectorConfig:[2,1,1,""],IpfixCollectorConfigListResult:[2,1,1,""],IpfixCollectorUpmProfile:[2,1,1,""],IpfixCollectorUpmProfileListResult:[2,1,1,""],IpfixConfig:[2,1,1,""],IpfixConfigListResult:[2,1,1,""],IpfixDfwConfig:[2,1,1,""],IpfixDfwTemplateParameters:[2,1,1,""],IpfixObsPointConfig:[2,1,1,""],IpfixObsPointsListResult:[2,1,1,""],IpfixServiceAssociationListResult:[2,1,1,""],IpfixSwitchConfig:[2,1,1,""],IpfixSwitchUpmProfile:[2,1,1,""],IpfixUpmProfile:[2,1,1,""],IpfixUpmProfileListResult:[2,1,1,""],Ipv4Header:[2,1,1,""],KeyValue:[2,1,1,""],KeyValuePair:[2,1,1,""],KnownHostParameter:[2,1,1,""],L2VPNPerLSTrafficStatistics:[2,1,1,""],L2VPNSessionRemoteMacs:[2,1,1,""],L2VPNSessionRemoteMacsForLS:[2,1,1,""],L2VPNSessionStatistics:[2,1,1,""],L2VPNSessionStatus:[2,1,1,""],L2VPNSessionSummary:[2,1,1,""],L2VPNTapTrafficStatistics:[2,1,1,""],L2VPNTransportTunnelStatus:[2,1,1,""],L2VpnAttachmentContext:[2,1,1,""],L2VpnService:[2,1,1,""],L2VpnServiceListResult:[2,1,1,""],L2VpnSession:[2,1,1,""],L2VpnSessionListResult:[2,1,1,""],L2VpnSessionPeerCodes:[2,1,1,""],L2VpnTunnelEncapsulation:[2,1,1,""],L2VpnTunnelPeerCode:[2,1,1,""],L4PortSetNSService:[2,1,1,""],Label:[2,1,1,""],LabelValueConfiguration:[2,1,1,""],Lag:[2,1,1,""],LbActiveMonitor:[2,1,1,""],LbAppProfile:[2,1,1,""],LbAppProfileListResult:[2,1,1,""],LbClientCertificateIssuerDnCondition:[2,1,1,""],LbClientCertificateSubjectDnCondition:[2,1,1,""],LbClientSslProfile:[2,1,1,""],LbClientSslProfileListResult:[2,1,1,""],LbCookiePersistenceProfile:[2,1,1,""],LbCookieTime:[2,1,1,""],LbFastTcpProfile:[2,1,1,""],LbFastUdpProfile:[2,1,1,""],LbHttpMonitor:[2,1,1,""],LbHttpProfile:[2,1,1,""],LbHttpRedirectAction:[2,1,1,""],LbHttpRejectAction:[2,1,1,""],LbHttpRequestBodyCondition:[2,1,1,""],LbHttpRequestCookieCondition:[2,1,1,""],LbHttpRequestHeader:[2,1,1,""],LbHttpRequestHeaderCondition:[2,1,1,""],LbHttpRequestHeaderDeleteAction:[2,1,1,""],LbHttpRequestHeaderRewriteAction:[2,1,1,""],LbHttpRequestMethodCondition:[2,1,1,""],LbHttpRequestUriArgumentsCondition:[2,1,1,""],LbHttpRequestUriCondition:[2,1,1,""],LbHttpRequestUriRewriteAction:[2,1,1,""],LbHttpRequestVersionCondition:[2,1,1,""],LbHttpResponseHeaderCondition:[2,1,1,""],LbHttpResponseHeaderDeleteAction:[2,1,1,""],LbHttpResponseHeaderRewriteAction:[2,1,1,""],LbHttpSslCondition:[2,1,1,""],LbHttpsMonitor:[2,1,1,""],LbIcmpMonitor:[2,1,1,""],LbIpHeaderCondition:[2,1,1,""],LbMonitor:[2,1,1,""],LbMonitorListResult:[2,1,1,""],LbPassiveMonitor:[2,1,1,""],LbPersistenceCookieTime:[2,1,1,""],LbPersistenceProfile:[2,1,1,""],LbPersistenceProfileListResult:[2,1,1,""],LbPool:[2,1,1,""],LbPoolListResult:[2,1,1,""],LbPoolMemberStatistics:[2,1,1,""],LbPoolMemberStatus:[2,1,1,""],LbPoolStatistics:[2,1,1,""],LbPoolStatisticsListResult:[2,1,1,""],LbPoolStatus:[2,1,1,""],LbPoolStatusListResult:[2,1,1,""],LbRule:[2,1,1,""],LbRuleAction:[2,1,1,""],LbRuleCondition:[2,1,1,""],LbRuleListResult:[2,1,1,""],LbSelectPoolAction:[2,1,1,""],LbServerSslProfile:[2,1,1,""],LbServerSslProfileListResult:[2,1,1,""],LbService:[2,1,1,""],LbServiceDebugInfo:[2,1,1,""],LbServiceListResult:[2,1,1,""],LbServiceStatistics:[2,1,1,""],LbServiceStatisticsCounter:[2,1,1,""],LbServiceStatus:[2,1,1,""],LbServiceUsage:[2,1,1,""],LbSessionCookieTime:[2,1,1,""],LbSnatAutoMap:[2,1,1,""],LbSnatIpElement:[2,1,1,""],LbSnatIpPool:[2,1,1,""],LbSnatTranslation:[2,1,1,""],LbSourceIpPersistenceProfile:[2,1,1,""],LbSslCipherAndProtocolListResult:[2,1,1,""],LbSslCipherInfo:[2,1,1,""],LbSslProfile:[2,1,1,""],LbSslProfileListResult:[2,1,1,""],LbSslProtocolInfo:[2,1,1,""],LbStatisticsCounter:[2,1,1,""],LbTcpHeaderCondition:[2,1,1,""],LbTcpMonitor:[2,1,1,""],LbTcpProfile:[2,1,1,""],LbTcpProfileListResult:[2,1,1,""],LbUdpMonitor:[2,1,1,""],LbVariableAssignmentAction:[2,1,1,""],LbVariableCondition:[2,1,1,""],LbVirtualServer:[2,1,1,""],LbVirtualServerListResult:[2,1,1,""],LbVirtualServerStatistics:[2,1,1,""],LbVirtualServerStatisticsListResult:[2,1,1,""],LbVirtualServerStatus:[2,1,1,""],LbVirtualServerStatusListResult:[2,1,1,""],LbVirtualServerWithRule:[2,1,1,""],License:[2,1,1,""],LicensesListResult:[2,1,1,""],ListResult:[2,1,1,""],ListResultQueryParameters:[2,1,1,""],LldpHostSwitchProfile:[2,1,1,""],LoadBalancerAllocationPool:[2,1,1,""],LogicalDhcpServer:[2,1,1,""],LogicalDhcpServerListResult:[2,1,1,""],LogicalPort:[2,1,1,""],LogicalPortAttachment:[2,1,1,""],LogicalPortListResult:[2,1,1,""],LogicalPortMacAddressCsvListResult:[2,1,1,""],LogicalPortMacAddressListResult:[2,1,1,""],LogicalPortMacTableCsvEntry:[2,1,1,""],LogicalPortMacTableEntry:[2,1,1,""],LogicalPortMirrorDestination:[2,1,1,""],LogicalPortMirrorSource:[2,1,1,""],LogicalPortOperationalStatus:[2,1,1,""],LogicalPortState:[2,1,1,""],LogicalPortStatistics:[2,1,1,""],LogicalPortStatusSummary:[2,1,1,""],LogicalRouter:[2,1,1,""],LogicalRouterCentralizedServicePort:[2,1,1,""],LogicalRouterConfig:[2,1,1,""],LogicalRouterDownLinkPort:[2,1,1,""],LogicalRouterIPTunnelPort:[2,1,1,""],LogicalRouterLinkPortOnTIER0:[2,1,1,""],LogicalRouterLinkPortOnTIER1:[2,1,1,""],LogicalRouterListResult:[2,1,1,""],LogicalRouterLoopbackPort:[2,1,1,""],LogicalRouterPort:[2,1,1,""],LogicalRouterPortArpCsvRecord:[2,1,1,""],LogicalRouterPortArpEntry:[2,1,1,""],LogicalRouterPortArpTable:[2,1,1,""],LogicalRouterPortArpTableInCsvFormat:[2,1,1,""],LogicalRouterPortCounters:[2,1,1,""],LogicalRouterPortListResult:[2,1,1,""],LogicalRouterPortStatistics:[2,1,1,""],LogicalRouterPortStatisticsPerNode:[2,1,1,""],LogicalRouterPortStatisticsSummary:[2,1,1,""],LogicalRouterRouteCsvRecord:[2,1,1,""],LogicalRouterRouteEntry:[2,1,1,""],LogicalRouterRouteTable:[2,1,1,""],LogicalRouterRouteTableInCsvFormat:[2,1,1,""],LogicalRouterStatus:[2,1,1,""],LogicalRouterStatusPerNode:[2,1,1,""],LogicalRouterUpLinkPort:[2,1,1,""],LogicalService:[2,1,1,""],LogicalServiceListResult:[2,1,1,""],LogicalSwitch:[2,1,1,""],LogicalSwitchListResult:[2,1,1,""],LogicalSwitchMirrorSource:[2,1,1,""],LogicalSwitchState:[2,1,1,""],LogicalSwitchStateListResult:[2,1,1,""],LogicalSwitchStatistics:[2,1,1,""],LogicalSwitchStatus:[2,1,1,""],LogicalSwitchStatusListResult:[2,1,1,""],LogicalSwitchStatusSummary:[2,1,1,""],LoginCredential:[2,1,1,""],MACAddressElement:[2,1,1,""],MACAddressElementListResult:[2,1,1,""],MACSet:[2,1,1,""],MACSetListResult:[2,1,1,""],MacAddressCsvListResult:[2,1,1,""],MacAddressListResult:[2,1,1,""],MacLearningCounters:[2,1,1,""],MacLearningSpec:[2,1,1,""],MacManagementSwitchingProfile:[2,1,1,""],MacPool:[2,1,1,""],MacPoolListResult:[2,1,1,""],MacRange:[2,1,1,""],MacTableCsvRecord:[2,1,1,""],MacTableEntry:[2,1,1,""],ManagedResource:[2,1,1,""],ManagementClusterNodeStatus:[2,1,1,""],ManagementClusterRoleConfig:[2,1,1,""],ManagementClusterStatus:[2,1,1,""],ManagementConfig:[2,1,1,""],ManagementNodeAggregateInfo:[2,1,1,""],ManagementPlaneBaseNodeInfo:[2,1,1,""],MandatoryAccessControlProperties:[2,1,1,""],MetadataProxy:[2,1,1,""],MetadataProxyListResult:[2,1,1,""],MetadataProxyStatistics:[2,1,1,""],MetadataProxyStatisticsPerLogicalSwitch:[2,1,1,""],MetadataProxyStatus:[2,1,1,""],MgmtConnStatus:[2,1,1,""],MigrationBundleFetchRequest:[2,1,1,""],MigrationBundleId:[2,1,1,""],MigrationBundleInfo:[2,1,1,""],MigrationBundleUploadStatus:[2,1,1,""],MigrationFeedbackRequest:[2,1,1,""],MigrationFeedbackRequestListResult:[2,1,1,""],MigrationFeedbackResponse:[2,1,1,""],MigrationFeedbackResponseList:[2,1,1,""],MigrationPlanSettings:[2,1,1,""],MigrationSetupInfo:[2,1,1,""],MigrationStatus:[2,1,1,""],MigrationSummary:[2,1,1,""],MigrationUnit:[2,1,1,""],MigrationUnitAggregateInfo:[2,1,1,""],MigrationUnitAggregateInfoListResult:[2,1,1,""],MigrationUnitGroup:[2,1,1,""],MigrationUnitGroupAggregateInfo:[2,1,1,""],MigrationUnitGroupAggregateInfoListResult:[2,1,1,""],MigrationUnitGroupListResult:[2,1,1,""],MigrationUnitGroupStatus:[2,1,1,""],MigrationUnitGroupStatusListResult:[2,1,1,""],MigrationUnitList:[2,1,1,""],MigrationUnitListResult:[2,1,1,""],MigrationUnitStatus:[2,1,1,""],MigrationUnitStatusListResult:[2,1,1,""],MigrationUnitTypeStats:[2,1,1,""],MigrationUnitTypeStatsList:[2,1,1,""],MirrorDestination:[2,1,1,""],MirrorSource:[2,1,1,""],MonthlyTelemetrySchedule:[2,1,1,""],MsgClientInfo:[2,1,1,""],MultiWidgetConfiguration:[2,1,1,""],NSGroup:[2,1,1,""],NSGroupComplexExpression:[2,1,1,""],NSGroupExpression:[2,1,1,""],NSGroupExpressionList:[2,1,1,""],NSGroupListResult:[2,1,1,""],NSGroupMetaInfo:[2,1,1,""],NSGroupMetaInfoListResult:[2,1,1,""],NSGroupSimpleExpression:[2,1,1,""],NSGroupTagExpression:[2,1,1,""],NSService:[2,1,1,""],NSServiceElement:[2,1,1,""],NSServiceGroup:[2,1,1,""],NSServiceGroupListResult:[2,1,1,""],NSServiceListResult:[2,1,1,""],NamedTeamingPolicy:[2,1,1,""],NatCounters:[2,1,1,""],NatRule:[2,1,1,""],NatRuleListResult:[2,1,1,""],NatStatisticsPerLogicalRouter:[2,1,1,""],NatStatisticsPerRule:[2,1,1,""],NatStatisticsPerTransportNode:[2,1,1,""],NeighborProperties:[2,1,1,""],NetworkMigrationSpec:[2,1,1,""],NetworkMigrationSpecListResult:[2,1,1,""],NetworkMigrationSpecTypeIdEntry:[2,1,1,""],NicInfo:[2,1,1,""],NicMetadata:[2,1,1,""],NiocProfile:[2,1,1,""],Node:[2,1,1,""],NodeAggregateInfo:[2,1,1,""],NodeAggregateInfoListResult:[2,1,1,""],NodeAuthProviderVidmProperties:[2,1,1,""],NodeAuthProviderVidmStatus:[2,1,1,""],NodeCapabilitiesResult:[2,1,1,""],NodeCapability:[2,1,1,""],NodeFileSystemProperties:[2,1,1,""],NodeHttpServiceProperties:[2,1,1,""],NodeIdServicesMap:[2,1,1,""],NodeInfo:[2,1,1,""],NodeInfoListResult:[2,1,1,""],NodeInstallUpgradeServiceProperties:[2,1,1,""],NodeInterfaceAlias:[2,1,1,""],NodeInterfaceProperties:[2,1,1,""],NodeInterfacePropertiesListResult:[2,1,1,""],NodeInterfaceStatisticsProperties:[2,1,1,""],NodeListResult:[2,1,1,""],NodeLogProperties:[2,1,1,""],NodeLogPropertiesListResult:[2,1,1,""],NodeMode:[2,1,1,""],NodeNameServersProperties:[2,1,1,""],NodeNetworkInterfaceProperties:[2,1,1,""],NodeNetworkInterfacePropertiesListResult:[2,1,1,""],NodeNetworkProperties:[2,1,1,""],NodeNtpServiceProperties:[2,1,1,""],NodeProcessProperties:[2,1,1,""],NodeProcessPropertiesListResult:[2,1,1,""],NodeProperties:[2,1,1,""],NodeProtonServiceProperties:[2,1,1,""],NodeRouteProperties:[2,1,1,""],NodeRoutePropertiesListResult:[2,1,1,""],NodeSearchDomainsProperties:[2,1,1,""],NodeServiceProperties:[2,1,1,""],NodeServicePropertiesListResult:[2,1,1,""],NodeServiceStatusProperties:[2,1,1,""],NodeSnmpServiceProperties:[2,1,1,""],NodeSshServiceProperties:[2,1,1,""],NodeStatus:[2,1,1,""],NodeStatusListResult:[2,1,1,""],NodeStatusProperties:[2,1,1,""],NodeSummary:[2,1,1,""],NodeSummaryList:[2,1,1,""],NodeSyslogExporterProperties:[2,1,1,""],NodeSyslogExporterPropertiesListResult:[2,1,1,""],NodeUserProperties:[2,1,1,""],NodeUserPropertiesListResult:[2,1,1,""],NodeUserSettings:[2,1,1,""],NodeVersion:[2,1,1,""],NormalizedResourceListResult:[2,1,1,""],NsxRole:[2,1,1,""],NtpServiceProperties:[2,1,1,""],Oauth2Credentials:[2,1,1,""],OrgInfo:[2,1,1,""],OwnerResourceLink:[2,1,1,""],PBRInsertParameters:[2,1,1,""],PBRRule:[2,1,1,""],PBRRuleListResult:[2,1,1,""],PBRSection:[2,1,1,""],PBRSectionListResult:[2,1,1,""],PBRSectionQueryParameters:[2,1,1,""],PBRSectionRuleList:[2,1,1,""],PBRService:[2,1,1,""],PackageStore:[2,1,1,""],PacketAddressClassifier:[2,1,1,""],PacketCaptureOption:[2,1,1,""],PacketCaptureOptionList:[2,1,1,""],PacketCaptureRequest:[2,1,1,""],PacketCaptureSession:[2,1,1,""],PacketCaptureSessionList:[2,1,1,""],PacketData:[2,1,1,""],PacketTypeAndCounter:[2,1,1,""],PacketsDroppedBySecurity:[2,1,1,""],PasswordAuthenticationScheme:[2,1,1,""],PerStepRestoreStatus:[2,1,1,""],Pnic:[2,1,1,""],PnicBondStatus:[2,1,1,""],PnicBondStatusListResult:[2,1,1,""],PnicMirrorDestination:[2,1,1,""],PnicMirrorSource:[2,1,1,""],PolicyBasedIPSecVPNSession:[2,1,1,""],PoolMember:[2,1,1,""],PoolMemberGroup:[2,1,1,""],PoolMemberSetting:[2,1,1,""],PoolMemberSettingList:[2,1,1,""],PoolUsage:[2,1,1,""],PortConnectionBMEntities:[2,1,1,""],PortConnectionContainersEntities:[2,1,1,""],PortConnectionEdgeNodeGroup:[2,1,1,""],PortConnectionEntities:[2,1,1,""],PortConnectionEntity:[2,1,1,""],PortConnectionError:[2,1,1,""],PortConnectionHypervisor:[2,1,1,""],PortConnectionLogicalSwitch:[2,1,1,""],PortConnectionRouter:[2,1,1,""],PortConnectionTunnel:[2,1,1,""],PortMirroringSession:[2,1,1,""],PortMirroringSessionListResult:[2,1,1,""],PortMirroringSwitchingProfile:[2,1,1,""],PortStatus:[2,1,1,""],PreconfiguredEndpoint:[2,1,1,""],PreconfiguredHostSwitch:[2,1,1,""],PreconfiguredHostSwitchSpec:[2,1,1,""],PrefixConfig:[2,1,1,""],Principal:[2,1,1,""],PrincipalIdentity:[2,1,1,""],PrincipalIdentityList:[2,1,1,""],PropertyItem:[2,1,1,""],Protocol:[2,1,1,""],ProtocolVersion:[2,1,1,""],ProtonPackageLoggingLevels:[2,1,1,""],ProtonServiceProperties:[2,1,1,""],PublicCloudGatewayNode:[2,1,1,""],QosBaseRateShaper:[2,1,1,""],QosSwitchingProfile:[2,1,1,""],QuickSearchResponse:[2,1,1,""],RateLimits:[2,1,1,""],RealizationStateBarrierConfig:[2,1,1,""],RedistributionConfig:[2,1,1,""],RedistributionRule:[2,1,1,""],RedistributionRuleList:[2,1,1,""],RegistrationToken:[2,1,1,""],RelatedApiError:[2,1,1,""],RelatedData:[2,1,1,""],RelatedDataRequest:[2,1,1,""],RemainingSupportBundleNode:[2,1,1,""],RemoteFileServer:[2,1,1,""],RemoteServerFingerprint:[2,1,1,""],RemoteServerFingerprintRequest:[2,1,1,""],RenderConfiguration:[2,1,1,""],ReorderMigrationRequest:[2,1,1,""],ReorderRequest:[2,1,1,""],RepoSyncStatusReport:[2,1,1,""],ReportAppResultsForVmsRequestParameters:[2,1,1,""],Resource:[2,1,1,""],ResourceAllocation:[2,1,1,""],ResourceLink:[2,1,1,""],ResourceReference:[2,1,1,""],RestoreConfiguration:[2,1,1,""],RestoreStep:[2,1,1,""],RevisionedResource:[2,1,1,""],Role:[2,1,1,""],RoleBinding:[2,1,1,""],RoleBindingListResult:[2,1,1,""],RoleListResult:[2,1,1,""],RoleWithFeatures:[2,1,1,""],RouteBasedIPSecVPNSession:[2,1,1,""],RouteMap:[2,1,1,""],RouteMapListResult:[2,1,1,""],RouteMapSequence:[2,1,1,""],RouteMapSequenceMatch:[2,1,1,""],RouteMapSequenceSet:[2,1,1,""],RoutingConfig:[2,1,1,""],RowListField:[2,1,1,""],RuleState:[2,1,1,""],RuntimeInterfaceOperationalStatus:[2,1,1,""],RuntimeInterfaceStatistics:[2,1,1,""],SIAggregatedDataCounter:[2,1,1,""],SIAggregatedDataCounterEx:[2,1,1,""],SIDataCounter:[2,1,1,""],SIMacLearningCounters:[2,1,1,""],SIPacketTypeAndCounter:[2,1,1,""],SIPacketsDroppedBySecurity:[2,1,1,""],SVMDeploymentSpec:[2,1,1,""],SavedSearch:[2,1,1,""],SavedSearchListResult:[2,1,1,""],SavedSearchRequest:[2,1,1,""],ScpProtocol:[2,1,1,""],SearchResponse:[2,1,1,""],SelectableResourceReference:[2,1,1,""],SelfResourceLink:[2,1,1,""],ServerSslProfileBinding:[2,1,1,""],ServiceAssociationListResult:[2,1,1,""],ServiceAttachment:[2,1,1,""],ServiceAttachmentListResult:[2,1,1,""],ServiceBinding:[2,1,1,""],ServiceDefinition:[2,1,1,""],ServiceDeploymentSpec:[2,1,1,""],ServiceEndpoint:[2,1,1,""],ServiceIP:[2,1,1,""],ServiceInsertionRule:[2,1,1,""],ServiceInsertionRuleList:[2,1,1,""],ServiceInsertionRuleListResult:[2,1,1,""],ServiceInsertionSection:[2,1,1,""],ServiceInsertionSectionListResult:[2,1,1,""],ServiceInsertionSectionRuleList:[2,1,1,""],ServiceInsertionService:[2,1,1,""],ServiceInsertionServiceListResult:[2,1,1,""],ServiceInstance:[2,1,1,""],ServiceInstanceListResult:[2,1,1,""],ServiceProfile:[2,1,1,""],ServiceProfileListResult:[2,1,1,""],ServiceRouterAllocationConfig:[2,1,1,""],ServiceiPsListResult:[2,1,1,""],SessionReclassificationParameter:[2,1,1,""],SftpProtocol:[2,1,1,""],SnmpCommunity:[2,1,1,""],SnmpServiceProperties:[2,1,1,""],SoftwareModule:[2,1,1,""],SoftwareModuleResult:[2,1,1,""],SourceNsxApiEndpoint:[2,1,1,""],SpoofGuardSwitchingProfile:[2,1,1,""],SshKeyBaseProperties:[2,1,1,""],SshKeyProperties:[2,1,1,""],SshKeyPropertiesListResult:[2,1,1,""],SshServiceProperties:[2,1,1,""],StandardHostSwitch:[2,1,1,""],StandardHostSwitchSpec:[2,1,1,""],StartAppDiscoverySessionParameters:[2,1,1,""],StatItem:[2,1,1,""],StaticHopBfdPeer:[2,1,1,""],StaticHopBfdPeerListResult:[2,1,1,""],StaticIpListSpec:[2,1,1,""],StaticIpMacListSpec:[2,1,1,""],StaticIpPoolSpec:[2,1,1,""],StaticRoute:[2,1,1,""],StaticRouteListResult:[2,1,1,""],StaticRouteNextHop:[2,1,1,""],StatsConfiguration:[2,1,1,""],StatusCount:[2,1,1,""],StringMapEntry:[2,1,1,""],StructuredData:[2,1,1,""],StubFactory:[2,1,1,""],SuccessNodeSupportBundleResult:[2,1,1,""],SupportBundleFileTransferAuthenticationScheme:[2,1,1,""],SupportBundleFileTransferProtocol:[2,1,1,""],SupportBundleQueryParameters:[2,1,1,""],SupportBundleRemoteFileServer:[2,1,1,""],SupportBundleRequest:[2,1,1,""],SupportBundleResult:[2,1,1,""],SwitchSecuritySwitchingProfile:[2,1,1,""],SwitchingProfileStatus:[2,1,1,""],SwitchingProfileTypeIdEntry:[2,1,1,""],SwitchingProfilesListResult:[2,1,1,""],SwitchingToVmcModeParameters:[2,1,1,""],Tag:[2,1,1,""],TargetResourceStatus:[2,1,1,""],TaskListResult:[2,1,1,""],TaskProperties:[2,1,1,""],TcpHeader:[2,1,1,""],TeamingPolicy:[2,1,1,""],TelemetryAgreement:[2,1,1,""],TelemetryConfig:[2,1,1,""],TelemetryProxy:[2,1,1,""],TelemetrySchedule:[2,1,1,""],Tooltip:[2,1,1,""],Traceflow:[2,1,1,""],TraceflowListResult:[2,1,1,""],TraceflowObservation:[2,1,1,""],TraceflowObservationCounters:[2,1,1,""],TraceflowObservationDelivered:[2,1,1,""],TraceflowObservationDropped:[2,1,1,""],TraceflowObservationDroppedLogical:[2,1,1,""],TraceflowObservationForwarded:[2,1,1,""],TraceflowObservationForwardedLogical:[2,1,1,""],TraceflowObservationListResult:[2,1,1,""],TraceflowObservationReceived:[2,1,1,""],TraceflowObservationReceivedLogical:[2,1,1,""],TraceflowRequest:[2,1,1,""],TransportNode:[2,1,1,""],TransportNodeListResult:[2,1,1,""],TransportNodeState:[2,1,1,""],TransportNodeStateListResult:[2,1,1,""],TransportNodeStatus:[2,1,1,""],TransportNodeStatusListResult:[2,1,1,""],TransportNodeTemplateListResult:[2,1,1,""],TransportNodeTemplateState:[2,1,1,""],TransportProtocolHeader:[2,1,1,""],TransportZone:[2,1,1,""],TransportZoneEndPoint:[2,1,1,""],TransportZoneListResult:[2,1,1,""],TransportZoneProfile:[2,1,1,""],TransportZoneProfileListResult:[2,1,1,""],TransportZoneProfileTypeIdEntry:[2,1,1,""],TransportZoneStatus:[2,1,1,""],TransportZoneStatusListResult:[2,1,1,""],TrunkVlanRange:[2,1,1,""],TrustManagementData:[2,1,1,""],TrustObjectData:[2,1,1,""],TunnelList:[2,1,1,""],TunnelPortConfig:[2,1,1,""],TunnelProperties:[2,1,1,""],TunnelStatusCount:[2,1,1,""],TypeGroup:[2,1,1,""],UdpHeader:[2,1,1,""],UnassociatedVMListResult:[2,1,1,""],UpdatePrincipalIdentityCertificateRequest:[2,1,1,""],UpgradeBundleFetchRequest:[2,1,1,""],UpgradeBundleId:[2,1,1,""],UpgradeBundleInfo:[2,1,1,""],UpgradeBundleUploadStatus:[2,1,1,""],UpgradeHistory:[2,1,1,""],UpgradeHistoryList:[2,1,1,""],UpgradePlanSettings:[2,1,1,""],UpgradeStatus:[2,1,1,""],UpgradeSummary:[2,1,1,""],UpgradeUnit:[2,1,1,""],UpgradeUnitAggregateInfo:[2,1,1,""],UpgradeUnitAggregateInfoListResult:[2,1,1,""],UpgradeUnitGroup:[2,1,1,""],UpgradeUnitGroupAggregateInfo:[2,1,1,""],UpgradeUnitGroupAggregateInfoListResult:[2,1,1,""],UpgradeUnitGroupInfo:[2,1,1,""],UpgradeUnitGroupListResult:[2,1,1,""],UpgradeUnitGroupStatus:[2,1,1,""],UpgradeUnitGroupStatusListResult:[2,1,1,""],UpgradeUnitList:[2,1,1,""],UpgradeUnitListResult:[2,1,1,""],UpgradeUnitStatus:[2,1,1,""],UpgradeUnitStatusListResult:[2,1,1,""],UpgradeUnitTypeStats:[2,1,1,""],UpgradeUnitTypeStatsList:[2,1,1,""],Uplink:[2,1,1,""],UplinkHostSwitchProfile:[2,1,1,""],UrlAlias:[2,1,1,""],UserInfo:[2,1,1,""],UsernamePasswordLoginCredential:[2,1,1,""],VIPSubnet:[2,1,1,""],VerifiableAsymmetricLoginCredential:[2,1,1,""],VersionList:[2,1,1,""],VersionedDeploymentSpec:[2,1,1,""],VidmInfo:[2,1,1,""],VidmInfoListResult:[2,1,1,""],View:[2,1,1,""],ViewList:[2,1,1,""],VifAttachmentContext:[2,1,1,""],VirtualMachine:[2,1,1,""],VirtualMachineListResult:[2,1,1,""],VirtualMachineTagUpdate:[2,1,1,""],VirtualNetworkInterface:[2,1,1,""],VirtualNetworkInterfaceListResult:[2,1,1,""],VirtualServiceInstance:[2,1,1,""],VlanMirrorSource:[2,1,1,""],VlanTrunkSpec:[2,1,1,""],VmNicInfo:[2,1,1,""],VmkToLogicalSwitchMapping:[2,1,1,""],VniPool:[2,1,1,""],VniPoolListResult:[2,1,1,""],VniRange:[2,1,1,""],VsphereClusterNodeVMDeploymentConfig:[2,1,1,""],VsphereDeploymentConfig:[2,1,1,""],VtepCsvListResult:[2,1,1,""],VtepLabelPool:[2,1,1,""],VtepLabelPoolListResult:[2,1,1,""],VtepLabelPoolUsage:[2,1,1,""],VtepLabelRange:[2,1,1,""],VtepListResult:[2,1,1,""],VtepTableCsvRecord:[2,1,1,""],VtepTableEntry:[2,1,1,""],WeeklyBackupSchedule:[2,1,1,""],WeeklyTelemetrySchedule:[2,1,1,""],WidgetConfiguration:[2,1,1,""],WidgetConfigurationList:[2,1,1,""],WidgetItem:[2,1,1,""],X509Certificate:[2,1,1,""],X509Crl:[2,1,1,""],X509CrlEntry:[2,1,1,""]},"com.vmware.nsx.model_client.ALGTypeNSService":{ALG_FTP:[2,3,1,""],ALG_MS_RPC_TCP:[2,3,1,""],ALG_MS_RPC_UDP:[2,3,1,""],ALG_NBDG_BROADCAST:[2,3,1,""],ALG_NBNS_BROADCAST:[2,3,1,""],ALG_ORACLE_TNS:[2,3,1,""],ALG_SUN_RPC_TCP:[2,3,1,""],ALG_SUN_RPC_UDP:[2,3,1,""],ALG_TFTP:[2,3,1,""]},"com.vmware.nsx.model_client.AcceptableComponentVersion":{COMPONENT_TYPE_CCP:[2,3,1,""],COMPONENT_TYPE_EDGE:[2,3,1,""],COMPONENT_TYPE_HOST:[2,3,1,""],COMPONENT_TYPE_MP:[2,3,1,""]},"com.vmware.nsx.model_client.AddControllerNodeSpec":{TYPE_ADDCONTROLLERNODESPEC:[2,3,1,""]},"com.vmware.nsx.model_client.AddManagementNodeSpec":{TYPE_ADDMANAGEMENTNODESPEC:[2,3,1,""]},"com.vmware.nsx.model_client.AddressBindingEntry":{SOURCE_ARP_SNOOPING:[2,3,1,""],SOURCE_DHCP_SNOOPING:[2,3,1,""],SOURCE_INVALID:[2,3,1,""],SOURCE_UNKNOWN:[2,3,1,""],SOURCE_USER_DEFINED:[2,3,1,""],SOURCE_VM_TOOLS:[2,3,1,""]},"com.vmware.nsx.model_client.AdvertiseRule":{ACTION_ALLOW:[2,3,1,""],ACTION_DENY:[2,3,1,""]},"com.vmware.nsx.model_client.AdvertisementRuleFilter":{MATCH_ROUTE_TYPES_ANY:[2,3,1,""],MATCH_ROUTE_TYPES_NSX_CONNECTED:[2,3,1,""],MATCH_ROUTE_TYPES_STATIC:[2,3,1,""],MATCH_ROUTE_TYPES_T1_LB_SNAT:[2,3,1,""],MATCH_ROUTE_TYPES_T1_LB_VIP:[2,3,1,""],MATCH_ROUTE_TYPES_T1_NAT:[2,3,1,""],PREFIX_OPERATOR_EQ:[2,3,1,""],PREFIX_OPERATOR_GE:[2,3,1,""]},"com.vmware.nsx.model_client.Alarm":{SEVERITY_CRITICAL:[2,3,1,""],SEVERITY_MAJOR:[2,3,1,""],SEVERITY_MINOR:[2,3,1,""],SEVERITY_UNKNOWN:[2,3,1,""],STATE_ACKNOWLEDGED:[2,3,1,""],STATE_ACTIVE:[2,3,1,""],STATE_RESOLVED:[2,3,1,""],STATE_UNKNOWN:[2,3,1,""]},"com.vmware.nsx.model_client.AlarmSource":{IP_ADDRESS_TYPE_IPV4:[2,3,1,""],IP_ADDRESS_TYPE_IPV6:[2,3,1,""]},"com.vmware.nsx.model_client.AppDiscoverySession":{RECLASSIFICATION_NOT_REQUIRED:[2,3,1,""],RECLASSIFICATION_REQUIRED:[2,3,1,""],STATUS_FAILED:[2,3,1,""],STATUS_FINISHED:[2,3,1,""],STATUS_RUNNING:[2,3,1,""]},"com.vmware.nsx.model_client.AppDiscoverySessionResultSummary":{RECLASSIFICATION_NOT_REQUIRED:[2,3,1,""],RECLASSIFICATION_REQUIRED:[2,3,1,""],STATUS_FAILED:[2,3,1,""],STATUS_FINISHED:[2,3,1,""],STATUS_RUNNING:[2,3,1,""]},"com.vmware.nsx.model_client.AppDiscoveryVmInfo":{OS_TYPE_INVALID:[2,3,1,""],OS_TYPE_LINUX:[2,3,1,""],OS_TYPE_WINDOWS:[2,3,1,""]},"com.vmware.nsx.model_client.AppInfo":{OS_TYPE_INVALID:[2,3,1,""],OS_TYPE_LINUX:[2,3,1,""],OS_TYPE_WINDOWS:[2,3,1,""]},"com.vmware.nsx.model_client.AppInfoHostVmCsvRecord":{OS_TYPE_INVALID:[2,3,1,""],OS_TYPE_LINUX:[2,3,1,""],OS_TYPE_WINDOWS:[2,3,1,""]},"com.vmware.nsx.model_client.ApplianceManagementTaskProperties":{STATUS_CANCELED:[2,3,1,""],STATUS_CANCELING:[2,3,1,""],STATUS_ERROR:[2,3,1,""],STATUS_KILLED:[2,3,1,""],STATUS_RUNNING:[2,3,1,""],STATUS_SUCCESS:[2,3,1,""]},"com.vmware.nsx.model_client.AttachmentContext":{ALLOCATE_ADDRESSES_BOTH:[2,3,1,""],ALLOCATE_ADDRESSES_IPPOOL:[2,3,1,""],ALLOCATE_ADDRESSES_MACPOOL:[2,3,1,""],ALLOCATE_ADDRESSES_NONE:[2,3,1,""]},"com.vmware.nsx.model_client.Attribute":{ATTRIBUTE_TYPE_IP_ADDRESS:[2,3,1,""],ATTRIBUTE_TYPE_LONG:[2,3,1,""],ATTRIBUTE_TYPE_PASSWORD:[2,3,1,""],ATTRIBUTE_TYPE_PORT:[2,3,1,""],ATTRIBUTE_TYPE_STRING:[2,3,1,""]},"com.vmware.nsx.model_client.AuditLogRequest":{LOG_FILTER_TYPE_REGEX:[2,3,1,""],LOG_FILTER_TYPE_TEXT:[2,3,1,""]},"com.vmware.nsx.model_client.BFDProperties":{REMOTE_STATE_ADMIN_DOWN:[2,3,1,""],REMOTE_STATE_DOWN:[2,3,1,""],REMOTE_STATE_INIT:[2,3,1,""],REMOTE_STATE_UNKNOWN_STATE:[2,3,1,""],REMOTE_STATE_UP:[2,3,1,""],STATE_ADMIN_DOWN:[2,3,1,""],STATE_DOWN:[2,3,1,""],STATE_INIT:[2,3,1,""],STATE_UNKNOWN_STATE:[2,3,1,""],STATE_UP:[2,3,1,""]},"com.vmware.nsx.model_client.BGPCommunityList":{COMMUNITY_TYPE_NORMALBGPCOMMUNITY:[2,3,1,""]},"com.vmware.nsx.model_client.BackupOperationStatus":{ERROR_CODE_AUTHENTICATION_FAILURE:[2,3,1,""],ERROR_CODE_BAD_FINGERPRINT:[2,3,1,""],ERROR_CODE_GENERIC_ERROR:[2,3,1,""],ERROR_CODE_NOT_RUN_ON_MASTER:[2,3,1,""],ERROR_CODE_PERMISSION_ERROR:[2,3,1,""],ERROR_CODE_SERVER_UNREACHABLE:[2,3,1,""],ERROR_CODE_TIMEOUT:[2,3,1,""]},"com.vmware.nsx.model_client.BackupSchedule":{RESOURCE_TYPE_INTERVALBACKUPSCHEDULE:[2,3,1,""],RESOURCE_TYPE_WEEKLYBACKUPSCHEDULE:[2,3,1,""]},"com.vmware.nsx.model_client.BaseHostSwitchProfile":{RESOURCE_TYPE_EXTRACONFIGHOSTSWITCHPROFILE:[2,3,1,""],RESOURCE_TYPE_LLDPHOSTSWITCHPROFILE:[2,3,1,""],RESOURCE_TYPE_NIOCPROFILE:[2,3,1,""],RESOURCE_TYPE_UPLINKHOSTSWITCHPROFILE:[2,3,1,""]},"com.vmware.nsx.model_client.BaseServiceInstance":{ON_FAILURE_POLICY_ALLOW:[2,3,1,""],ON_FAILURE_POLICY_BLOCK:[2,3,1,""],RESOURCE_TYPE_BYODSERVICEINSTANCE:[2,3,1,""],RESOURCE_TYPE_SERVICEINSTANCE:[2,3,1,""],RESOURCE_TYPE_VIRTUALSERVICEINSTANCE:[2,3,1,""],TRANSPORT_TYPE_L2_BRIDGE:[2,3,1,""],TRANSPORT_TYPE_L3_ROUTED:[2,3,1,""]},"com.vmware.nsx.model_client.BasicAuthenticationScheme":{SCHEME_NAME_BASIC:[2,3,1,""]},"com.vmware.nsx.model_client.BatchRequestItem":{METHOD_DELETE:[2,3,1,""],METHOD_GET:[2,3,1,""],METHOD_PATCH:[2,3,1,""],METHOD_POST:[2,3,1,""],METHOD_PUT:[2,3,1,""]},"com.vmware.nsx.model_client.BgpNeighborAddressFamily":{TYPE_IPV4_UNICAST:[2,3,1,""],TYPE_VPNV4_UNICAST:[2,3,1,""]},"com.vmware.nsx.model_client.BgpNeighborStatus":{CONNECTION_STATE_ACTIVE:[2,3,1,""],CONNECTION_STATE_CONNECT:[2,3,1,""],CONNECTION_STATE_ESTABLISHED:[2,3,1,""],CONNECTION_STATE_IDLE:[2,3,1,""],CONNECTION_STATE_INVALID:[2,3,1,""],CONNECTION_STATE_OPEN_CONFIRM:[2,3,1,""],CONNECTION_STATE_OPEN_SENT:[2,3,1,""]},"com.vmware.nsx.model_client.BinaryPacketData":{RESOURCE_TYPE_BINARYPACKETDATA:[2,3,1,""],RESOURCE_TYPE_FIELDSPACKETDATA:[2,3,1,""],TRANSPORT_TYPE_BROADCAST:[2,3,1,""],TRANSPORT_TYPE_MULTICAST:[2,3,1,""],TRANSPORT_TYPE_UNICAST:[2,3,1,""],TRANSPORT_TYPE_UNKNOWN:[2,3,1,""]},"com.vmware.nsx.model_client.BridgeClusterStatus":{HEALTH_DEGRADED:[2,3,1,""],HEALTH_DOWN:[2,3,1,""],HEALTH_UNKNOWN:[2,3,1,""],HEALTH_UP:[2,3,1,""]},"com.vmware.nsx.model_client.BridgeEndpointProfile":{FAILOVER_MODE_NON_PREEMPTIVE:[2,3,1,""],FAILOVER_MODE_PREEMPTIVE:[2,3,1,""],HIGH_AVAILABILITY_MODE_STANDBY:[2,3,1,""]},"com.vmware.nsx.model_client.ByodServiceInstance":{DEPLOYMENT_MODE_ACTIVE_STANDBY:[2,3,1,""],DEPLOYMENT_MODE_STAND_ALONE:[2,3,1,""]},"com.vmware.nsx.model_client.CCPUpgradeStatus":{STATUS_FAILED:[2,3,1,""],STATUS_IN_PROGRESS:[2,3,1,""],STATUS_NOT_STARTED:[2,3,1,""],STATUS_PAUSED:[2,3,1,""],STATUS_SUCCESS:[2,3,1,""]},"com.vmware.nsx.model_client.ClientSslProfileBinding":{CLIENT_AUTH_IGNORE:[2,3,1,""],CLIENT_AUTH_REQUIRED:[2,3,1,""]},"com.vmware.nsx.model_client.ClientTypeCollectionConfiguration":{CLIENT_TYPE_CONTROL_PLANE:[2,3,1,""],CLIENT_TYPE_CONTROL_PLANE_PLATFORM:[2,3,1,""],CLIENT_TYPE_EDGE:[2,3,1,""],CLIENT_TYPE_HYPERVISOR:[2,3,1,""],CLIENT_TYPE_MANAGEMENT_PLANE:[2,3,1,""],CLIENT_TYPE_MANAGEMENT_PLANE_PLATFORM:[2,3,1,""]},"com.vmware.nsx.model_client.ClusterGroupMemberStatus":{MEMBER_STATUS_DOWN:[2,3,1,""],MEMBER_STATUS_UNKNOWN:[2,3,1,""],MEMBER_STATUS_UP:[2,3,1,""]},"com.vmware.nsx.model_client.ClusterGroupStatus":{GROUP_STATUS_DEGRADED:[2,3,1,""],GROUP_STATUS_STABLE:[2,3,1,""],GROUP_STATUS_UNAVAILABLE:[2,3,1,""],GROUP_STATUS_UNSTABLE:[2,3,1,""],GROUP_TYPE_CONTROLLER:[2,3,1,""],GROUP_TYPE_HTTP:[2,3,1,""],GROUP_TYPE_MANAGER:[2,3,1,""],GROUP_TYPE_POLICY:[2,3,1,""]},"com.vmware.nsx.model_client.ClusterNodeVMDeploymentConfig":{PLACEMENT_TYPE_VSPHERECLUSTERNODEVMDEPLOYMENTCONFIG:[2,3,1,""]},"com.vmware.nsx.model_client.ClusterNodeVMDeploymentRequest":{FORM_FACTOR_LARGE:[2,3,1,""],FORM_FACTOR_MEDIUM:[2,3,1,""],FORM_FACTOR_MEDIUM_LARGE:[2,3,1,""],FORM_FACTOR_SMALL:[2,3,1,""],ROLES_CONTROLLER:[2,3,1,""],ROLES_MANAGER:[2,3,1,""]},"com.vmware.nsx.model_client.ClusterNodeVMDeploymentStatusReport":{STATUS_UNKNOWN_STATE:[2,3,1,""],STATUS_VM_CLUSTERING_FAILED:[2,3,1,""],STATUS_VM_CLUSTERING_IN_PROGRESS:[2,3,1,""],STATUS_VM_CLUSTERING_SUCCESSFUL:[2,3,1,""],STATUS_VM_DECLUSTER_FAILED:[2,3,1,""],STATUS_VM_DECLUSTER_IN_PROGRESS:[2,3,1,""],STATUS_VM_DECLUSTER_SUCCESSFUL:[2,3,1,""],STATUS_VM_DEPLOYMENT_FAILED:[2,3,1,""],STATUS_VM_DEPLOYMENT_IN_PROGRESS:[2,3,1,""],STATUS_VM_DEPLOYMENT_QUEUED:[2,3,1,""],STATUS_VM_ONLINE_FAILED:[2,3,1,""],STATUS_VM_POWER_OFF_FAILED:[2,3,1,""],STATUS_VM_POWER_OFF_IN_PROGRESS:[2,3,1,""],STATUS_VM_POWER_ON_FAILED:[2,3,1,""],STATUS_VM_POWER_ON_IN_PROGRESS:[2,3,1,""],STATUS_VM_UNDEPLOY_FAILED:[2,3,1,""],STATUS_VM_UNDEPLOY_IN_PROGRESS:[2,3,1,""],STATUS_VM_UNDEPLOY_SUCCESSFUL:[2,3,1,""],STATUS_VM_WAITING_TO_CLUSTER:[2,3,1,""],STATUS_VM_WAITING_TO_COME_ONLINE:[2,3,1,""],STATUS_WAITING_TO_REGISTER_VM:[2,3,1,""],STATUS_WAITING_TO_UNDEPLOY_VM:[2,3,1,""]},"com.vmware.nsx.model_client.ClusterProfile":{RESOURCE_TYPE_BRIDGEHIGHAVAILABILITYCLUSTERPROFILE:[2,3,1,""],RESOURCE_TYPE_EDGEHIGHAVAILABILITYPROFILE:[2,3,1,""]},"com.vmware.nsx.model_client.ClusterProfileTypeIdEntry":{RESOURCE_TYPE_BRIDGEHIGHAVAILABILITYCLUSTERPROFILE:[2,3,1,""],RESOURCE_TYPE_EDGEHIGHAVAILABILITYPROFILE:[2,3,1,""]},"com.vmware.nsx.model_client.ClusterRoleConfig":{TYPE_CONTROLLERCLUSTERROLECONFIG:[2,3,1,""],TYPE_MANAGEMENTCLUSTERROLECONFIG:[2,3,1,""]},"com.vmware.nsx.model_client.ClusteringConfig":{CLUSTERING_TYPE_CONTROLCLUSTERINGCONFIG:[2,3,1,""]},"com.vmware.nsx.model_client.ColumnItem":{TYPE_DATE:[2,3,1,""],TYPE_NUMBER:[2,3,1,""],TYPE_STRING:[2,3,1,""]},"com.vmware.nsx.model_client.CommunityMatchExpression":{OPERATOR_AND:[2,3,1,""]},"com.vmware.nsx.model_client.CommunityMatchOperation":{MATCH_OPERATOR_ALL:[2,3,1,""],MATCH_OPERATOR_ANY:[2,3,1,""],MATCH_OPERATOR_EXACT:[2,3,1,""],MATCH_OPERATOR_NONE:[2,3,1,""],MATCH_OPERATOR_REGEX:[2,3,1,""]},"com.vmware.nsx.model_client.ComponentMigrationStatus":{STATUS_FAILED:[2,3,1,""],STATUS_IN_PROGRESS:[2,3,1,""],STATUS_NOT_STARTED:[2,3,1,""],STATUS_PAUSED:[2,3,1,""],STATUS_SUCCESS:[2,3,1,""]},"com.vmware.nsx.model_client.ComponentUpgradeStatus":{STATUS_FAILED:[2,3,1,""],STATUS_IN_PROGRESS:[2,3,1,""],STATUS_NOT_STARTED:[2,3,1,""],STATUS_PAUSED:[2,3,1,""],STATUS_SUCCESS:[2,3,1,""]},"com.vmware.nsx.model_client.ComputeManagerStatus":{CONNECTION_STATUS_CONNECTING:[2,3,1,""],CONNECTION_STATUS_DOWN:[2,3,1,""],CONNECTION_STATUS_UP:[2,3,1,""],REGISTRATION_STATUS_REGISTERED:[2,3,1,""],REGISTRATION_STATUS_REGISTERING:[2,3,1,""],REGISTRATION_STATUS_UNREGISTERED:[2,3,1,""]},"com.vmware.nsx.model_client.ConfigurationState":{STATE_FAILED:[2,3,1,""],STATE_IN_PROGRESS:[2,3,1,""],STATE_ORPHANED:[2,3,1,""],STATE_PARTIAL_SUCCESS:[2,3,1,""],STATE_PENDING:[2,3,1,""],STATE_SUCCESS:[2,3,1,""],STATE_UNKNOWN:[2,3,1,""]},"com.vmware.nsx.model_client.ConfigurationStateElement":{STATE_FAILED:[2,3,1,""],STATE_IN_PROGRESS:[2,3,1,""],STATE_PARTIAL_SUCCESS:[2,3,1,""],STATE_SUCCESS:[2,3,1,""]},"com.vmware.nsx.model_client.ControlClusterNodeStatus":{CONTROL_CLUSTER_STATUS_CONNECTED:[2,3,1,""],CONTROL_CLUSTER_STATUS_DISCONNECTED:[2,3,1,""],CONTROL_CLUSTER_STATUS_UNKNOWN:[2,3,1,""]},"com.vmware.nsx.model_client.ControlConnStatus":{FAILURE_STATUS_CONNECTION_REFUSED:[2,3,1,""],FAILURE_STATUS_CONTROLLER_REJECTED_HOST_CERT:[2,3,1,""],FAILURE_STATUS_HOST_REJECTED_CONTROLLER_CERT:[2,3,1,""],FAILURE_STATUS_INCOMPLETE_CONTROLLER_CERT:[2,3,1,""],FAILURE_STATUS_INCOMPLETE_HOST_CERT:[2,3,1,""],FAILURE_STATUS_KEEP_ALIVE_TIMEOUT:[2,3,1,""],FAILURE_STATUS_OTHER_ERROR:[2,3,1,""],FAILURE_STATUS_OTHER_SSL_ERROR:[2,3,1,""],STATUS_DOWN:[2,3,1,""],STATUS_UP:[2,3,1,""]},"com.vmware.nsx.model_client.ControllerClusterRoleConfig":{TYPE_CONTROLLERCLUSTERROLECONFIG:[2,3,1,""],TYPE_MANAGEMENTCLUSTERROLECONFIG:[2,3,1,""]},"com.vmware.nsx.model_client.ControllerClusterStatus":{STATUS_STABLE:[2,3,1,""],STATUS_UNKNOWN:[2,3,1,""],STATUS_UNSTABLE:[2,3,1,""]},"com.vmware.nsx.model_client.Csr":{ALGORITHM_DSA:[2,3,1,""],ALGORITHM_RSA:[2,3,1,""]},"com.vmware.nsx.model_client.CurrentBackupOperationStatus":{CURRENT_STEP_CLUSTER_BACKUP:[2,3,1,""],CURRENT_STEP_NODE_BACKUP:[2,3,1,""],OPERATION_TYPE_BACKUP:[2,3,1,""],OPERATION_TYPE_NONE:[2,3,1,""]},"com.vmware.nsx.model_client.DSInsertParameters":{OPERATION_AFTER:[2,3,1,""],OPERATION_BEFORE:[2,3,1,""],OPERATION_BOTTOM:[2,3,1,""],OPERATION_TOP:[2,3,1,""]},"com.vmware.nsx.model_client.DSRule":{ACTION_ALLOW:[2,3,1,""],ACTION_DO_NOT_REDIRECT:[2,3,1,""],ACTION_DROP:[2,3,1,""],ACTION_REDIRECT:[2,3,1,""],ACTION_REJECT:[2,3,1,""],DIRECTION_IN:[2,3,1,""],DIRECTION_IN_OUT:[2,3,1,""],DIRECTION_OUT:[2,3,1,""],IP_PROTOCOL_IPV4:[2,3,1,""],IP_PROTOCOL_IPV4_IPV6:[2,3,1,""],IP_PROTOCOL_IPV6:[2,3,1,""]},"com.vmware.nsx.model_client.DSRuleState":{STATE_FAILED:[2,3,1,""],STATE_IN_PROGRESS:[2,3,1,""],STATE_ORPHANED:[2,3,1,""],STATE_PARTIAL_SUCCESS:[2,3,1,""],STATE_PENDING:[2,3,1,""],STATE_SUCCESS:[2,3,1,""],STATE_UNKNOWN:[2,3,1,""]},"com.vmware.nsx.model_client.DSSection":{SECTION_TYPE_L3REDIRECT:[2,3,1,""],SECTION_TYPE_LAYER2:[2,3,1,""],SECTION_TYPE_LAYER3:[2,3,1,""]},"com.vmware.nsx.model_client.DSSectionState":{STATE_FAILED:[2,3,1,""],STATE_IN_PROGRESS:[2,3,1,""],STATE_ORPHANED:[2,3,1,""],STATE_PARTIAL_SUCCESS:[2,3,1,""],STATE_PENDING:[2,3,1,""],STATE_SUCCESS:[2,3,1,""],STATE_UNKNOWN:[2,3,1,""]},"com.vmware.nsx.model_client.DataTypeCollectionConfiguration":{DATA_TYPE_STATISTICS:[2,3,1,""],DATA_TYPE_STATUS:[2,3,1,""]},"com.vmware.nsx.model_client.DeploymentConfig":{PLACEMENT_TYPE_VSPHEREDEPLOYMENTCONFIG:[2,3,1,""]},"com.vmware.nsx.model_client.DhcpHeader":{OP_CODE_BOOTREPLY:[2,3,1,""],OP_CODE_BOOTREQUEST:[2,3,1,""]},"com.vmware.nsx.model_client.DhcpServerStatus":{SERVICE_STATUS_DOWN:[2,3,1,""],SERVICE_STATUS_ERROR:[2,3,1,""],SERVICE_STATUS_NO_STANDBY:[2,3,1,""],SERVICE_STATUS_UP:[2,3,1,""]},"com.vmware.nsx.model_client.DirectoryDomainSyncStats":{CURRENT_STATE_DELTA_SYNC:[2,3,1,""],CURRENT_STATE_FULL_SYNC:[2,3,1,""],CURRENT_STATE_IDLE:[2,3,1,""],PREV_SYNC_STATUS_FAILURE:[2,3,1,""],PREV_SYNC_STATUS_SUCCESS:[2,3,1,""],PREV_SYNC_STATUS_UNKNOWN:[2,3,1,""],PREV_SYNC_TYPE_DELTA_SYNC:[2,3,1,""],PREV_SYNC_TYPE_FULL_SYNC:[2,3,1,""],PREV_SYNC_TYPE_IDLE:[2,3,1,""]},"com.vmware.nsx.model_client.DirectoryLdapServer":{PROTOCOL_LDAP:[2,3,1,""],PROTOCOL_LDAPS:[2,3,1,""]},"com.vmware.nsx.model_client.DnsForwarder":{LOG_LEVEL_DEBUG:[2,3,1,""],LOG_LEVEL_ERROR:[2,3,1,""],LOG_LEVEL_FATAL:[2,3,1,""],LOG_LEVEL_INFO:[2,3,1,""],LOG_LEVEL_WARNING:[2,3,1,""]},"com.vmware.nsx.model_client.DnsHeader":{MESSAGE_TYPE_QUERY:[2,3,1,""],MESSAGE_TYPE_RESPONSE:[2,3,1,""]},"com.vmware.nsx.model_client.Dscp":{MODE_TRUSTED:[2,3,1,""],MODE_UNTRUSTED:[2,3,1,""]},"com.vmware.nsx.model_client.EdgeCluster":{DEPLOYMENT_TYPE_PHYSICAL_MACHINE:[2,3,1,""],DEPLOYMENT_TYPE_UNKNOWN:[2,3,1,""],DEPLOYMENT_TYPE_VIRTUAL_MACHINE:[2,3,1,""],MEMBER_NODE_TYPE_EDGE_NODE:[2,3,1,""],MEMBER_NODE_TYPE_PUBLIC_CLOUD_GATEWAY_NODE:[2,3,1,""],MEMBER_NODE_TYPE_UNKNOWN:[2,3,1,""]},"com.vmware.nsx.model_client.EdgeClusterMemberAllocationPool":{ALLOCATION_POOL_TYPE_LOADBALANCERALLOCATIONPOOL:[2,3,1,""]},"com.vmware.nsx.model_client.EdgeNode":{DEPLOYMENT_TYPE_PHYSICAL_MACHINE:[2,3,1,""],DEPLOYMENT_TYPE_UNKNOWN:[2,3,1,""],DEPLOYMENT_TYPE_VIRTUAL_MACHINE:[2,3,1,""]},"com.vmware.nsx.model_client.EdgeNodeDeploymentConfig":{FORM_FACTOR_LARGE:[2,3,1,""],FORM_FACTOR_MEDIUM:[2,3,1,""],FORM_FACTOR_SMALL:[2,3,1,""]},"com.vmware.nsx.model_client.EdgeUpgradeStatus":{STATUS_FAILED:[2,3,1,""],STATUS_IN_PROGRESS:[2,3,1,""],STATUS_NOT_STARTED:[2,3,1,""],STATUS_PAUSED:[2,3,1,""],STATUS_SUCCESS:[2,3,1,""]},"com.vmware.nsx.model_client.EffectiveMemberTypeListResult":{RESULTS_DIRECTORYGROUP:[2,3,1,""],RESULTS_IPSET:[2,3,1,""],RESULTS_LOGICALPORT:[2,3,1,""],RESULTS_LOGICALSWITCH:[2,3,1,""],RESULTS_MACSET:[2,3,1,""],RESULTS_NSGROUP:[2,3,1,""],RESULTS_VIRTUALMACHINE:[2,3,1,""]},"com.vmware.nsx.model_client.EgressRateShaper":{RESOURCE_TYPE_EGRESSRATESHAPER:[2,3,1,""],RESOURCE_TYPE_INGRESSBROADCASTRATESHAPER:[2,3,1,""],RESOURCE_TYPE_INGRESSRATESHAPER:[2,3,1,""]},"com.vmware.nsx.model_client.ErrorResolverUserInputData":{DATA_TYPE_NUMBER:[2,3,1,""],DATA_TYPE_PASSWORD:[2,3,1,""],DATA_TYPE_TEXT:[2,3,1,""]},"com.vmware.nsx.model_client.FabricModule":{SOURCE_AUTHENTICATION_MODE_BASIC_AUTHENTICATION:[2,3,1,""],SOURCE_AUTHENTICATION_MODE_MARKET_PLACE:[2,3,1,""],SOURCE_AUTHENTICATION_MODE_NO_AUTHENTICATION:[2,3,1,""]},"com.vmware.nsx.model_client.FeaturePermission":{PERMISSION_CRUD:[2,3,1,""],PERMISSION_EXECUTE:[2,3,1,""],PERMISSION_NONE:[2,3,1,""],PERMISSION_READ:[2,3,1,""]},"com.vmware.nsx.model_client.FieldsPacketData":{RESOURCE_TYPE_BINARYPACKETDATA:[2,3,1,""],RESOURCE_TYPE_FIELDSPACKETDATA:[2,3,1,""],TRANSPORT_TYPE_BROADCAST:[2,3,1,""],TRANSPORT_TYPE_MULTICAST:[2,3,1,""],TRANSPORT_TYPE_UNICAST:[2,3,1,""],TRANSPORT_TYPE_UNKNOWN:[2,3,1,""]},"com.vmware.nsx.model_client.FileHash":{HASH_TYPE_SHA1:[2,3,1,""]},"com.vmware.nsx.model_client.FileTransferAuthenticationScheme":{SCHEME_NAME_PASSWORD:[2,3,1,""]},"com.vmware.nsx.model_client.FileTransferProtocol":{PROTOCOL_NAME_SFTP:[2,3,1,""]},"com.vmware.nsx.model_client.FirewallRule":{ACTION_ALLOW:[2,3,1,""],ACTION_DO_NOT_REDIRECT:[2,3,1,""],ACTION_DROP:[2,3,1,""],ACTION_REDIRECT:[2,3,1,""],ACTION_REJECT:[2,3,1,""],DIRECTION_IN:[2,3,1,""],DIRECTION_IN_OUT:[2,3,1,""],DIRECTION_OUT:[2,3,1,""],IP_PROTOCOL_IPV4:[2,3,1,""],IP_PROTOCOL_IPV4_IPV6:[2,3,1,""],IP_PROTOCOL_IPV6:[2,3,1,""]},"com.vmware.nsx.model_client.FirewallSection":{SECTION_TYPE_L3REDIRECT:[2,3,1,""],SECTION_TYPE_LAYER2:[2,3,1,""],SECTION_TYPE_LAYER3:[2,3,1,""]},"com.vmware.nsx.model_client.FirewallSectionRuleList":{SECTION_TYPE_L3REDIRECT:[2,3,1,""],SECTION_TYPE_LAYER2:[2,3,1,""],SECTION_TYPE_LAYER3:[2,3,1,""]},"com.vmware.nsx.model_client.FirewallSectionState":{STATE_FAILED:[2,3,1,""],STATE_IN_PROGRESS:[2,3,1,""],STATE_ORPHANED:[2,3,1,""],STATE_PARTIAL_SUCCESS:[2,3,1,""],STATE_PENDING:[2,3,1,""],STATE_SUCCESS:[2,3,1,""],STATE_UNKNOWN:[2,3,1,""]},"com.vmware.nsx.model_client.FirewallSectionsSummary":{SECTION_TYPE_L2DFW:[2,3,1,""],SECTION_TYPE_L3DFW:[2,3,1,""]},"com.vmware.nsx.model_client.FirewallStatus":{CONTEXT_LOGICAL_ROUTERS:[2,3,1,""],CONTEXT_TRANSPORT_NODES:[2,3,1,""],GLOBAL_STATUS_DISABLED:[2,3,1,""],GLOBAL_STATUS_ENABLED:[2,3,1,""]},"com.vmware.nsx.model_client.GlobalRestoreStatus":{VALUE_ABORTED:[2,3,1,""],VALUE_ERROR:[2,3,1,""],VALUE_NOT_AVAILABLE:[2,3,1,""],VALUE_NOT_STARTED:[2,3,1,""],VALUE_RUNNING:[2,3,1,""],VALUE_SUCCESS:[2,3,1,""],VALUE_SUSPENDED:[2,3,1,""],VALUE_SUSPENDING:[2,3,1,""]},"com.vmware.nsx.model_client.HostInfraTrafficType":{TRAFFIC_NAME_FAULT_TOLERANCE:[2,3,1,""],TRAFFIC_NAME_HBR:[2,3,1,""],TRAFFIC_NAME_ISCSI:[2,3,1,""],TRAFFIC_NAME_MANAGEMENT:[2,3,1,""],TRAFFIC_NAME_NFS:[2,3,1,""],TRAFFIC_NAME_VDP:[2,3,1,""],TRAFFIC_NAME_VIRTUAL_MACHINE:[2,3,1,""],TRAFFIC_NAME_VMOTION:[2,3,1,""],TRAFFIC_NAME_VSAN:[2,3,1,""]},"com.vmware.nsx.model_client.HostNode":{OS_TYPE_CENTOSKVM:[2,3,1,""],OS_TYPE_CENTOSSERVER:[2,3,1,""],OS_TYPE_ESXI:[2,3,1,""],OS_TYPE_HYPERV:[2,3,1,""],OS_TYPE_RHELCONTAINER:[2,3,1,""],OS_TYPE_RHELKVM:[2,3,1,""],OS_TYPE_RHELSERVER:[2,3,1,""],OS_TYPE_UBUNTUKVM:[2,3,1,""],OS_TYPE_UBUNTUSERVER:[2,3,1,""]},"com.vmware.nsx.model_client.HostSwitchProfileTypeIdEntry":{KEY_EXTRACONFIGHOSTSWITCHPROFILE:[2,3,1,""],KEY_LLDPHOSTSWITCHPROFILE:[2,3,1,""],KEY_NIOCPROFILE:[2,3,1,""],KEY_UPLINKHOSTSWITCHPROFILE:[2,3,1,""]},"com.vmware.nsx.model_client.HostSwitchSpec":{RESOURCE_TYPE_PRECONFIGUREDHOSTSWITCHSPEC:[2,3,1,""],RESOURCE_TYPE_STANDARDHOSTSWITCHSPEC:[2,3,1,""]},"com.vmware.nsx.model_client.HostUpgradeStatus":{STATUS_FAILED:[2,3,1,""],STATUS_IN_PROGRESS:[2,3,1,""],STATUS_NOT_STARTED:[2,3,1,""],STATUS_PAUSED:[2,3,1,""],STATUS_SUCCESS:[2,3,1,""]},"com.vmware.nsx.model_client.ICMPTypeNSService":{PROTOCOL_ICMPV4:[2,3,1,""],PROTOCOL_ICMPV6:[2,3,1,""]},"com.vmware.nsx.model_client.IPMirrorDestination":{ENCAPSULATION_TYPE_ERSPAN_THREE:[2,3,1,""],ENCAPSULATION_TYPE_ERSPAN_TWO:[2,3,1,""],ENCAPSULATION_TYPE_GRE:[2,3,1,""]},"com.vmware.nsx.model_client.IPSecVPNIKEProfile":{DH_GROUPS_GROUP14:[2,3,1,""],DH_GROUPS_GROUP15:[2,3,1,""],DH_GROUPS_GROUP16:[2,3,1,""],DH_GROUPS_GROUP2:[2,3,1,""],DH_GROUPS_GROUP5:[2,3,1,""],DIGEST_ALGORITHMS_SHA1:[2,3,1,""],DIGEST_ALGORITHMS_SHA2_256:[2,3,1,""],DIGEST_ALGORITHMS_SHA2_384:[2,3,1,""],DIGEST_ALGORITHMS_SHA2_512:[2,3,1,""],ENCRYPTION_ALGORITHMS_128:[2,3,1,""],ENCRYPTION_ALGORITHMS_256:[2,3,1,""],ENCRYPTION_ALGORITHMS_GCM_128:[2,3,1,""],ENCRYPTION_ALGORITHMS_GCM_192:[2,3,1,""],ENCRYPTION_ALGORITHMS_GCM_256:[2,3,1,""],IKE_VERSION_FLEX:[2,3,1,""],IKE_VERSION_V1:[2,3,1,""],IKE_VERSION_V2:[2,3,1,""]},"com.vmware.nsx.model_client.IPSecVPNIKESessionStatus":{IKE_SESSION_STATE_DOWN:[2,3,1,""],IKE_SESSION_STATE_NEGOTIATING:[2,3,1,""],IKE_SESSION_STATE_UP:[2,3,1,""]},"com.vmware.nsx.model_client.IPSecVPNPeerEndpoint":{AUTHENTICATION_MODE_PSK:[2,3,1,""],CONNECTION_INITIATION_MODE_INITIATOR:[2,3,1,""],CONNECTION_INITIATION_MODE_ON_DEMAND:[2,3,1,""],CONNECTION_INITIATION_MODE_RESPOND_ONLY:[2,3,1,""]},"com.vmware.nsx.model_client.IPSecVPNPolicyRule":{ACTION_BYPASS:[2,3,1,""],ACTION_PROTECT:[2,3,1,""]},"com.vmware.nsx.model_client.IPSecVPNService":{IKE_LOG_LEVEL_DEBUG:[2,3,1,""],IKE_LOG_LEVEL_EMERGENCY:[2,3,1,""],IKE_LOG_LEVEL_ERROR:[2,3,1,""],IKE_LOG_LEVEL_INFO:[2,3,1,""],IKE_LOG_LEVEL_WARN:[2,3,1,""]},"com.vmware.nsx.model_client.IPSecVPNSession":{RESOURCE_TYPE_POLICYBASEDIPSECVPNSESSION:[2,3,1,""],RESOURCE_TYPE_ROUTEBASEDIPSECVPNSESSION:[2,3,1,""]},"com.vmware.nsx.model_client.IPSecVPNSessionStatus":{SESSION_STATUS_DEGRADED:[2,3,1,""],SESSION_STATUS_DOWN:[2,3,1,""],SESSION_STATUS_UP:[2,3,1,""]},"com.vmware.nsx.model_client.IPSecVPNTunnelProfile":{DF_POLICY_CLEAR:[2,3,1,""],DF_POLICY_COPY:[2,3,1,""],DH_GROUPS_GROUP14:[2,3,1,""],DH_GROUPS_GROUP15:[2,3,1,""],DH_GROUPS_GROUP16:[2,3,1,""],DH_GROUPS_GROUP2:[2,3,1,""],DH_GROUPS_GROUP5:[2,3,1,""],DIGEST_ALGORITHMS_SHA1:[2,3,1,""],DIGEST_ALGORITHMS_SHA2_256:[2,3,1,""],DIGEST_ALGORITHMS_SHA2_384:[2,3,1,""],DIGEST_ALGORITHMS_SHA2_512:[2,3,1,""],ENCAPSULATION_MODE_MODE:[2,3,1,""],ENCRYPTION_ALGORITHMS_AES_128:[2,3,1,""],ENCRYPTION_ALGORITHMS_AES_256:[2,3,1,""],ENCRYPTION_ALGORITHMS_AES_GCM_128:[2,3,1,""],ENCRYPTION_ALGORITHMS_AES_GCM_192:[2,3,1,""],ENCRYPTION_ALGORITHMS_AES_GCM_256:[2,3,1,""],ENCRYPTION_ALGORITHMS_NO_ENCRYPTION:[2,3,1,""],ENCRYPTION_ALGORITHMS_NO_ENCRYPTION_AUTH_AES_GMAC_128:[2,3,1,""],ENCRYPTION_ALGORITHMS_NO_ENCRYPTION_AUTH_AES_GMAC_192:[2,3,1,""],ENCRYPTION_ALGORITHMS_NO_ENCRYPTION_AUTH_AES_GMAC_256:[2,3,1,""],TRANSFORM_PROTOCOL_ESP:[2,3,1,""]},"com.vmware.nsx.model_client.IPSecVPNTunnelTrafficStatistics":{TUNNEL_STATUS_DOWN:[2,3,1,""],TUNNEL_STATUS_NEGOTIATING:[2,3,1,""],TUNNEL_STATUS_UP:[2,3,1,""]},"com.vmware.nsx.model_client.Icon":{PLACEMENT_POST:[2,3,1,""],PLACEMENT_PRE:[2,3,1,""],TYPE_DETAIL:[2,3,1,""],TYPE_ERROR:[2,3,1,""],TYPE_INFO:[2,3,1,""],TYPE_INPROGRESS:[2,3,1,""],TYPE_NOT_AVAILABLE:[2,3,1,""],TYPE_SUCCESS:[2,3,1,""],TYPE_WARNING:[2,3,1,""]},"com.vmware.nsx.model_client.IngressBroadcastRateShaper":{RESOURCE_TYPE_EGRESSRATESHAPER:[2,3,1,""],RESOURCE_TYPE_INGRESSBROADCASTRATESHAPER:[2,3,1,""],RESOURCE_TYPE_INGRESSRATESHAPER:[2,3,1,""]},"com.vmware.nsx.model_client.IngressRateShaper":{RESOURCE_TYPE_EGRESSRATESHAPER:[2,3,1,""],RESOURCE_TYPE_INGRESSBROADCASTRATESHAPER:[2,3,1,""],RESOURCE_TYPE_INGRESSRATESHAPER:[2,3,1,""]},"com.vmware.nsx.model_client.InstanceEndpoint":{ENDPOINT_TYPE_LOGICAL:[2,3,1,""],ENDPOINT_TYPE_VIRTUAL:[2,3,1,""]},"com.vmware.nsx.model_client.InstanceRuntime":{DEPLOYMENT_STATUS_DEPLOYMENT_FAILED:[2,3,1,""],DEPLOYMENT_STATUS_DEPLOYMENT_IN_PROGRESS:[2,3,1,""],DEPLOYMENT_STATUS_DEPLOYMENT_SUCCESSFUL:[2,3,1,""],DEPLOYMENT_STATUS_UNDEPLOYMENT_FAILED:[2,3,1,""],DEPLOYMENT_STATUS_UNDEPLOYMENT_IN_PROGRESS:[2,3,1,""],DEPLOYMENT_STATUS_UNDEPLOYMENT_SUCCESSFUL:[2,3,1,""],DEPLOYMENT_STATUS_UNKNOWN:[2,3,1,""],DEPLOYMENT_STATUS_UPGRADE_FAILED:[2,3,1,""],DEPLOYMENT_STATUS_UPGRADE_IN_PROGRESS:[2,3,1,""],RUNTIME_STATUS_IN_SERVICE:[2,3,1,""],RUNTIME_STATUS_NEEDS_ATTENTION:[2,3,1,""],RUNTIME_STATUS_NOT_AVAILABLE:[2,3,1,""],RUNTIME_STATUS_OUT_OF_SERVICE:[2,3,1,""]},"com.vmware.nsx.model_client.IpAddressInfo":{SOURCE_TOOLS:[2,3,1,""]},"com.vmware.nsx.model_client.IpAssignmentSpec":{RESOURCE_TYPE_ASSIGNEDBYDHCP:[2,3,1,""],RESOURCE_TYPE_STATICIPLISTSPEC:[2,3,1,""],RESOURCE_TYPE_STATICIPMACLISTSPEC:[2,3,1,""],RESOURCE_TYPE_STATICIPPOOLSPEC:[2,3,1,""]},"com.vmware.nsx.model_client.IpfixCollectorUpmProfile":{RESOURCE_TYPE_IPFIXCOLLECTORUPMPROFILE:[2,3,1,""]},"com.vmware.nsx.model_client.IpfixConfig":{RESOURCE_TYPE_IPFIXDFWCONFIG:[2,3,1,""],RESOURCE_TYPE_IPFIXSWITCHCONFIG:[2,3,1,""]},"com.vmware.nsx.model_client.IpfixUpmProfile":{RESOURCE_TYPE_IPFIXSWITCHUPMPROFILE:[2,3,1,""]},"com.vmware.nsx.model_client.L2VPNSessionStatus":{STATUS_DOWN:[2,3,1,""],STATUS_UP:[2,3,1,""]},"com.vmware.nsx.model_client.L2VPNTransportTunnelStatus":{RESOURCE_TYPE_IPSECVPNTRANSPORTSTATUS:[2,3,1,""]},"com.vmware.nsx.model_client.L2VpnTunnelEncapsulation":{PROTOCOL_GRE:[2,3,1,""]},"com.vmware.nsx.model_client.L4PortSetNSService":{L4PROTOCOL_TCP:[2,3,1,""],L4PROTOCOL_UDP:[2,3,1,""]},"com.vmware.nsx.model_client.Lag":{LOAD_BALANCE_ALGORITHM_DESTMAC:[2,3,1,""],LOAD_BALANCE_ALGORITHM_SRCDESTIPVLAN:[2,3,1,""],LOAD_BALANCE_ALGORITHM_SRCDESTMAC:[2,3,1,""],LOAD_BALANCE_ALGORITHM_SRCDESTMACIPPORT:[2,3,1,""],LOAD_BALANCE_ALGORITHM_SRCMAC:[2,3,1,""],MODE_ACTIVE:[2,3,1,""],MODE_PASSIVE:[2,3,1,""],TIMEOUT_TYPE_FAST:[2,3,1,""],TIMEOUT_TYPE_SLOW:[2,3,1,""]},"com.vmware.nsx.model_client.LbAppProfile":{RESOURCE_TYPE_LBFASTTCPPROFILE:[2,3,1,""],RESOURCE_TYPE_LBFASTUDPPROFILE:[2,3,1,""],RESOURCE_TYPE_LBHTTPPROFILE:[2,3,1,""]},"com.vmware.nsx.model_client.LbClientCertificateIssuerDnCondition":{MATCH_TYPE_CONTAINS:[2,3,1,""],MATCH_TYPE_ENDS_WITH:[2,3,1,""],MATCH_TYPE_EQUALS:[2,3,1,""],MATCH_TYPE_REGEX:[2,3,1,""],MATCH_TYPE_STARTS_WITH:[2,3,1,""]},"com.vmware.nsx.model_client.LbClientCertificateSubjectDnCondition":{MATCH_TYPE_CONTAINS:[2,3,1,""],MATCH_TYPE_ENDS_WITH:[2,3,1,""],MATCH_TYPE_EQUALS:[2,3,1,""],MATCH_TYPE_REGEX:[2,3,1,""],MATCH_TYPE_STARTS_WITH:[2,3,1,""]},"com.vmware.nsx.model_client.LbClientSslProfile":{CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256:[2,3,1,""],CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA:[2,3,1,""],CIPHERS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256:[2,3,1,""],CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384:[2,3,1,""],CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA:[2,3,1,""],CIPHERS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384:[2,3,1,""],CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHA256:[2,3,1,""],CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHA:[2,3,1,""],CIPHERS_ECDHE_RSA_WITH_AES_128_GCM_SHA256:[2,3,1,""],CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHA384:[2,3,1,""],CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHA:[2,3,1,""],CIPHERS_ECDHE_RSA_WITH_AES_256_GCM_SHA384:[2,3,1,""],CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256:[2,3,1,""],CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHA:[2,3,1,""],CIPHERS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256:[2,3,1,""],CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384:[2,3,1,""],CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHA:[2,3,1,""],CIPHERS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384:[2,3,1,""],CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHA256:[2,3,1,""],CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHA:[2,3,1,""],CIPHERS_ECDH_RSA_WITH_AES_128_GCM_SHA256:[2,3,1,""],CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHA384:[2,3,1,""],CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHA:[2,3,1,""],CIPHERS_ECDH_RSA_WITH_AES_256_GCM_SHA384:[2,3,1,""],CIPHERS_RSA_WITH_3DES_EDE_CBC_SHA:[2,3,1,""],CIPHERS_RSA_WITH_AES_128_CBC_SHA256:[2,3,1,""],CIPHERS_RSA_WITH_AES_128_CBC_SHA:[2,3,1,""],CIPHERS_RSA_WITH_AES_128_GCM_SHA256:[2,3,1,""],CIPHERS_RSA_WITH_AES_256_CBC_SHA256:[2,3,1,""],CIPHERS_RSA_WITH_AES_256_CBC_SHA:[2,3,1,""],CIPHERS_RSA_WITH_AES_256_GCM_SHA384:[2,3,1,""],CIPHER_GROUP_LABEL_BALANCED:[2,3,1,""],CIPHER_GROUP_LABEL_CUSTOM:[2,3,1,""],CIPHER_GROUP_LABEL_HIGH_COMPATIBILITY:[2,3,1,""],CIPHER_GROUP_LABEL_HIGH_SECURITY:[2,3,1,""],PROTOCOLS_SSL_V2:[2,3,1,""],PROTOCOLS_SSL_V3:[2,3,1,""],PROTOCOLS_TLS_V1:[2,3,1,""],PROTOCOLS_TLS_V1_1:[2,3,1,""],PROTOCOLS_TLS_V1_2:[2,3,1,""]},"com.vmware.nsx.model_client.LbCookiePersistenceProfile":{COOKIE_MODE_INSERT:[2,3,1,""],COOKIE_MODE_PREFIX:[2,3,1,""],COOKIE_MODE_REWRITE:[2,3,1,""]},"com.vmware.nsx.model_client.LbCookieTime":{TYPE_LBPERSISTENCECOOKIETIME:[2,3,1,""],TYPE_LBSESSIONCOOKIETIME:[2,3,1,""]},"com.vmware.nsx.model_client.LbHttpMonitor":{REQUEST_METHOD_GET:[2,3,1,""],REQUEST_METHOD_HEAD:[2,3,1,""],REQUEST_METHOD_OPTIONS:[2,3,1,""],REQUEST_METHOD_POST:[2,3,1,""],REQUEST_METHOD_PUT:[2,3,1,""],REQUEST_VERSION_1_0:[2,3,1,""],REQUEST_VERSION_1_1:[2,3,1,""],REQUEST_VERSION_2_0:[2,3,1,""]},"com.vmware.nsx.model_client.LbHttpProfile":{XFORWARDED_FOR_INSERT:[2,3,1,""],XFORWARDED_FOR_REPLACE:[2,3,1,""]},"com.vmware.nsx.model_client.LbHttpRequestBodyCondition":{MATCH_TYPE_CONTAINS:[2,3,1,""],MATCH_TYPE_ENDS_WITH:[2,3,1,""],MATCH_TYPE_EQUALS:[2,3,1,""],MATCH_TYPE_REGEX:[2,3,1,""],MATCH_TYPE_STARTS_WITH:[2,3,1,""]},"com.vmware.nsx.model_client.LbHttpRequestCookieCondition":{MATCH_TYPE_CONTAINS:[2,3,1,""],MATCH_TYPE_ENDS_WITH:[2,3,1,""],MATCH_TYPE_EQUALS:[2,3,1,""],MATCH_TYPE_REGEX:[2,3,1,""],MATCH_TYPE_STARTS_WITH:[2,3,1,""]},"com.vmware.nsx.model_client.LbHttpRequestHeaderCondition":{MATCH_TYPE_CONTAINS:[2,3,1,""],MATCH_TYPE_ENDS_WITH:[2,3,1,""],MATCH_TYPE_EQUALS:[2,3,1,""],MATCH_TYPE_REGEX:[2,3,1,""],MATCH_TYPE_STARTS_WITH:[2,3,1,""]},"com.vmware.nsx.model_client.LbHttpRequestMethodCondition":{METHOD_GET:[2,3,1,""],METHOD_HEAD:[2,3,1,""],METHOD_OPTIONS:[2,3,1,""],METHOD_POST:[2,3,1,""],METHOD_PUT:[2,3,1,""]},"com.vmware.nsx.model_client.LbHttpRequestUriArgumentsCondition":{MATCH_TYPE_CONTAINS:[2,3,1,""],MATCH_TYPE_ENDS_WITH:[2,3,1,""],MATCH_TYPE_EQUALS:[2,3,1,""],MATCH_TYPE_REGEX:[2,3,1,""],MATCH_TYPE_STARTS_WITH:[2,3,1,""]},"com.vmware.nsx.model_client.LbHttpRequestUriCondition":{MATCH_TYPE_CONTAINS:[2,3,1,""],MATCH_TYPE_ENDS_WITH:[2,3,1,""],MATCH_TYPE_EQUALS:[2,3,1,""],MATCH_TYPE_REGEX:[2,3,1,""],MATCH_TYPE_STARTS_WITH:[2,3,1,""]},"com.vmware.nsx.model_client.LbHttpRequestVersionCondition":{VERSION_1_0:[2,3,1,""],VERSION_1_1:[2,3,1,""],VERSION_2_0:[2,3,1,""]},"com.vmware.nsx.model_client.LbHttpResponseHeaderCondition":{MATCH_TYPE_CONTAINS:[2,3,1,""],MATCH_TYPE_ENDS_WITH:[2,3,1,""],MATCH_TYPE_EQUALS:[2,3,1,""],MATCH_TYPE_REGEX:[2,3,1,""],MATCH_TYPE_STARTS_WITH:[2,3,1,""]},"com.vmware.nsx.model_client.LbHttpSslCondition":{CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256:[2,3,1,""],CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA:[2,3,1,""],CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256:[2,3,1,""],CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384:[2,3,1,""],CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA:[2,3,1,""],CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384:[2,3,1,""],CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHA256:[2,3,1,""],CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHA:[2,3,1,""],CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_RSA_WITH_AES_128_GCM_SHA256:[2,3,1,""],CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHA384:[2,3,1,""],CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHA:[2,3,1,""],CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_RSA_WITH_AES_256_GCM_SHA384:[2,3,1,""],CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256:[2,3,1,""],CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHA:[2,3,1,""],CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256:[2,3,1,""],CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384:[2,3,1,""],CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHA:[2,3,1,""],CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384:[2,3,1,""],CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHA256:[2,3,1,""],CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHA:[2,3,1,""],CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_RSA_WITH_AES_128_GCM_SHA256:[2,3,1,""],CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHA384:[2,3,1,""],CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHA:[2,3,1,""],CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_RSA_WITH_AES_256_GCM_SHA384:[2,3,1,""],CLIENT_SUPPORTED_SSL_CIPHERS_RSA_WITH_3DES_EDE_CBC_SHA:[2,3,1,""],CLIENT_SUPPORTED_SSL_CIPHERS_RSA_WITH_AES_128_CBC_SHA256:[2,3,1,""],CLIENT_SUPPORTED_SSL_CIPHERS_RSA_WITH_AES_128_CBC_SHA:[2,3,1,""],CLIENT_SUPPORTED_SSL_CIPHERS_RSA_WITH_AES_128_GCM_SHA256:[2,3,1,""],CLIENT_SUPPORTED_SSL_CIPHERS_RSA_WITH_AES_256_CBC_SHA256:[2,3,1,""],CLIENT_SUPPORTED_SSL_CIPHERS_RSA_WITH_AES_256_CBC_SHA:[2,3,1,""],CLIENT_SUPPORTED_SSL_CIPHERS_RSA_WITH_AES_256_GCM_SHA384:[2,3,1,""],SESSION_REUSED_IGNORE:[2,3,1,""],SESSION_REUSED_NEW:[2,3,1,""],SESSION_REUSED_REUSED:[2,3,1,""],USED_PROTOCOL_SSL_V2:[2,3,1,""],USED_PROTOCOL_SSL_V3:[2,3,1,""],USED_PROTOCOL_TLS_V1:[2,3,1,""],USED_PROTOCOL_TLS_V1_1:[2,3,1,""],USED_PROTOCOL_TLS_V1_2:[2,3,1,""],USED_SSL_CIPHER_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256:[2,3,1,""],USED_SSL_CIPHER_ECDHE_ECDSA_WITH_AES_128_CBC_SHA:[2,3,1,""],USED_SSL_CIPHER_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256:[2,3,1,""],USED_SSL_CIPHER_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384:[2,3,1,""],USED_SSL_CIPHER_ECDHE_ECDSA_WITH_AES_256_CBC_SHA:[2,3,1,""],USED_SSL_CIPHER_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384:[2,3,1,""],USED_SSL_CIPHER_ECDHE_RSA_WITH_AES_128_CBC_SHA256:[2,3,1,""],USED_SSL_CIPHER_ECDHE_RSA_WITH_AES_128_CBC_SHA:[2,3,1,""],USED_SSL_CIPHER_ECDHE_RSA_WITH_AES_128_GCM_SHA256:[2,3,1,""],USED_SSL_CIPHER_ECDHE_RSA_WITH_AES_256_CBC_SHA384:[2,3,1,""],USED_SSL_CIPHER_ECDHE_RSA_WITH_AES_256_CBC_SHA:[2,3,1,""],USED_SSL_CIPHER_ECDHE_RSA_WITH_AES_256_GCM_SHA384:[2,3,1,""],USED_SSL_CIPHER_ECDH_ECDSA_WITH_AES_128_CBC_SHA256:[2,3,1,""],USED_SSL_CIPHER_ECDH_ECDSA_WITH_AES_128_CBC_SHA:[2,3,1,""],USED_SSL_CIPHER_ECDH_ECDSA_WITH_AES_128_GCM_SHA256:[2,3,1,""],USED_SSL_CIPHER_ECDH_ECDSA_WITH_AES_256_CBC_SHA384:[2,3,1,""],USED_SSL_CIPHER_ECDH_ECDSA_WITH_AES_256_CBC_SHA:[2,3,1,""],USED_SSL_CIPHER_ECDH_ECDSA_WITH_AES_256_GCM_SHA384:[2,3,1,""],USED_SSL_CIPHER_ECDH_RSA_WITH_AES_128_CBC_SHA256:[2,3,1,""],USED_SSL_CIPHER_ECDH_RSA_WITH_AES_128_CBC_SHA:[2,3,1,""],USED_SSL_CIPHER_ECDH_RSA_WITH_AES_128_GCM_SHA256:[2,3,1,""],USED_SSL_CIPHER_ECDH_RSA_WITH_AES_256_CBC_SHA384:[2,3,1,""],USED_SSL_CIPHER_ECDH_RSA_WITH_AES_256_CBC_SHA:[2,3,1,""],USED_SSL_CIPHER_ECDH_RSA_WITH_AES_256_GCM_SHA384:[2,3,1,""],USED_SSL_CIPHER_RSA_WITH_3DES_EDE_CBC_SHA:[2,3,1,""],USED_SSL_CIPHER_RSA_WITH_AES_128_CBC_SHA256:[2,3,1,""],USED_SSL_CIPHER_RSA_WITH_AES_128_CBC_SHA:[2,3,1,""],USED_SSL_CIPHER_RSA_WITH_AES_128_GCM_SHA256:[2,3,1,""],USED_SSL_CIPHER_RSA_WITH_AES_256_CBC_SHA256:[2,3,1,""],USED_SSL_CIPHER_RSA_WITH_AES_256_CBC_SHA:[2,3,1,""],USED_SSL_CIPHER_RSA_WITH_AES_256_GCM_SHA384:[2,3,1,""]},"com.vmware.nsx.model_client.LbHttpsMonitor":{CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256:[2,3,1,""],CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA:[2,3,1,""],CIPHERS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256:[2,3,1,""],CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384:[2,3,1,""],CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA:[2,3,1,""],CIPHERS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384:[2,3,1,""],CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHA256:[2,3,1,""],CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHA:[2,3,1,""],CIPHERS_ECDHE_RSA_WITH_AES_128_GCM_SHA256:[2,3,1,""],CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHA384:[2,3,1,""],CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHA:[2,3,1,""],CIPHERS_ECDHE_RSA_WITH_AES_256_GCM_SHA384:[2,3,1,""],CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256:[2,3,1,""],CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHA:[2,3,1,""],CIPHERS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256:[2,3,1,""],CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384:[2,3,1,""],CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHA:[2,3,1,""],CIPHERS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384:[2,3,1,""],CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHA256:[2,3,1,""],CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHA:[2,3,1,""],CIPHERS_ECDH_RSA_WITH_AES_128_GCM_SHA256:[2,3,1,""],CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHA384:[2,3,1,""],CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHA:[2,3,1,""],CIPHERS_ECDH_RSA_WITH_AES_256_GCM_SHA384:[2,3,1,""],CIPHERS_RSA_WITH_3DES_EDE_CBC_SHA:[2,3,1,""],CIPHERS_RSA_WITH_AES_128_CBC_SHA256:[2,3,1,""],CIPHERS_RSA_WITH_AES_128_CBC_SHA:[2,3,1,""],CIPHERS_RSA_WITH_AES_128_GCM_SHA256:[2,3,1,""],CIPHERS_RSA_WITH_AES_256_CBC_SHA256:[2,3,1,""],CIPHERS_RSA_WITH_AES_256_CBC_SHA:[2,3,1,""],CIPHERS_RSA_WITH_AES_256_GCM_SHA384:[2,3,1,""],CIPHER_GROUP_LABEL_BALANCED:[2,3,1,""],CIPHER_GROUP_LABEL_CUSTOM:[2,3,1,""],CIPHER_GROUP_LABEL_HIGH_COMPATIBILITY:[2,3,1,""],CIPHER_GROUP_LABEL_HIGH_SECURITY:[2,3,1,""],PROTOCOLS_SSL_V2:[2,3,1,""],PROTOCOLS_SSL_V3:[2,3,1,""],PROTOCOLS_TLS_V1:[2,3,1,""],PROTOCOLS_TLS_V1_1:[2,3,1,""],PROTOCOLS_TLS_V1_2:[2,3,1,""],REQUEST_METHOD_GET:[2,3,1,""],REQUEST_METHOD_HEAD:[2,3,1,""],REQUEST_METHOD_OPTIONS:[2,3,1,""],REQUEST_METHOD_POST:[2,3,1,""],REQUEST_METHOD_PUT:[2,3,1,""],REQUEST_VERSION_1_0:[2,3,1,""],REQUEST_VERSION_1_1:[2,3,1,""],REQUEST_VERSION_2_0:[2,3,1,""],SERVER_AUTH_IGNORE:[2,3,1,""],SERVER_AUTH_REQUIRED:[2,3,1,""]},"com.vmware.nsx.model_client.LbMonitor":{RESOURCE_TYPE_LBHTTPMONITOR:[2,3,1,""],RESOURCE_TYPE_LBHTTPSMONITOR:[2,3,1,""],RESOURCE_TYPE_LBICMPMONITOR:[2,3,1,""],RESOURCE_TYPE_LBPASSIVEMONITOR:[2,3,1,""],RESOURCE_TYPE_LBTCPMONITOR:[2,3,1,""],RESOURCE_TYPE_LBUDPMONITOR:[2,3,1,""]},"com.vmware.nsx.model_client.LbPersistenceProfile":{RESOURCE_TYPE_LBCOOKIEPERSISTENCEPROFILE:[2,3,1,""],RESOURCE_TYPE_LBSOURCEIPPERSISTENCEPROFILE:[2,3,1,""]},"com.vmware.nsx.model_client.LbPool":{ALGORITHM_IP_HASH:[2,3,1,""],ALGORITHM_LEAST_CONNECTION:[2,3,1,""],ALGORITHM_ROUND_ROBIN:[2,3,1,""],ALGORITHM_WEIGHTED_LEAST_CONNECTION:[2,3,1,""],ALGORITHM_WEIGHTED_ROUND_ROBIN:[2,3,1,""]},"com.vmware.nsx.model_client.LbPoolMemberStatus":{STATUS_DISABLED:[2,3,1,""],STATUS_DOWN:[2,3,1,""],STATUS_GRACEFUL_DISABLED:[2,3,1,""],STATUS_UNUSED:[2,3,1,""],STATUS_UP:[2,3,1,""]},"com.vmware.nsx.model_client.LbPoolStatus":{STATUS_DETACHED:[2,3,1,""],STATUS_DOWN:[2,3,1,""],STATUS_PARTIALLY_UP:[2,3,1,""],STATUS_PRIMARY_DOWN:[2,3,1,""],STATUS_UNKNOWN:[2,3,1,""],STATUS_UP:[2,3,1,""]},"com.vmware.nsx.model_client.LbRule":{MATCH_STRATEGY_ALL:[2,3,1,""],MATCH_STRATEGY_ANY:[2,3,1,""],PHASE_FORWARDING:[2,3,1,""],PHASE_REQUEST_REWRITE:[2,3,1,""],PHASE_RESPONSE_REWRITE:[2,3,1,""]},"com.vmware.nsx.model_client.LbRuleAction":{TYPE_LBHTTPREDIRECTACTION:[2,3,1,""],TYPE_LBHTTPREJECTACTION:[2,3,1,""],TYPE_LBHTTPREQUESTHEADERDELETEACTION:[2,3,1,""],TYPE_LBHTTPREQUESTHEADERREWRITEACTION:[2,3,1,""],TYPE_LBHTTPREQUESTURIREWRITEACTION:[2,3,1,""],TYPE_LBHTTPRESPONSEHEADERDELETEACTION:[2,3,1,""],TYPE_LBHTTPRESPONSEHEADERREWRITEACTION:[2,3,1,""],TYPE_LBSELECTPOOLACTION:[2,3,1,""],TYPE_LBSELECTSERVERACTION:[2,3,1,""],TYPE_LBVARIABLEASSIGNMENTACTION:[2,3,1,""]},"com.vmware.nsx.model_client.LbRuleCondition":{TYPE_LBHTTPREQUESTBODYCONDITION:[2,3,1,""],TYPE_LBHTTPREQUESTCOOKIECONDITION:[2,3,1,""],TYPE_LBHTTPREQUESTHEADERCONDITION:[2,3,1,""],TYPE_LBHTTPREQUESTMETHODCONDITION:[2,3,1,""],TYPE_LBHTTPREQUESTURIARGUMENTSCONDITION:[2,3,1,""],TYPE_LBHTTPREQUESTURICONDITION:[2,3,1,""],TYPE_LBHTTPREQUESTVERSIONCONDITION:[2,3,1,""],TYPE_LBHTTPRESPONSEHEADERCONDITION:[2,3,1,""],TYPE_LBHTTPSSLCONDITION:[2,3,1,""],TYPE_LBIPHEADERCONDITION:[2,3,1,""],TYPE_LBTCPHEADERCONDITION:[2,3,1,""],TYPE_LBVARIABLECONDITION:[2,3,1,""]},"com.vmware.nsx.model_client.LbServerSslProfile":{CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256:[2,3,1,""],CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA:[2,3,1,""],CIPHERS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256:[2,3,1,""],CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384:[2,3,1,""],CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA:[2,3,1,""],CIPHERS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384:[2,3,1,""],CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHA256:[2,3,1,""],CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHA:[2,3,1,""],CIPHERS_ECDHE_RSA_WITH_AES_128_GCM_SHA256:[2,3,1,""],CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHA384:[2,3,1,""],CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHA:[2,3,1,""],CIPHERS_ECDHE_RSA_WITH_AES_256_GCM_SHA384:[2,3,1,""],CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256:[2,3,1,""],CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHA:[2,3,1,""],CIPHERS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256:[2,3,1,""],CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384:[2,3,1,""],CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHA:[2,3,1,""],CIPHERS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384:[2,3,1,""],CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHA256:[2,3,1,""],CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHA:[2,3,1,""],CIPHERS_ECDH_RSA_WITH_AES_128_GCM_SHA256:[2,3,1,""],CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHA384:[2,3,1,""],CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHA:[2,3,1,""],CIPHERS_ECDH_RSA_WITH_AES_256_GCM_SHA384:[2,3,1,""],CIPHERS_RSA_WITH_3DES_EDE_CBC_SHA:[2,3,1,""],CIPHERS_RSA_WITH_AES_128_CBC_SHA256:[2,3,1,""],CIPHERS_RSA_WITH_AES_128_CBC_SHA:[2,3,1,""],CIPHERS_RSA_WITH_AES_128_GCM_SHA256:[2,3,1,""],CIPHERS_RSA_WITH_AES_256_CBC_SHA256:[2,3,1,""],CIPHERS_RSA_WITH_AES_256_CBC_SHA:[2,3,1,""],CIPHERS_RSA_WITH_AES_256_GCM_SHA384:[2,3,1,""],CIPHER_GROUP_LABEL_BALANCED:[2,3,1,""],CIPHER_GROUP_LABEL_CUSTOM:[2,3,1,""],CIPHER_GROUP_LABEL_HIGH_COMPATIBILITY:[2,3,1,""],CIPHER_GROUP_LABEL_HIGH_SECURITY:[2,3,1,""],PROTOCOLS_SSL_V2:[2,3,1,""],PROTOCOLS_SSL_V3:[2,3,1,""],PROTOCOLS_TLS_V1:[2,3,1,""],PROTOCOLS_TLS_V1_1:[2,3,1,""],PROTOCOLS_TLS_V1_2:[2,3,1,""]},"com.vmware.nsx.model_client.LbService":{ERROR_LOG_LEVEL_ALERT:[2,3,1,""],ERROR_LOG_LEVEL_CRITICAL:[2,3,1,""],ERROR_LOG_LEVEL_DEBUG:[2,3,1,""],ERROR_LOG_LEVEL_EMERGENCY:[2,3,1,""],ERROR_LOG_LEVEL_ERROR:[2,3,1,""],ERROR_LOG_LEVEL_INFO:[2,3,1,""],ERROR_LOG_LEVEL_WARNING:[2,3,1,""],SIZE_LARGE:[2,3,1,""],SIZE_MEDIUM:[2,3,1,""],SIZE_SMALL:[2,3,1,""]},"com.vmware.nsx.model_client.LbServiceStatus":{SERVICE_STATUS_DETACHED:[2,3,1,""],SERVICE_STATUS_DISABLED:[2,3,1,""],SERVICE_STATUS_DOWN:[2,3,1,""],SERVICE_STATUS_ERROR:[2,3,1,""],SERVICE_STATUS_NO_STANDBY:[2,3,1,""],SERVICE_STATUS_UNKNOWN:[2,3,1,""],SERVICE_STATUS_UP:[2,3,1,""]},"com.vmware.nsx.model_client.LbServiceUsage":{SERVICE_SIZE_LARGE:[2,3,1,""],SERVICE_SIZE_MEDIUM:[2,3,1,""],SERVICE_SIZE_SMALL:[2,3,1,""]},"com.vmware.nsx.model_client.LbSnatTranslation":{TYPE_LBSNATAUTOMAP:[2,3,1,""],TYPE_LBSNATIPPOOL:[2,3,1,""]},"com.vmware.nsx.model_client.LbSourceIpPersistenceProfile":{PURGE_FULL:[2,3,1,""],PURGE_NO_PURGE:[2,3,1,""]},"com.vmware.nsx.model_client.LbSslCipherInfo":{CIPHER_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256:[2,3,1,""],CIPHER_ECDHE_ECDSA_WITH_AES_128_CBC_SHA:[2,3,1,""],CIPHER_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256:[2,3,1,""],CIPHER_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384:[2,3,1,""],CIPHER_ECDHE_ECDSA_WITH_AES_256_CBC_SHA:[2,3,1,""],CIPHER_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384:[2,3,1,""],CIPHER_ECDHE_RSA_WITH_AES_128_CBC_SHA256:[2,3,1,""],CIPHER_ECDHE_RSA_WITH_AES_128_CBC_SHA:[2,3,1,""],CIPHER_ECDHE_RSA_WITH_AES_128_GCM_SHA256:[2,3,1,""],CIPHER_ECDHE_RSA_WITH_AES_256_CBC_SHA384:[2,3,1,""],CIPHER_ECDHE_RSA_WITH_AES_256_CBC_SHA:[2,3,1,""],CIPHER_ECDHE_RSA_WITH_AES_256_GCM_SHA384:[2,3,1,""],CIPHER_ECDH_ECDSA_WITH_AES_128_CBC_SHA256:[2,3,1,""],CIPHER_ECDH_ECDSA_WITH_AES_128_CBC_SHA:[2,3,1,""],CIPHER_ECDH_ECDSA_WITH_AES_128_GCM_SHA256:[2,3,1,""],CIPHER_ECDH_ECDSA_WITH_AES_256_CBC_SHA384:[2,3,1,""],CIPHER_ECDH_ECDSA_WITH_AES_256_CBC_SHA:[2,3,1,""],CIPHER_ECDH_ECDSA_WITH_AES_256_GCM_SHA384:[2,3,1,""],CIPHER_ECDH_RSA_WITH_AES_128_CBC_SHA256:[2,3,1,""],CIPHER_ECDH_RSA_WITH_AES_128_CBC_SHA:[2,3,1,""],CIPHER_ECDH_RSA_WITH_AES_128_GCM_SHA256:[2,3,1,""],CIPHER_ECDH_RSA_WITH_AES_256_CBC_SHA384:[2,3,1,""],CIPHER_ECDH_RSA_WITH_AES_256_CBC_SHA:[2,3,1,""],CIPHER_ECDH_RSA_WITH_AES_256_GCM_SHA384:[2,3,1,""],CIPHER_GROUP_LABELS_BALANCED:[2,3,1,""],CIPHER_GROUP_LABELS_CUSTOM:[2,3,1,""],CIPHER_GROUP_LABELS_HIGH_COMPATIBILITY:[2,3,1,""],CIPHER_GROUP_LABELS_HIGH_SECURITY:[2,3,1,""],CIPHER_RSA_WITH_3DES_EDE_CBC_SHA:[2,3,1,""],CIPHER_RSA_WITH_AES_128_CBC_SHA256:[2,3,1,""],CIPHER_RSA_WITH_AES_128_CBC_SHA:[2,3,1,""],CIPHER_RSA_WITH_AES_128_GCM_SHA256:[2,3,1,""],CIPHER_RSA_WITH_AES_256_CBC_SHA256:[2,3,1,""],CIPHER_RSA_WITH_AES_256_CBC_SHA:[2,3,1,""],CIPHER_RSA_WITH_AES_256_GCM_SHA384:[2,3,1,""]},"com.vmware.nsx.model_client.LbSslProtocolInfo":{PROTOCOL_SSL_V2:[2,3,1,""],PROTOCOL_SSL_V3:[2,3,1,""],PROTOCOL_TLS_V1:[2,3,1,""],PROTOCOL_TLS_V1_1:[2,3,1,""],PROTOCOL_TLS_V1_2:[2,3,1,""]},"com.vmware.nsx.model_client.LbVariableCondition":{MATCH_TYPE_CONTAINS:[2,3,1,""],MATCH_TYPE_ENDS_WITH:[2,3,1,""],MATCH_TYPE_EQUALS:[2,3,1,""],MATCH_TYPE_REGEX:[2,3,1,""],MATCH_TYPE_STARTS_WITH:[2,3,1,""]},"com.vmware.nsx.model_client.LbVirtualServer":{IP_PROTOCOL_TCP:[2,3,1,""],IP_PROTOCOL_UDP:[2,3,1,""]},"com.vmware.nsx.model_client.LbVirtualServerStatus":{STATUS_DETACHED:[2,3,1,""],STATUS_DISABLED:[2,3,1,""],STATUS_DOWN:[2,3,1,""],STATUS_PARTIALLY_UP:[2,3,1,""],STATUS_PRIMARY_DOWN:[2,3,1,""],STATUS_UNKNOWN:[2,3,1,""],STATUS_UP:[2,3,1,""]},"com.vmware.nsx.model_client.License":{CAPACITY_TYPE_CPU:[2,3,1,""],CAPACITY_TYPE_USER:[2,3,1,""],CAPACITY_TYPE_VM:[2,3,1,""]},"com.vmware.nsx.model_client.LoadBalancerAllocationPool":{ALLOCATION_SIZE_LARGE:[2,3,1,""],ALLOCATION_SIZE_MEDIUM:[2,3,1,""],ALLOCATION_SIZE_SMALL:[2,3,1,""]},"com.vmware.nsx.model_client.LogicalPort":{ADMIN_STATE_DOWN:[2,3,1,""],ADMIN_STATE_UP:[2,3,1,""],INIT_STATE_VLAN:[2,3,1,""]},"com.vmware.nsx.model_client.LogicalPortAttachment":{ATTACHMENT_TYPE_BRIDGEENDPOINT:[2,3,1,""],ATTACHMENT_TYPE_DHCP_SERVICE:[2,3,1,""],ATTACHMENT_TYPE_L2VPN_SESSION:[2,3,1,""],ATTACHMENT_TYPE_LOGICALROUTER:[2,3,1,""],ATTACHMENT_TYPE_METADATA_PROXY:[2,3,1,""],ATTACHMENT_TYPE_VIF:[2,3,1,""]},"com.vmware.nsx.model_client.LogicalPortMacTableCsvEntry":{MAC_TYPE_LEARNED:[2,3,1,""],MAC_TYPE_STATIC:[2,3,1,""]},"com.vmware.nsx.model_client.LogicalPortMacTableEntry":{MAC_TYPE_LEARNED:[2,3,1,""],MAC_TYPE_STATIC:[2,3,1,""]},"com.vmware.nsx.model_client.LogicalPortOperationalStatus":{STATUS_DOWN:[2,3,1,""],STATUS_UNKNOWN:[2,3,1,""],STATUS_UP:[2,3,1,""]},"com.vmware.nsx.model_client.LogicalRouter":{FAILOVER_MODE_NON_PREEMPTIVE:[2,3,1,""],FAILOVER_MODE_PREEMPTIVE:[2,3,1,""],HIGH_AVAILABILITY_MODE_ACTIVE:[2,3,1,""],HIGH_AVAILABILITY_MODE_STANDBY:[2,3,1,""],ROUTER_TYPE_TIER0:[2,3,1,""],ROUTER_TYPE_TIER1:[2,3,1,""]},"com.vmware.nsx.model_client.LogicalRouterCentralizedServicePort":{URPF_MODE_NONE:[2,3,1,""],URPF_MODE_STRICT:[2,3,1,""]},"com.vmware.nsx.model_client.LogicalRouterDownLinkPort":{URPF_MODE_NONE:[2,3,1,""],URPF_MODE_STRICT:[2,3,1,""]},"com.vmware.nsx.model_client.LogicalRouterIPTunnelPort":{ADMIN_STATE_DOWN:[2,3,1,""],ADMIN_STATE_UP:[2,3,1,""]},"com.vmware.nsx.model_client.LogicalRouterPort":{RESOURCE_TYPE_LOGICALROUTERCENTRALIZEDSERVICEPORT:[2,3,1,""],RESOURCE_TYPE_LOGICALROUTERDOWNLINKPORT:[2,3,1,""],RESOURCE_TYPE_LOGICALROUTERIPTUNNELPORT:[2,3,1,""],RESOURCE_TYPE_LOGICALROUTERLINKPORTONTIER0:[2,3,1,""],RESOURCE_TYPE_LOGICALROUTERLINKPORTONTIER1:[2,3,1,""],RESOURCE_TYPE_LOGICALROUTERLOOPBACKPORT:[2,3,1,""],RESOURCE_TYPE_LOGICALROUTERUPLINKPORT:[2,3,1,""]},"com.vmware.nsx.model_client.LogicalRouterStatusPerNode":{HIGH_AVAILABILITY_STATUS_ACTIVE:[2,3,1,""],HIGH_AVAILABILITY_STATUS_DOWN:[2,3,1,""],HIGH_AVAILABILITY_STATUS_STANDBY:[2,3,1,""],HIGH_AVAILABILITY_STATUS_SYNC:[2,3,1,""],HIGH_AVAILABILITY_STATUS_UNKNOWN:[2,3,1,""]},"com.vmware.nsx.model_client.LogicalRouterUpLinkPort":{URPF_MODE_NONE:[2,3,1,""],URPF_MODE_STRICT:[2,3,1,""]},"com.vmware.nsx.model_client.LogicalService":{RESOURCE_TYPE_DHCPRELAYSERVICE:[2,3,1,""]},"com.vmware.nsx.model_client.LogicalSwitch":{ADMIN_STATE_DOWN:[2,3,1,""],ADMIN_STATE_UP:[2,3,1,""],REPLICATION_MODE_MTEP:[2,3,1,""],REPLICATION_MODE_SOURCE:[2,3,1,""]},"com.vmware.nsx.model_client.LogicalSwitchState":{STATE_FAILED:[2,3,1,""],STATE_IN_PROGRESS:[2,3,1,""],STATE_ORPHANED:[2,3,1,""],STATE_PARTIAL_SUCCESS:[2,3,1,""],STATE_PENDING:[2,3,1,""],STATE_SUCCESS:[2,3,1,""],STATE_UNKNOWN:[2,3,1,""]},"com.vmware.nsx.model_client.MacLearningSpec":{LIMIT_POLICY_ALLOW:[2,3,1,""],LIMIT_POLICY_DROP:[2,3,1,""]},"com.vmware.nsx.model_client.ManagementClusterNodeStatus":{MGMT_CLUSTER_STATUS_CONNECTED:[2,3,1,""],MGMT_CLUSTER_STATUS_DISCONNECTED:[2,3,1,""],MGMT_CLUSTER_STATUS_UNKNOWN:[2,3,1,""]},"com.vmware.nsx.model_client.ManagementClusterRoleConfig":{TYPE_CONTROLLERCLUSTERROLECONFIG:[2,3,1,""],TYPE_MANAGEMENTCLUSTERROLECONFIG:[2,3,1,""]},"com.vmware.nsx.model_client.ManagementClusterStatus":{STATUS_INITIALIZING:[2,3,1,""],STATUS_STABLE:[2,3,1,""],STATUS_UNKNOWN:[2,3,1,""],STATUS_UNSTABLE:[2,3,1,""]},"com.vmware.nsx.model_client.MandatoryAccessControlProperties":{STATUS_DISABLED:[2,3,1,""],STATUS_ENABLED:[2,3,1,""],STATUS_ENABLED_PENDING_REBOOT:[2,3,1,""]},"com.vmware.nsx.model_client.MetadataProxy":{CRYPTO_PROTOCOLS_V1:[2,3,1,""],CRYPTO_PROTOCOLS_V1_1:[2,3,1,""],CRYPTO_PROTOCOLS_V1_2:[2,3,1,""]},"com.vmware.nsx.model_client.MetadataProxyStatus":{PROXY_STATUS_DOWN:[2,3,1,""],PROXY_STATUS_ERROR:[2,3,1,""],PROXY_STATUS_NO_BACKUP:[2,3,1,""],PROXY_STATUS_UP:[2,3,1,""]},"com.vmware.nsx.model_client.MgmtConnStatus":{CONNECTIVITY_STATUS_CONNECTED:[2,3,1,""],CONNECTIVITY_STATUS_DISCONNECTED:[2,3,1,""],CONNECTIVITY_STATUS_UNKNOWN:[2,3,1,""]},"com.vmware.nsx.model_client.MigrationBundleUploadStatus":{STATUS_FAILED:[2,3,1,""],STATUS_SUCCESS:[2,3,1,""],STATUS_UPLOADING:[2,3,1,""],STATUS_VERIFYING:[2,3,1,""]},"com.vmware.nsx.model_client.MigrationStatus":{OVERALL_MIGRATION_STATUS_FAILED:[2,3,1,""],OVERALL_MIGRATION_STATUS_IN_PROGRESS:[2,3,1,""],OVERALL_MIGRATION_STATUS_NOT_STARTED:[2,3,1,""],OVERALL_MIGRATION_STATUS_PAUSED:[2,3,1,""],OVERALL_MIGRATION_STATUS_SUCCESS:[2,3,1,""]},"com.vmware.nsx.model_client.MigrationSummary":{MIGRATION_STATUS_FAILED:[2,3,1,""],MIGRATION_STATUS_IN_PROGRESS:[2,3,1,""],MIGRATION_STATUS_NOT_STARTED:[2,3,1,""],MIGRATION_STATUS_PAUSED:[2,3,1,""],MIGRATION_STATUS_SUCCESS:[2,3,1,""]},"com.vmware.nsx.model_client.MigrationUnitAggregateInfo":{STATUS_FAILED:[2,3,1,""],STATUS_IN_PROGRESS:[2,3,1,""],STATUS_NOT_STARTED:[2,3,1,""],STATUS_PAUSED:[2,3,1,""],STATUS_SUCCESS:[2,3,1,""]},"com.vmware.nsx.model_client.MigrationUnitGroupAggregateInfo":{STATUS_FAILED:[2,3,1,""],STATUS_IN_PROGRESS:[2,3,1,""],STATUS_NOT_STARTED:[2,3,1,""],STATUS_PAUSED:[2,3,1,""],STATUS_SUCCESS:[2,3,1,""]},"com.vmware.nsx.model_client.MigrationUnitGroupStatus":{STATUS_FAILED:[2,3,1,""],STATUS_IN_PROGRESS:[2,3,1,""],STATUS_NOT_STARTED:[2,3,1,""],STATUS_PAUSED:[2,3,1,""],STATUS_SUCCESS:[2,3,1,""]},"com.vmware.nsx.model_client.MigrationUnitStatus":{STATUS_FAILED:[2,3,1,""],STATUS_IN_PROGRESS:[2,3,1,""],STATUS_NOT_STARTED:[2,3,1,""],STATUS_PAUSED:[2,3,1,""],STATUS_SUCCESS:[2,3,1,""]},"com.vmware.nsx.model_client.MirrorDestination":{RESOURCE_TYPE_IPMIRRORDESTINATION:[2,3,1,""],RESOURCE_TYPE_LOGICALPORTMIRRORDESTINATION:[2,3,1,""],RESOURCE_TYPE_PNICMIRRORDESTINATION:[2,3,1,""]},"com.vmware.nsx.model_client.MirrorSource":{RESOURCE_TYPE_LOGICALPORTMIRRORSOURCE:[2,3,1,""],RESOURCE_TYPE_LOGICALSWITCHMIRRORSOURCE:[2,3,1,""],RESOURCE_TYPE_PNICMIRRORSOURCE:[2,3,1,""],RESOURCE_TYPE_VLANMIRRORSOURCE:[2,3,1,""]},"com.vmware.nsx.model_client.NSGroupExpression":{RESOURCE_TYPE_NSGROUPCOMPLEXEXPRESSION:[2,3,1,""],RESOURCE_TYPE_NSGROUPSIMPLEEXPRESSION:[2,3,1,""],RESOURCE_TYPE_NSGROUPTAGEXPRESSION:[2,3,1,""]},"com.vmware.nsx.model_client.NSGroupSimpleExpression":{OP_CONTAINS:[2,3,1,""],OP_EQUALS:[2,3,1,""],OP_STARTSWITH:[2,3,1,""],TARGET_TYPE_DIRECTORYGROUP:[2,3,1,""],TARGET_TYPE_IPSET:[2,3,1,""],TARGET_TYPE_LOGICALPORT:[2,3,1,""],TARGET_TYPE_LOGICALSWITCH:[2,3,1,""],TARGET_TYPE_MACSET:[2,3,1,""],TARGET_TYPE_NSGROUP:[2,3,1,""],TARGET_TYPE_VIRTUALMACHINE:[2,3,1,""]},"com.vmware.nsx.model_client.NSGroupTagExpression":{SCOPE_OP_EQUALS:[2,3,1,""],TAG_OP_EQUALS:[2,3,1,""],TARGET_TYPE_LOGICALPORT:[2,3,1,""],TARGET_TYPE_LOGICALSWITCH:[2,3,1,""],TARGET_TYPE_VIRTUALMACHINE:[2,3,1,""]},"com.vmware.nsx.model_client.NSServiceElement":{RESOURCE_TYPE_ALGTYPENSSERVICE:[2,3,1,""],RESOURCE_TYPE_ETHERTYPENSSERVICE:[2,3,1,""],RESOURCE_TYPE_ICMPTYPENSSERVICE:[2,3,1,""],RESOURCE_TYPE_IGMPTYPENSSERVICE:[2,3,1,""],RESOURCE_TYPE_IPPROTOCOLNSSERVICE:[2,3,1,""],RESOURCE_TYPE_L4PORTSETNSSERVICE:[2,3,1,""]},"com.vmware.nsx.model_client.NSServiceGroup":{SERVICE_TYPE_ETHER:[2,3,1,""],SERVICE_TYPE_NON_ETHER:[2,3,1,""]},"com.vmware.nsx.model_client.NamedTeamingPolicy":{POLICY_FAILOVER_ORDER:[2,3,1,""],POLICY_LOADBALANCE_SRCID:[2,3,1,""]},"com.vmware.nsx.model_client.NatRule":{ACTION_DNAT:[2,3,1,""],ACTION_NO_DNAT:[2,3,1,""],ACTION_NO_NAT:[2,3,1,""],ACTION_NO_SNAT:[2,3,1,""],ACTION_REFLEXIVE:[2,3,1,""],ACTION_SNAT:[2,3,1,""]},"com.vmware.nsx.model_client.NetworkMigrationSpec":{RESOURCE_TYPE_HOSTPROFILENETWORKMIGRATIONSPEC:[2,3,1,""]},"com.vmware.nsx.model_client.NetworkMigrationSpecTypeIdEntry":{KEY_HOSTPROFILENETWORKMIGRATIONSPEC:[2,3,1,""]},"com.vmware.nsx.model_client.NicMetadata":{INTERFACE_TYPE_DATA1:[2,3,1,""],INTERFACE_TYPE_DATA2:[2,3,1,""],INTERFACE_TYPE_HA1:[2,3,1,""],INTERFACE_TYPE_HA2:[2,3,1,""],INTERFACE_TYPE_MANAGEMENT:[2,3,1,""]},"com.vmware.nsx.model_client.NodeIdServicesMap":{SERVICE_TYPES_API:[2,3,1,""],SERVICE_TYPES_MGMT_CLUSTER:[2,3,1,""],SERVICE_TYPES_MGMT_PLANE:[2,3,1,""]},"com.vmware.nsx.model_client.NodeInterfaceAlias":{IP_CONFIGURATION_DHCP:[2,3,1,""],IP_CONFIGURATION_NOT_CONFIGURED:[2,3,1,""],IP_CONFIGURATION_STATIC:[2,3,1,""]},"com.vmware.nsx.model_client.NodeInterfaceProperties":{ADMIN_STATUS_DOWN:[2,3,1,""],ADMIN_STATUS_UP:[2,3,1,""],INTERFACE_TYPE_PHYSICAL:[2,3,1,""],INTERFACE_TYPE_VIRTUAL:[2,3,1,""],LINK_STATUS_DOWN:[2,3,1,""],LINK_STATUS_UP:[2,3,1,""],SOURCE_CACHED:[2,3,1,""],SOURCE_REALTIME:[2,3,1,""]},"com.vmware.nsx.model_client.NodeInterfaceStatisticsProperties":{SOURCE_CACHED:[2,3,1,""],SOURCE_REALTIME:[2,3,1,""]},"com.vmware.nsx.model_client.NodeMode":{MODE_ID_ON_PREM:[2,3,1,""],MODE_ID_SERVICE:[2,3,1,""],MODE_ID_VMC:[2,3,1,""],MODE_ID_VMC_LOCAL:[2,3,1,""]},"com.vmware.nsx.model_client.NodeNetworkInterfaceProperties":{ADMIN_STATUS_DOWN:[2,3,1,""],ADMIN_STATUS_UP:[2,3,1,""],BOND_MODE_802_3AD:[2,3,1,""],BOND_MODE_ACTIVE_BACKUP:[2,3,1,""],IP_CONFIGURATION_DHCP:[2,3,1,""],IP_CONFIGURATION_NOT_CONFIGURED:[2,3,1,""],IP_CONFIGURATION_STATIC:[2,3,1,""],LINK_STATUS_DOWN:[2,3,1,""],LINK_STATUS_UP:[2,3,1,""],PLANE_DEBUG:[2,3,1,""],PLANE_MGMT:[2,3,1,""]},"com.vmware.nsx.model_client.NodeProperties":{EXPORT_TYPE_RESTRICTED:[2,3,1,""],EXPORT_TYPE_UNRESTRICTED:[2,3,1,""]},"com.vmware.nsx.model_client.NodeRouteProperties":{PROTO_BIRD:[2,3,1,""],PROTO_BOOT:[2,3,1,""],PROTO_DHCP:[2,3,1,""],PROTO_DNROUTED:[2,3,1,""],PROTO_GATED:[2,3,1,""],PROTO_KERNEL:[2,3,1,""],PROTO_MRT:[2,3,1,""],PROTO_NTK:[2,3,1,""],PROTO_RA:[2,3,1,""],PROTO_REDIRECT:[2,3,1,""],PROTO_STATIC:[2,3,1,""],PROTO_UNSPEC:[2,3,1,""],PROTO_XORP:[2,3,1,""],PROTO_ZEBRA:[2,3,1,""],ROUTE_TYPE_BLACKHOLE:[2,3,1,""],ROUTE_TYPE_DEFAULT:[2,3,1,""],ROUTE_TYPE_PROHIBIT:[2,3,1,""],ROUTE_TYPE_STATIC:[2,3,1,""],ROUTE_TYPE_THROW:[2,3,1,""],ROUTE_TYPE_UNREACHABLE:[2,3,1,""]},"com.vmware.nsx.model_client.NodeServiceStatusProperties":{MONITOR_RUNTIME_STATE_RUNNING:[2,3,1,""],MONITOR_RUNTIME_STATE_STOPPED:[2,3,1,""],RUNTIME_STATE_RUNNING:[2,3,1,""],RUNTIME_STATE_STOPPED:[2,3,1,""]},"com.vmware.nsx.model_client.NodeStatus":{HOST_NODE_DEPLOYMENT_STATUS_EDGE_CONFIG_ERROR:[2,3,1,""],HOST_NODE_DEPLOYMENT_STATUS_INSTALL_FAILED:[2,3,1,""],HOST_NODE_DEPLOYMENT_STATUS_INSTALL_IN_PROGRESS:[2,3,1,""],HOST_NODE_DEPLOYMENT_STATUS_INSTALL_SUCCESSFUL:[2,3,1,""],HOST_NODE_DEPLOYMENT_STATUS_NODE_NOT_READY:[2,3,1,""],HOST_NODE_DEPLOYMENT_STATUS_NODE_READY:[2,3,1,""],HOST_NODE_DEPLOYMENT_STATUS_NOT_AVAILABLE:[2,3,1,""],HOST_NODE_DEPLOYMENT_STATUS_NOT_PREPARED:[2,3,1,""],HOST_NODE_DEPLOYMENT_STATUS_PENDING_UPGRADE:[2,3,1,""],HOST_NODE_DEPLOYMENT_STATUS_REGISTRATION_FAILED:[2,3,1,""],HOST_NODE_DEPLOYMENT_STATUS_REGISTRATION_PENDING:[2,3,1,""],HOST_NODE_DEPLOYMENT_STATUS_UNINSTALL_FAILED:[2,3,1,""],HOST_NODE_DEPLOYMENT_STATUS_UNINSTALL_IN_PROGRESS:[2,3,1,""],HOST_NODE_DEPLOYMENT_STATUS_UNINSTALL_SUCCESSFUL:[2,3,1,""],HOST_NODE_DEPLOYMENT_STATUS_UPGRADE_FAILED:[2,3,1,""],HOST_NODE_DEPLOYMENT_STATUS_UPGRADE_IN_PROGRESS:[2,3,1,""],HOST_NODE_DEPLOYMENT_STATUS_VM_DEPLOYMENT_FAILED:[2,3,1,""],HOST_NODE_DEPLOYMENT_STATUS_VM_DEPLOYMENT_IN_PROGRESS:[2,3,1,""],HOST_NODE_DEPLOYMENT_STATUS_VM_DEPLOYMENT_QUEUED:[2,3,1,""],HOST_NODE_DEPLOYMENT_STATUS_VM_DEPLOYMENT_RESTARTED:[2,3,1,""],HOST_NODE_DEPLOYMENT_STATUS_VM_POWER_OFF_FAILED:[2,3,1,""],HOST_NODE_DEPLOYMENT_STATUS_VM_POWER_OFF_IN_PROGRESS:[2,3,1,""],HOST_NODE_DEPLOYMENT_STATUS_VM_POWER_ON_FAILED:[2,3,1,""],HOST_NODE_DEPLOYMENT_STATUS_VM_POWER_ON_IN_PROGRESS:[2,3,1,""],HOST_NODE_DEPLOYMENT_STATUS_VM_UNDEPLOY_FAILED:[2,3,1,""],HOST_NODE_DEPLOYMENT_STATUS_VM_UNDEPLOY_IN_PROGRESS:[2,3,1,""],HOST_NODE_DEPLOYMENT_STATUS_VM_UNDEPLOY_SUCCESSFUL:[2,3,1,""],LCP_CONNECTIVITY_STATUS_DEGRADED:[2,3,1,""],LCP_CONNECTIVITY_STATUS_DOWN:[2,3,1,""],LCP_CONNECTIVITY_STATUS_UNKNOWN:[2,3,1,""],LCP_CONNECTIVITY_STATUS_UP:[2,3,1,""],MAINTENANCE_MODE_ENTERING:[2,3,1,""],MAINTENANCE_MODE_EXITING:[2,3,1,""],MAINTENANCE_MODE_OFF:[2,3,1,""],MAINTENANCE_MODE_ON:[2,3,1,""],MPA_CONNECTIVITY_STATUS_DOWN:[2,3,1,""],MPA_CONNECTIVITY_STATUS_UNKNOWN:[2,3,1,""],MPA_CONNECTIVITY_STATUS_UP:[2,3,1,""]},"com.vmware.nsx.model_client.NodeStatusProperties":{SOURCE_CACHED:[2,3,1,""],SOURCE_REALTIME:[2,3,1,""]},"com.vmware.nsx.model_client.NodeSyslogExporterProperties":{FACILITIES_AUTH:[2,3,1,""],FACILITIES_AUTHPRIV:[2,3,1,""],FACILITIES_CRON:[2,3,1,""],FACILITIES_DAEMON:[2,3,1,""],FACILITIES_FTP:[2,3,1,""],FACILITIES_KERN:[2,3,1,""],FACILITIES_LOCAL0:[2,3,1,""],FACILITIES_LOCAL1:[2,3,1,""],FACILITIES_LOCAL2:[2,3,1,""],FACILITIES_LOCAL3:[2,3,1,""],FACILITIES_LOCAL4:[2,3,1,""],FACILITIES_LOCAL5:[2,3,1,""],FACILITIES_LOCAL6:[2,3,1,""],FACILITIES_LOCAL7:[2,3,1,""],FACILITIES_LOGALERT:[2,3,1,""],FACILITIES_LPR:[2,3,1,""],FACILITIES_MAIL:[2,3,1,""],FACILITIES_NEWS:[2,3,1,""],FACILITIES_SYSLOG:[2,3,1,""],FACILITIES_USER:[2,3,1,""],FACILITIES_UUCP:[2,3,1,""],LEVEL_ALERT:[2,3,1,""],LEVEL_CRIT:[2,3,1,""],LEVEL_DEBUG:[2,3,1,""],LEVEL_EMERG:[2,3,1,""],LEVEL_ERR:[2,3,1,""],LEVEL_INFO:[2,3,1,""],LEVEL_NOTICE:[2,3,1,""],LEVEL_WARNING:[2,3,1,""],PROTOCOL_LI:[2,3,1,""],PROTOCOL_LI_TLS:[2,3,1,""],PROTOCOL_TCP:[2,3,1,""],PROTOCOL_TLS:[2,3,1,""],PROTOCOL_UDP:[2,3,1,""]},"com.vmware.nsx.model_client.NsxRole":{PERMISSIONS_CRUD:[2,3,1,""],PERMISSIONS_EXECUTE:[2,3,1,""],PERMISSIONS_NONE:[2,3,1,""],PERMISSIONS_READ:[2,3,1,""],PERMISSIONS_READ_API:[2,3,1,""],PERMISSIONS_READ_WRITE_API:[2,3,1,""],ROLE_AUDITOR:[2,3,1,""],ROLE_CLOUD_ADMIN:[2,3,1,""],ROLE_CLOUD_AUDITOR:[2,3,1,""],ROLE_CLOUD_SERVICE_ADMIN:[2,3,1,""],ROLE_CLOUD_SERVICE_AUDITOR:[2,3,1,""],ROLE_ENTERPRISE_ADMIN:[2,3,1,""],ROLE_LB_ADMIN:[2,3,1,""],ROLE_LB_AUDITOR:[2,3,1,""],ROLE_NETWORK_ENGINEER:[2,3,1,""],ROLE_NETWORK_OP:[2,3,1,""],ROLE_READ_ONLY_API_USERS:[2,3,1,""],ROLE_READ_WRITE_API_USERS:[2,3,1,""],ROLE_SECURITY_ENGINEER:[2,3,1,""],ROLE_SECURITY_OP:[2,3,1,""],ROLE_SITE_RELIABILITY_AUDITOR:[2,3,1,""],ROLE_SITE_RELIABILITY_ENGINEER:[2,3,1,""]},"com.vmware.nsx.model_client.PBRInsertParameters":{OPERATION_AFTER:[2,3,1,""],OPERATION_BEFORE:[2,3,1,""],OPERATION_BOTTOM:[2,3,1,""],OPERATION_TOP:[2,3,1,""]},"com.vmware.nsx.model_client.PBRRule":{ACTION_OVERLAY:[2,3,1,""],ACTION_OVERLAY_NAT:[2,3,1,""],ACTION_UNDERLAY:[2,3,1,""],ACTION_UNDERLAY_NAT:[2,3,1,""]},"com.vmware.nsx.model_client.PacketCaptureOption":{NAME_DSTIP:[2,3,1,""],NAME_DSTMAC:[2,3,1,""],NAME_DSTPORT:[2,3,1,""],NAME_ETHTYPE:[2,3,1,""],NAME_IP:[2,3,1,""],NAME_IPPROTO:[2,3,1,""],NAME_MAC:[2,3,1,""],NAME_PORT:[2,3,1,""],NAME_SRCIP:[2,3,1,""],NAME_SRCMAC:[2,3,1,""],NAME_SRCPORT:[2,3,1,""],NAME_VLAN:[2,3,1,""],NAME_VNI:[2,3,1,""]},"com.vmware.nsx.model_client.PacketCaptureRequest":{CAPMODE_STANDALONE:[2,3,1,""],CAPMODE_STREAM:[2,3,1,""],CAPPOINT_DVFILTER:[2,3,1,""],CAPPOINT_LOGICALPORT:[2,3,1,""],CAPPOINT_VDRPORT:[2,3,1,""],CAPPOINT_VIF:[2,3,1,""],CAPPOINT_VMKNIC:[2,3,1,""],CAPPOINT_VMNIC:[2,3,1,""],CAPPOINT_VNIC:[2,3,1,""],CAPSOURCE_CLI:[2,3,1,""],CAPSOURCE_UI:[2,3,1,""],DIRECTION_DUAL:[2,3,1,""],DIRECTION_INPUT:[2,3,1,""],DIRECTION_OUTPUT:[2,3,1,""],FILTERTYPE_POST:[2,3,1,""],FILTERTYPE_PRE:[2,3,1,""]},"com.vmware.nsx.model_client.PacketCaptureSession":{SESSIONSTATUS_CREATED:[2,3,1,""],SESSIONSTATUS_ERROR:[2,3,1,""],SESSIONSTATUS_FINISHED:[2,3,1,""],SESSIONSTATUS_STARTED:[2,3,1,""],SESSIONSTATUS_STOPPED:[2,3,1,""]},"com.vmware.nsx.model_client.PacketData":{RESOURCE_TYPE_BINARYPACKETDATA:[2,3,1,""],RESOURCE_TYPE_FIELDSPACKETDATA:[2,3,1,""],TRANSPORT_TYPE_BROADCAST:[2,3,1,""],TRANSPORT_TYPE_MULTICAST:[2,3,1,""],TRANSPORT_TYPE_UNICAST:[2,3,1,""],TRANSPORT_TYPE_UNKNOWN:[2,3,1,""]},"com.vmware.nsx.model_client.PasswordAuthenticationScheme":{SCHEME_NAME_PASSWORD:[2,3,1,""]},"com.vmware.nsx.model_client.PerStepRestoreStatus":{VALUE_FAILED:[2,3,1,""],VALUE_INITIAL:[2,3,1,""],VALUE_RUNNING:[2,3,1,""],VALUE_SUCCESS:[2,3,1,""],VALUE_SUSPENDED_BY_USER:[2,3,1,""],VALUE_SUSPENDED_FOR_USER_ACTION:[2,3,1,""]},"com.vmware.nsx.model_client.PnicBondStatus":{STATUS_DEGRADED:[2,3,1,""],STATUS_DOWN:[2,3,1,""],STATUS_UNKNOWN:[2,3,1,""],STATUS_UP:[2,3,1,""],TYPE_BOND:[2,3,1,""],TYPE_PNIC:[2,3,1,""],TYPE_UNKNOWN_TYPE:[2,3,1,""]},"com.vmware.nsx.model_client.PoolMember":{ADMIN_STATE_DISABLED:[2,3,1,""],ADMIN_STATE_ENABLED:[2,3,1,""],ADMIN_STATE_GRACEFUL_DISABLED:[2,3,1,""]},"com.vmware.nsx.model_client.PoolMemberGroup":{IP_REVISION_FILTER_IPV4:[2,3,1,""],IP_REVISION_FILTER_IPV4_IPV6:[2,3,1,""],IP_REVISION_FILTER_IPV6:[2,3,1,""]},"com.vmware.nsx.model_client.PoolMemberSetting":{ADMIN_STATE_DISABLED:[2,3,1,""],ADMIN_STATE_ENABLED:[2,3,1,""],ADMIN_STATE_GRACEFUL_DISABLED:[2,3,1,""]},"com.vmware.nsx.model_client.PortMirroringSession":{DIRECTION_BIDIRECTIONAL:[2,3,1,""],DIRECTION_EGRESS:[2,3,1,""],DIRECTION_INGRESS:[2,3,1,""],SESSION_TYPE_L3PORTMIRRORSESSION:[2,3,1,""],SESSION_TYPE_LOCALPORTMIRRORSESSION:[2,3,1,""],SESSION_TYPE_LOGICALLOCALPORTMIRRORSESSION:[2,3,1,""],SESSION_TYPE_LOGICALPORTMIRRORSESSION:[2,3,1,""],SESSION_TYPE_RSPANDSTMIRRORSESSION:[2,3,1,""],SESSION_TYPE_RSPANSRCMIRRORSESSION:[2,3,1,""],SESSION_TYPE_UPLINKPORTMIRRORSESSION:[2,3,1,""]},"com.vmware.nsx.model_client.PortMirroringSwitchingProfile":{DIRECTION_BIDIRECTIONAL:[2,3,1,""],DIRECTION_EGRESS:[2,3,1,""],DIRECTION_INGRESS:[2,3,1,""]},"com.vmware.nsx.model_client.PrefixConfig":{ACTION_DENY:[2,3,1,""],ACTION_PERMIT:[2,3,1,""]},"com.vmware.nsx.model_client.PrincipalIdentity":{PERMISSION_GROUP_READ_ONLY_API_USERS:[2,3,1,""],PERMISSION_GROUP_READ_WRITE_API_USERS:[2,3,1,""],PERMISSION_GROUP_SUPERUSERS:[2,3,1,""],PERMISSION_GROUP_UNDEFINED:[2,3,1,""]},"com.vmware.nsx.model_client.PropertyItem":{TYPE_DATE:[2,3,1,""],TYPE_NUMBER:[2,3,1,""],TYPE_STRING:[2,3,1,""],TYPE_URL:[2,3,1,""]},"com.vmware.nsx.model_client.Protocol":{NAME_HTTP:[2,3,1,""],NAME_HTTPS:[2,3,1,""],NAME_SCP:[2,3,1,""],NAME_SFTP:[2,3,1,""]},"com.vmware.nsx.model_client.ProtonPackageLoggingLevels":{LOGGING_LEVEL_DEBUG:[2,3,1,""],LOGGING_LEVEL_ERROR:[2,3,1,""],LOGGING_LEVEL_INFO:[2,3,1,""],LOGGING_LEVEL_TRACE:[2,3,1,""],LOGGING_LEVEL_WARN:[2,3,1,""]},"com.vmware.nsx.model_client.ProtonServiceProperties":{LOGGING_LEVEL_DEBUG:[2,3,1,""],LOGGING_LEVEL_ERROR:[2,3,1,""],LOGGING_LEVEL_INFO:[2,3,1,""],LOGGING_LEVEL_TRACE:[2,3,1,""],LOGGING_LEVEL_WARN:[2,3,1,""]},"com.vmware.nsx.model_client.QosBaseRateShaper":{RESOURCE_TYPE_EGRESSRATESHAPER:[2,3,1,""],RESOURCE_TYPE_INGRESSBROADCASTRATESHAPER:[2,3,1,""],RESOURCE_TYPE_INGRESSRATESHAPER:[2,3,1,""]},"com.vmware.nsx.model_client.RedistributionRule":{DESTINATION_BGP:[2,3,1,""],DESTINATION_NSX_CONNECTED:[2,3,1,""],DESTINATION_NSX_STATIC:[2,3,1,""],DESTINATION_STATIC:[2,3,1,""],DESTINATION_TIER0_NAT:[2,3,1,""],DESTINATION_TIER1_LB_SNAT:[2,3,1,""],DESTINATION_TIER1_LB_VIP:[2,3,1,""],DESTINATION_TIER1_NAT:[2,3,1,""],SOURCES_BGP:[2,3,1,""],SOURCES_NSX_CONNECTED:[2,3,1,""],SOURCES_NSX_STATIC:[2,3,1,""],SOURCES_STATIC:[2,3,1,""],SOURCES_TIER0_NAT:[2,3,1,""],SOURCES_TIER1_LB_SNAT:[2,3,1,""],SOURCES_TIER1_LB_VIP:[2,3,1,""],SOURCES_TIER1_NAT:[2,3,1,""]},"com.vmware.nsx.model_client.RemainingSupportBundleNode":{STATUS_PENDING:[2,3,1,""],STATUS_PROCESSING:[2,3,1,""]},"com.vmware.nsx.model_client.RenderConfiguration":{COLOR_BLUE:[2,3,1,""],COLOR_GREEN:[2,3,1,""],COLOR_GREY:[2,3,1,""],COLOR_RED:[2,3,1,""],COLOR_SKY_BLUE:[2,3,1,""],COLOR_YELLOW:[2,3,1,""]},"com.vmware.nsx.model_client.RepoSyncStatusReport":{STATUS_FAILED:[2,3,1,""],STATUS_IN_PROGRESS:[2,3,1,""],STATUS_NOT_STARTED:[2,3,1,""],STATUS_SUCCESS:[2,3,1,""]},"com.vmware.nsx.model_client.RoleBinding":{STALE_FALSE:[2,3,1,""],STALE_TRUE:[2,3,1,""],STALE_UNKNOWN:[2,3,1,""],TYPE_LOCAL_USER:[2,3,1,""],TYPE_PRINCIPAL_IDENTITY:[2,3,1,""],TYPE_REMOTE_GROUP:[2,3,1,""],TYPE_REMOTE_USER:[2,3,1,""]},"com.vmware.nsx.model_client.RouteMapSequence":{ACTION_DENY:[2,3,1,""],ACTION_PERMIT:[2,3,1,""]},"com.vmware.nsx.model_client.RuleState":{STATE_FAILED:[2,3,1,""],STATE_IN_PROGRESS:[2,3,1,""],STATE_ORPHANED:[2,3,1,""],STATE_PARTIAL_SUCCESS:[2,3,1,""],STATE_PENDING:[2,3,1,""],STATE_SUCCESS:[2,3,1,""],STATE_UNKNOWN:[2,3,1,""]},"com.vmware.nsx.model_client.RuntimeInterfaceOperationalStatus":{STATUS_DOWN:[2,3,1,""],STATUS_UNKNOWN:[2,3,1,""],STATUS_UP:[2,3,1,""]},"com.vmware.nsx.model_client.SVMDeploymentSpec":{HOST_TYPE_ESXI:[2,3,1,""],HOST_TYPE_RHELKVM:[2,3,1,""],HOST_TYPE_UBUNTUKVM:[2,3,1,""],SERVICE_FORM_FACTOR_LARGE:[2,3,1,""],SERVICE_FORM_FACTOR_MEDIUM:[2,3,1,""],SERVICE_FORM_FACTOR_SMALL:[2,3,1,""]},"com.vmware.nsx.model_client.ServerSslProfileBinding":{SERVER_AUTH_IGNORE:[2,3,1,""],SERVER_AUTH_REQUIRED:[2,3,1,""]},"com.vmware.nsx.model_client.ServiceAssociationListResult":{SERVICE_TYPE_FIREWALLSERVICEASSOCIATIONLISTRESULT:[2,3,1,""],SERVICE_TYPE_IPFIXSERVICEASSOCIATIONLISTRESULT:[2,3,1,""]},"com.vmware.nsx.model_client.ServiceAttachment":{ATTACHMENT_STATUS_DOWN:[2,3,1,""],ATTACHMENT_STATUS_UP:[2,3,1,""]},"com.vmware.nsx.model_client.ServiceDefinition":{ATTACHMENT_POINT_TIER0_LR:[2,3,1,""],ATTACHMENT_POINT_TIER1_LR:[2,3,1,""],FUNCTIONALITIES_HCX:[2,3,1,""],FUNCTIONALITIES_IDS_IPS:[2,3,1,""],FUNCTIONALITIES_NG_FW:[2,3,1,""],IMPLEMENTATIONS_EAST_WEST:[2,3,1,""],IMPLEMENTATIONS_NORTH_SOUTH:[2,3,1,""],ON_FAILURE_POLICY_ALLOW:[2,3,1,""],ON_FAILURE_POLICY_BLOCK:[2,3,1,""],TRANSPORTS_L2_BRIDGE:[2,3,1,""],TRANSPORTS_L3_ROUTED:[2,3,1,""]},"com.vmware.nsx.model_client.ServiceInsertionRule":{ACTION_ALLOW:[2,3,1,""],ACTION_DO_NOT_REDIRECT:[2,3,1,""],ACTION_DROP:[2,3,1,""],ACTION_REDIRECT:[2,3,1,""],ACTION_REJECT:[2,3,1,""],DIRECTION_IN:[2,3,1,""],DIRECTION_IN_OUT:[2,3,1,""],DIRECTION_OUT:[2,3,1,""],IP_PROTOCOL_IPV4:[2,3,1,""],IP_PROTOCOL_IPV4_IPV6:[2,3,1,""],IP_PROTOCOL_IPV6:[2,3,1,""]},"com.vmware.nsx.model_client.ServiceInsertionSection":{SECTION_TYPE_L3REDIRECT:[2,3,1,""],SECTION_TYPE_LAYER2:[2,3,1,""],SECTION_TYPE_LAYER3:[2,3,1,""]},"com.vmware.nsx.model_client.ServiceInsertionSectionRuleList":{SECTION_TYPE_L3REDIRECT:[2,3,1,""],SECTION_TYPE_LAYER2:[2,3,1,""],SECTION_TYPE_LAYER3:[2,3,1,""]},"com.vmware.nsx.model_client.ServiceInstance":{ATTACHMENT_POINT_TIER0_LR:[2,3,1,""],ATTACHMENT_POINT_TIER1_LR:[2,3,1,""],DEPLOYMENT_MODE_ACTIVE_STANDBY:[2,3,1,""],DEPLOYMENT_MODE_STAND_ALONE:[2,3,1,""],IMPLEMENTATION_TYPE_EAST_WEST:[2,3,1,""],IMPLEMENTATION_TYPE_NORTH_SOUTH:[2,3,1,""]},"com.vmware.nsx.model_client.ServiceProfile":{RESOURCE_TYPE_DHCPRELAYPROFILE:[2,3,1,""]},"com.vmware.nsx.model_client.SnmpCommunity":{ACCESS_ONLY:[2,3,1,""]},"com.vmware.nsx.model_client.SpoofGuardSwitchingProfile":{WHITE_LIST_PROVIDERS_LPORT_BINDINGS:[2,3,1,""],WHITE_LIST_PROVIDERS_LSWITCH_BINDINGS:[2,3,1,""]},"com.vmware.nsx.model_client.StaticRouteNextHop":{BLACKHOLE_ACTION_DISCARD:[2,3,1,""]},"com.vmware.nsx.model_client.StatusCount":{STATUS_DEGRADED:[2,3,1,""],STATUS_DOWN:[2,3,1,""],STATUS_UNKNOWN:[2,3,1,""],STATUS_UP:[2,3,1,""]},"com.vmware.nsx.model_client.SupportBundleFileTransferAuthenticationScheme":{SCHEME_NAME_PASSWORD:[2,3,1,""]},"com.vmware.nsx.model_client.SupportBundleFileTransferProtocol":{NAME_SCP:[2,3,1,""],NAME_SFTP:[2,3,1,""]},"com.vmware.nsx.model_client.SupportBundleRequest":{CONTENT_FILTERS_ALL:[2,3,1,""],CONTENT_FILTERS_DEFAULT:[2,3,1,""]},"com.vmware.nsx.model_client.SwitchingProfileTypeIdEntry":{KEY_IPDISCOVERYSWITCHINGPROFILE:[2,3,1,""],KEY_MACMANAGEMENTSWITCHINGPROFILE:[2,3,1,""],KEY_PORTMIRRORINGSWITCHINGPROFILE:[2,3,1,""],KEY_QOSSWITCHINGPROFILE:[2,3,1,""],KEY_SPOOFGUARDSWITCHINGPROFILE:[2,3,1,""],KEY_SWITCHSECURITYSWITCHINGPROFILE:[2,3,1,""]},"com.vmware.nsx.model_client.SwitchingToVmcModeParameters":{MODE_ID_ON_PREM:[2,3,1,""],MODE_ID_SERVICE:[2,3,1,""],MODE_ID_VMC:[2,3,1,""],MODE_ID_VMC_LOCAL:[2,3,1,""]},"com.vmware.nsx.model_client.TargetResourceStatus":{TARGET_STATUS_DISABLED:[2,3,1,""],TARGET_STATUS_ENABLED:[2,3,1,""]},"com.vmware.nsx.model_client.TaskProperties":{STATUS_CANCELED:[2,3,1,""],STATUS_CANCELING:[2,3,1,""],STATUS_ERROR:[2,3,1,""],STATUS_KILLED:[2,3,1,""],STATUS_RUNNING:[2,3,1,""],STATUS_SUCCESS:[2,3,1,""]},"com.vmware.nsx.model_client.TeamingPolicy":{POLICY_FAILOVER_ORDER:[2,3,1,""],POLICY_LOADBALANCE_SRCID:[2,3,1,""]},"com.vmware.nsx.model_client.TelemetryProxy":{SCHEME_HTTP:[2,3,1,""],SCHEME_HTTPS:[2,3,1,""]},"com.vmware.nsx.model_client.Traceflow":{OPERATION_STATE_FAILED:[2,3,1,""],OPERATION_STATE_FINISHED:[2,3,1,""],OPERATION_STATE_IN_PROGRESS:[2,3,1,""],REQUEST_STATUS_CONNECTION_ERROR:[2,3,1,""],REQUEST_STATUS_DATA_PATH_NOT_READY:[2,3,1,""],REQUEST_STATUS_SOURCE_PORT_NOT_FOUND:[2,3,1,""],REQUEST_STATUS_SUCCESS:[2,3,1,""],REQUEST_STATUS_TIMEOUT:[2,3,1,""]},"com.vmware.nsx.model_client.TraceflowObservation":{COMPONENT_SUB_TYPE_LR_TIER0:[2,3,1,""],COMPONENT_SUB_TYPE_LR_TIER1:[2,3,1,""],COMPONENT_SUB_TYPE_LR_VRF_TIER0:[2,3,1,""],COMPONENT_SUB_TYPE_LS_TRANSIT:[2,3,1,""],COMPONENT_SUB_TYPE_UNKNOWN:[2,3,1,""],COMPONENT_TYPE_BRIDGE:[2,3,1,""],COMPONENT_TYPE_DFW:[2,3,1,""],COMPONENT_TYPE_EDGE_HOSTSWITCH:[2,3,1,""],COMPONENT_TYPE_EDGE_TUNNEL:[2,3,1,""],COMPONENT_TYPE_LR:[2,3,1,""],COMPONENT_TYPE_LS:[2,3,1,""],COMPONENT_TYPE_PHYSICAL:[2,3,1,""],COMPONENT_TYPE_UNKNOWN:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONDELIVERED:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPED:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPEDLOGICAL:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDED:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDEDLOGICAL:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVED:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVEDLOGICAL:[2,3,1,""],TRANSPORT_NODE_TYPE_EDGE:[2,3,1,""],TRANSPORT_NODE_TYPE_ESX:[2,3,1,""],TRANSPORT_NODE_TYPE_HYPERV:[2,3,1,""],TRANSPORT_NODE_TYPE_OTHERS:[2,3,1,""],TRANSPORT_NODE_TYPE_PUBLIC_CLOUD_GATEWAY_NODE:[2,3,1,""],TRANSPORT_NODE_TYPE_RHELKVM:[2,3,1,""],TRANSPORT_NODE_TYPE_UBUNTUKVM:[2,3,1,""]},"com.vmware.nsx.model_client.TraceflowObservationDelivered":{COMPONENT_SUB_TYPE_LR_TIER0:[2,3,1,""],COMPONENT_SUB_TYPE_LR_TIER1:[2,3,1,""],COMPONENT_SUB_TYPE_LR_VRF_TIER0:[2,3,1,""],COMPONENT_SUB_TYPE_LS_TRANSIT:[2,3,1,""],COMPONENT_SUB_TYPE_UNKNOWN:[2,3,1,""],COMPONENT_TYPE_BRIDGE:[2,3,1,""],COMPONENT_TYPE_DFW:[2,3,1,""],COMPONENT_TYPE_EDGE_HOSTSWITCH:[2,3,1,""],COMPONENT_TYPE_EDGE_TUNNEL:[2,3,1,""],COMPONENT_TYPE_LR:[2,3,1,""],COMPONENT_TYPE_LS:[2,3,1,""],COMPONENT_TYPE_PHYSICAL:[2,3,1,""],COMPONENT_TYPE_UNKNOWN:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONDELIVERED:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPED:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPEDLOGICAL:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDED:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDEDLOGICAL:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVED:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVEDLOGICAL:[2,3,1,""],TRANSPORT_NODE_TYPE_EDGE:[2,3,1,""],TRANSPORT_NODE_TYPE_ESX:[2,3,1,""],TRANSPORT_NODE_TYPE_HYPERV:[2,3,1,""],TRANSPORT_NODE_TYPE_OTHERS:[2,3,1,""],TRANSPORT_NODE_TYPE_PUBLIC_CLOUD_GATEWAY_NODE:[2,3,1,""],TRANSPORT_NODE_TYPE_RHELKVM:[2,3,1,""],TRANSPORT_NODE_TYPE_UBUNTUKVM:[2,3,1,""]},"com.vmware.nsx.model_client.TraceflowObservationDropped":{COMPONENT_SUB_TYPE_LR_TIER0:[2,3,1,""],COMPONENT_SUB_TYPE_LR_TIER1:[2,3,1,""],COMPONENT_SUB_TYPE_LR_VRF_TIER0:[2,3,1,""],COMPONENT_SUB_TYPE_LS_TRANSIT:[2,3,1,""],COMPONENT_SUB_TYPE_UNKNOWN:[2,3,1,""],COMPONENT_TYPE_BRIDGE:[2,3,1,""],COMPONENT_TYPE_DFW:[2,3,1,""],COMPONENT_TYPE_EDGE_HOSTSWITCH:[2,3,1,""],COMPONENT_TYPE_EDGE_TUNNEL:[2,3,1,""],COMPONENT_TYPE_LR:[2,3,1,""],COMPONENT_TYPE_LS:[2,3,1,""],COMPONENT_TYPE_PHYSICAL:[2,3,1,""],COMPONENT_TYPE_UNKNOWN:[2,3,1,""],REASON_ARP_FAIL:[2,3,1,""],REASON_BFD:[2,3,1,""],REASON_DHCP:[2,3,1,""],REASON_FW_RULE:[2,3,1,""],REASON_GENEVE:[2,3,1,""],REASON_GRE:[2,3,1,""],REASON_IFACE:[2,3,1,""],REASON_IP:[2,3,1,""],REASON_IPSEC:[2,3,1,""],REASON_IPSEC_VTI:[2,3,1,""],REASON_IP_REASS:[2,3,1,""],REASON_L2VPN:[2,3,1,""],REASON_L4PORT:[2,3,1,""],REASON_LB:[2,3,1,""],REASON_LROUTER:[2,3,1,""],REASON_LSERVICE:[2,3,1,""],REASON_LSWITCH:[2,3,1,""],REASON_MD_PROXY:[2,3,1,""],REASON_NAT:[2,3,1,""],REASON_NEIGH:[2,3,1,""],REASON_NO_ROUTE:[2,3,1,""],REASON_SERVICE_INSERT:[2,3,1,""],REASON_TTL_ZERO:[2,3,1,""],REASON_TUNNEL:[2,3,1,""],REASON_UNKNOWN:[2,3,1,""],REASON_VXLAN:[2,3,1,""],REASON_VXSTT:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONDELIVERED:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPED:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPEDLOGICAL:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDED:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDEDLOGICAL:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVED:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVEDLOGICAL:[2,3,1,""],TRANSPORT_NODE_TYPE_EDGE:[2,3,1,""],TRANSPORT_NODE_TYPE_ESX:[2,3,1,""],TRANSPORT_NODE_TYPE_HYPERV:[2,3,1,""],TRANSPORT_NODE_TYPE_OTHERS:[2,3,1,""],TRANSPORT_NODE_TYPE_PUBLIC_CLOUD_GATEWAY_NODE:[2,3,1,""],TRANSPORT_NODE_TYPE_RHELKVM:[2,3,1,""],TRANSPORT_NODE_TYPE_UBUNTUKVM:[2,3,1,""]},"com.vmware.nsx.model_client.TraceflowObservationDroppedLogical":{COMPONENT_SUB_TYPE_LR_TIER0:[2,3,1,""],COMPONENT_SUB_TYPE_LR_TIER1:[2,3,1,""],COMPONENT_SUB_TYPE_LR_VRF_TIER0:[2,3,1,""],COMPONENT_SUB_TYPE_LS_TRANSIT:[2,3,1,""],COMPONENT_SUB_TYPE_UNKNOWN:[2,3,1,""],COMPONENT_TYPE_BRIDGE:[2,3,1,""],COMPONENT_TYPE_DFW:[2,3,1,""],COMPONENT_TYPE_EDGE_HOSTSWITCH:[2,3,1,""],COMPONENT_TYPE_EDGE_TUNNEL:[2,3,1,""],COMPONENT_TYPE_LR:[2,3,1,""],COMPONENT_TYPE_LS:[2,3,1,""],COMPONENT_TYPE_PHYSICAL:[2,3,1,""],COMPONENT_TYPE_UNKNOWN:[2,3,1,""],REASON_ARP_FAIL:[2,3,1,""],REASON_BFD:[2,3,1,""],REASON_DHCP:[2,3,1,""],REASON_FW_RULE:[2,3,1,""],REASON_GENEVE:[2,3,1,""],REASON_GRE:[2,3,1,""],REASON_IFACE:[2,3,1,""],REASON_IP:[2,3,1,""],REASON_IPSEC:[2,3,1,""],REASON_IPSEC_VTI:[2,3,1,""],REASON_IP_REASS:[2,3,1,""],REASON_L2VPN:[2,3,1,""],REASON_L4PORT:[2,3,1,""],REASON_LB:[2,3,1,""],REASON_LROUTER:[2,3,1,""],REASON_LSERVICE:[2,3,1,""],REASON_LSWITCH:[2,3,1,""],REASON_MD_PROXY:[2,3,1,""],REASON_NAT:[2,3,1,""],REASON_NEIGH:[2,3,1,""],REASON_NO_ROUTE:[2,3,1,""],REASON_SERVICE_INSERT:[2,3,1,""],REASON_TTL_ZERO:[2,3,1,""],REASON_TUNNEL:[2,3,1,""],REASON_UNKNOWN:[2,3,1,""],REASON_VXLAN:[2,3,1,""],REASON_VXSTT:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONDELIVERED:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPED:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPEDLOGICAL:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDED:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDEDLOGICAL:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVED:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVEDLOGICAL:[2,3,1,""],TRANSPORT_NODE_TYPE_EDGE:[2,3,1,""],TRANSPORT_NODE_TYPE_ESX:[2,3,1,""],TRANSPORT_NODE_TYPE_HYPERV:[2,3,1,""],TRANSPORT_NODE_TYPE_OTHERS:[2,3,1,""],TRANSPORT_NODE_TYPE_PUBLIC_CLOUD_GATEWAY_NODE:[2,3,1,""],TRANSPORT_NODE_TYPE_RHELKVM:[2,3,1,""],TRANSPORT_NODE_TYPE_UBUNTUKVM:[2,3,1,""]},"com.vmware.nsx.model_client.TraceflowObservationForwarded":{COMPONENT_SUB_TYPE_LR_TIER0:[2,3,1,""],COMPONENT_SUB_TYPE_LR_TIER1:[2,3,1,""],COMPONENT_SUB_TYPE_LR_VRF_TIER0:[2,3,1,""],COMPONENT_SUB_TYPE_LS_TRANSIT:[2,3,1,""],COMPONENT_SUB_TYPE_UNKNOWN:[2,3,1,""],COMPONENT_TYPE_BRIDGE:[2,3,1,""],COMPONENT_TYPE_DFW:[2,3,1,""],COMPONENT_TYPE_EDGE_HOSTSWITCH:[2,3,1,""],COMPONENT_TYPE_EDGE_TUNNEL:[2,3,1,""],COMPONENT_TYPE_LR:[2,3,1,""],COMPONENT_TYPE_LS:[2,3,1,""],COMPONENT_TYPE_PHYSICAL:[2,3,1,""],COMPONENT_TYPE_UNKNOWN:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONDELIVERED:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPED:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPEDLOGICAL:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDED:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDEDLOGICAL:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVED:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVEDLOGICAL:[2,3,1,""],TRANSPORT_NODE_TYPE_EDGE:[2,3,1,""],TRANSPORT_NODE_TYPE_ESX:[2,3,1,""],TRANSPORT_NODE_TYPE_HYPERV:[2,3,1,""],TRANSPORT_NODE_TYPE_OTHERS:[2,3,1,""],TRANSPORT_NODE_TYPE_PUBLIC_CLOUD_GATEWAY_NODE:[2,3,1,""],TRANSPORT_NODE_TYPE_RHELKVM:[2,3,1,""],TRANSPORT_NODE_TYPE_UBUNTUKVM:[2,3,1,""]},"com.vmware.nsx.model_client.TraceflowObservationForwardedLogical":{COMPONENT_SUB_TYPE_LR_TIER0:[2,3,1,""],COMPONENT_SUB_TYPE_LR_TIER1:[2,3,1,""],COMPONENT_SUB_TYPE_LR_VRF_TIER0:[2,3,1,""],COMPONENT_SUB_TYPE_LS_TRANSIT:[2,3,1,""],COMPONENT_SUB_TYPE_UNKNOWN:[2,3,1,""],COMPONENT_TYPE_BRIDGE:[2,3,1,""],COMPONENT_TYPE_DFW:[2,3,1,""],COMPONENT_TYPE_EDGE_HOSTSWITCH:[2,3,1,""],COMPONENT_TYPE_EDGE_TUNNEL:[2,3,1,""],COMPONENT_TYPE_LR:[2,3,1,""],COMPONENT_TYPE_LS:[2,3,1,""],COMPONENT_TYPE_PHYSICAL:[2,3,1,""],COMPONENT_TYPE_UNKNOWN:[2,3,1,""],DST_COMPONENT_TYPE_BRIDGE:[2,3,1,""],DST_COMPONENT_TYPE_DFW:[2,3,1,""],DST_COMPONENT_TYPE_EDGE_HOSTSWITCH:[2,3,1,""],DST_COMPONENT_TYPE_EDGE_TUNNEL:[2,3,1,""],DST_COMPONENT_TYPE_LR:[2,3,1,""],DST_COMPONENT_TYPE_LS:[2,3,1,""],DST_COMPONENT_TYPE_PHYSICAL:[2,3,1,""],DST_COMPONENT_TYPE_UNKNOWN:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONDELIVERED:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPED:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPEDLOGICAL:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDED:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDEDLOGICAL:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVED:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVEDLOGICAL:[2,3,1,""],TRANSPORT_NODE_TYPE_EDGE:[2,3,1,""],TRANSPORT_NODE_TYPE_ESX:[2,3,1,""],TRANSPORT_NODE_TYPE_HYPERV:[2,3,1,""],TRANSPORT_NODE_TYPE_OTHERS:[2,3,1,""],TRANSPORT_NODE_TYPE_PUBLIC_CLOUD_GATEWAY_NODE:[2,3,1,""],TRANSPORT_NODE_TYPE_RHELKVM:[2,3,1,""],TRANSPORT_NODE_TYPE_UBUNTUKVM:[2,3,1,""]},"com.vmware.nsx.model_client.TraceflowObservationReceived":{COMPONENT_SUB_TYPE_LR_TIER0:[2,3,1,""],COMPONENT_SUB_TYPE_LR_TIER1:[2,3,1,""],COMPONENT_SUB_TYPE_LR_VRF_TIER0:[2,3,1,""],COMPONENT_SUB_TYPE_LS_TRANSIT:[2,3,1,""],COMPONENT_SUB_TYPE_UNKNOWN:[2,3,1,""],COMPONENT_TYPE_BRIDGE:[2,3,1,""],COMPONENT_TYPE_DFW:[2,3,1,""],COMPONENT_TYPE_EDGE_HOSTSWITCH:[2,3,1,""],COMPONENT_TYPE_EDGE_TUNNEL:[2,3,1,""],COMPONENT_TYPE_LR:[2,3,1,""],COMPONENT_TYPE_LS:[2,3,1,""],COMPONENT_TYPE_PHYSICAL:[2,3,1,""],COMPONENT_TYPE_UNKNOWN:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONDELIVERED:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPED:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPEDLOGICAL:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDED:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDEDLOGICAL:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVED:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVEDLOGICAL:[2,3,1,""],TRANSPORT_NODE_TYPE_EDGE:[2,3,1,""],TRANSPORT_NODE_TYPE_ESX:[2,3,1,""],TRANSPORT_NODE_TYPE_HYPERV:[2,3,1,""],TRANSPORT_NODE_TYPE_OTHERS:[2,3,1,""],TRANSPORT_NODE_TYPE_PUBLIC_CLOUD_GATEWAY_NODE:[2,3,1,""],TRANSPORT_NODE_TYPE_RHELKVM:[2,3,1,""],TRANSPORT_NODE_TYPE_UBUNTUKVM:[2,3,1,""]},"com.vmware.nsx.model_client.TraceflowObservationReceivedLogical":{COMPONENT_SUB_TYPE_LR_TIER0:[2,3,1,""],COMPONENT_SUB_TYPE_LR_TIER1:[2,3,1,""],COMPONENT_SUB_TYPE_LR_VRF_TIER0:[2,3,1,""],COMPONENT_SUB_TYPE_LS_TRANSIT:[2,3,1,""],COMPONENT_SUB_TYPE_UNKNOWN:[2,3,1,""],COMPONENT_TYPE_BRIDGE:[2,3,1,""],COMPONENT_TYPE_DFW:[2,3,1,""],COMPONENT_TYPE_EDGE_HOSTSWITCH:[2,3,1,""],COMPONENT_TYPE_EDGE_TUNNEL:[2,3,1,""],COMPONENT_TYPE_LR:[2,3,1,""],COMPONENT_TYPE_LS:[2,3,1,""],COMPONENT_TYPE_PHYSICAL:[2,3,1,""],COMPONENT_TYPE_UNKNOWN:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONDELIVERED:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPED:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPEDLOGICAL:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDED:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDEDLOGICAL:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVED:[2,3,1,""],RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVEDLOGICAL:[2,3,1,""],SRC_COMPONENT_TYPE_BRIDGE:[2,3,1,""],SRC_COMPONENT_TYPE_DFW:[2,3,1,""],SRC_COMPONENT_TYPE_EDGE_HOSTSWITCH:[2,3,1,""],SRC_COMPONENT_TYPE_EDGE_TUNNEL:[2,3,1,""],SRC_COMPONENT_TYPE_LR:[2,3,1,""],SRC_COMPONENT_TYPE_LS:[2,3,1,""],SRC_COMPONENT_TYPE_PHYSICAL:[2,3,1,""],SRC_COMPONENT_TYPE_UNKNOWN:[2,3,1,""],TRANSPORT_NODE_TYPE_EDGE:[2,3,1,""],TRANSPORT_NODE_TYPE_ESX:[2,3,1,""],TRANSPORT_NODE_TYPE_HYPERV:[2,3,1,""],TRANSPORT_NODE_TYPE_OTHERS:[2,3,1,""],TRANSPORT_NODE_TYPE_PUBLIC_CLOUD_GATEWAY_NODE:[2,3,1,""],TRANSPORT_NODE_TYPE_RHELKVM:[2,3,1,""],TRANSPORT_NODE_TYPE_UBUNTUKVM:[2,3,1,""]},"com.vmware.nsx.model_client.TransportNode":{MAINTENANCE_MODE_DISABLED:[2,3,1,""],MAINTENANCE_MODE_ENABLED:[2,3,1,""],MAINTENANCE_MODE_FORCE_ENABLED:[2,3,1,""]},"com.vmware.nsx.model_client.TransportNodeState":{MAINTENANCE_MODE_STATE_DISABLED:[2,3,1,""],MAINTENANCE_MODE_STATE_ENABLED:[2,3,1,""],MAINTENANCE_MODE_STATE_ENTERING:[2,3,1,""],MAINTENANCE_MODE_STATE_EXITING:[2,3,1,""],STATE_FAILED:[2,3,1,""],STATE_IN_PROGRESS:[2,3,1,""],STATE_ORPHANED:[2,3,1,""],STATE_PARTIAL_SUCCESS:[2,3,1,""],STATE_PENDING:[2,3,1,""],STATE_SUCCESS:[2,3,1,""],STATE_UNKNOWN:[2,3,1,""]},"com.vmware.nsx.model_client.TransportNodeStatus":{MGMT_CONNECTION_STATUS_DOWN:[2,3,1,""],MGMT_CONNECTION_STATUS_UP:[2,3,1,""],STATUS_DEGRADED:[2,3,1,""],STATUS_DOWN:[2,3,1,""],STATUS_UNKNOWN:[2,3,1,""],STATUS_UP:[2,3,1,""]},"com.vmware.nsx.model_client.TransportNodeTemplateState":{STATE_FAILED_TO_CREATE:[2,3,1,""],STATE_FAILED_TO_REALIZE:[2,3,1,""],STATE_IN_PROGRESS:[2,3,1,""],STATE_SUCCESS:[2,3,1,""]},"com.vmware.nsx.model_client.TransportZone":{HOST_SWITCH_MODE_ENS:[2,3,1,""],HOST_SWITCH_MODE_STANDARD:[2,3,1,""],TRANSPORT_TYPE_OVERLAY:[2,3,1,""],TRANSPORT_TYPE_VLAN:[2,3,1,""]},"com.vmware.nsx.model_client.TransportZoneProfile":{RESOURCE_TYPE_BFDHEALTHMONITORINGPROFILE:[2,3,1,""]},"com.vmware.nsx.model_client.TransportZoneProfileTypeIdEntry":{RESOURCE_TYPE_BFDHEALTHMONITORINGPROFILE:[2,3,1,""]},"com.vmware.nsx.model_client.TunnelProperties":{ENCAP_GENEVE:[2,3,1,""],ENCAP_STT:[2,3,1,""],ENCAP_UNKNOWN_ENCAP:[2,3,1,""],ENCAP_VXLAN:[2,3,1,""],STATUS_DOWN:[2,3,1,""],STATUS_UNKNOWN:[2,3,1,""],STATUS_UP:[2,3,1,""]},"com.vmware.nsx.model_client.TunnelStatusCount":{STATUS_DEGRADED:[2,3,1,""],STATUS_DOWN:[2,3,1,""],STATUS_UNKNOWN:[2,3,1,""],STATUS_UP:[2,3,1,""]},"com.vmware.nsx.model_client.UpgradeBundleUploadStatus":{STATUS_FAILED:[2,3,1,""],STATUS_SUCCESS:[2,3,1,""],STATUS_UPLOADING:[2,3,1,""],STATUS_VERIFYING:[2,3,1,""]},"com.vmware.nsx.model_client.UpgradeHistory":{UPGRADE_STATUS_FAILED:[2,3,1,""],UPGRADE_STATUS_STARTED:[2,3,1,""],UPGRADE_STATUS_SUCCESS:[2,3,1,""]},"com.vmware.nsx.model_client.UpgradeStatus":{OVERALL_UPGRADE_STATUS_FAILED:[2,3,1,""],OVERALL_UPGRADE_STATUS_IN_PROGRESS:[2,3,1,""],OVERALL_UPGRADE_STATUS_NOT_STARTED:[2,3,1,""],OVERALL_UPGRADE_STATUS_PAUSED:[2,3,1,""],OVERALL_UPGRADE_STATUS_SUCCESS:[2,3,1,""]},"com.vmware.nsx.model_client.UpgradeSummary":{UPGRADE_STATUS_FAILED:[2,3,1,""],UPGRADE_STATUS_IN_PROGRESS:[2,3,1,""],UPGRADE_STATUS_NOT_STARTED:[2,3,1,""],UPGRADE_STATUS_PAUSED:[2,3,1,""],UPGRADE_STATUS_SUCCESS:[2,3,1,""]},"com.vmware.nsx.model_client.UpgradeUnitAggregateInfo":{STATUS_FAILED:[2,3,1,""],STATUS_IN_PROGRESS:[2,3,1,""],STATUS_NOT_STARTED:[2,3,1,""],STATUS_PAUSED:[2,3,1,""],STATUS_SUCCESS:[2,3,1,""]},"com.vmware.nsx.model_client.UpgradeUnitGroupAggregateInfo":{STATUS_FAILED:[2,3,1,""],STATUS_IN_PROGRESS:[2,3,1,""],STATUS_NOT_STARTED:[2,3,1,""],STATUS_PAUSED:[2,3,1,""],STATUS_SUCCESS:[2,3,1,""]},"com.vmware.nsx.model_client.UpgradeUnitGroupStatus":{STATUS_FAILED:[2,3,1,""],STATUS_IN_PROGRESS:[2,3,1,""],STATUS_NOT_STARTED:[2,3,1,""],STATUS_PAUSED:[2,3,1,""],STATUS_SUCCESS:[2,3,1,""]},"com.vmware.nsx.model_client.UpgradeUnitStatus":{STATUS_FAILED:[2,3,1,""],STATUS_IN_PROGRESS:[2,3,1,""],STATUS_NOT_STARTED:[2,3,1,""],STATUS_PAUSED:[2,3,1,""],STATUS_SUCCESS:[2,3,1,""]},"com.vmware.nsx.model_client.Uplink":{UPLINK_TYPE_LAG:[2,3,1,""],UPLINK_TYPE_PNIC:[2,3,1,""]},"com.vmware.nsx.model_client.UplinkHostSwitchProfile":{OVERLAY_ENCAP_GENEVE:[2,3,1,""],OVERLAY_ENCAP_VXLAN:[2,3,1,""]},"com.vmware.nsx.model_client.VersionedDeploymentSpec":{HOST_TYPE_CENTOSKVM:[2,3,1,""],HOST_TYPE_CENTOSSERVER:[2,3,1,""],HOST_TYPE_ESXI:[2,3,1,""],HOST_TYPE_RHELCONTAINER:[2,3,1,""],HOST_TYPE_RHELKVM:[2,3,1,""],HOST_TYPE_RHELSERVER:[2,3,1,""],HOST_TYPE_UBUNTUKVM:[2,3,1,""],HOST_TYPE_UBUNTUSERVER:[2,3,1,""]},"com.vmware.nsx.model_client.VidmInfo":{TYPE_GROUP:[2,3,1,""],TYPE_USER:[2,3,1,""]},"com.vmware.nsx.model_client.VifAttachmentContext":{VIF_TYPE_CHILD:[2,3,1,""],VIF_TYPE_INDEPENDENT:[2,3,1,""],VIF_TYPE_PARENT:[2,3,1,""]},"com.vmware.nsx.model_client.VirtualMachine":{POWER_STATE_UNKNOWN:[2,3,1,""],POWER_STATE_VM_RUNNING:[2,3,1,""],POWER_STATE_VM_STOPPED:[2,3,1,""],POWER_STATE_VM_SUSPENDED:[2,3,1,""],TYPE_EDGE:[2,3,1,""],TYPE_REGULAR:[2,3,1,""],TYPE_SERVICE:[2,3,1,""]},"com.vmware.nsx.model_client.WeeklyTelemetrySchedule":{DAY_OF_WEEK_FRIDAY:[2,3,1,""],DAY_OF_WEEK_MONDAY:[2,3,1,""],DAY_OF_WEEK_SATURDAY:[2,3,1,""],DAY_OF_WEEK_SUNDAY:[2,3,1,""],DAY_OF_WEEK_THURSDAY:[2,3,1,""],DAY_OF_WEEK_TUESDAY:[2,3,1,""],DAY_OF_WEEK_WEDNESDAY:[2,3,1,""]},"com.vmware.nsx.model_client.WidgetConfiguration":{RESOURCE_TYPE_CONTAINERCONFIGURATION:[2,3,1,""],RESOURCE_TYPE_DONUTCONFIGURATION:[2,3,1,""],RESOURCE_TYPE_GRIDCONFIGURATION:[2,3,1,""],RESOURCE_TYPE_LABELVALUECONFIGURATION:[2,3,1,""],RESOURCE_TYPE_MULTIWIDGETCONFIGURATION:[2,3,1,""],RESOURCE_TYPE_STATSCONFIGURATION:[2,3,1,""]},"com.vmware.nsx.model_client.X509Certificate":{PUBLIC_KEY_ALGO_DSA:[2,3,1,""],PUBLIC_KEY_ALGO_RSA:[2,3,1,""]},"com.vmware.nsx.node":{aaa:[27,0,0,"-"],aaa_client:[26,0,0,"-"],file_store_client:[26,0,0,"-"],hardening_policy_client:[26,0,0,"-"],network:[29,0,0,"-"],network_client:[26,0,0,"-"],services:[30,0,0,"-"],services_client:[26,0,0,"-"],tasks_client:[26,0,0,"-"],users_client:[26,0,0,"-"]},"com.vmware.nsx.node.aaa":{providers:[28,0,0,"-"],providers_client:[27,0,0,"-"]},"com.vmware.nsx.node.aaa.providers":{vidm_client:[28,0,0,"-"]},"com.vmware.nsx.node.aaa.providers.vidm_client":{Status:[28,1,1,""],StubFactory:[28,1,1,""]},"com.vmware.nsx.node.aaa.providers.vidm_client.Status":{get:[28,2,1,""]},"com.vmware.nsx.node.aaa.providers_client":{StubFactory:[27,1,1,""],Vidm:[27,1,1,""]},"com.vmware.nsx.node.aaa.providers_client.Vidm":{get:[27,2,1,""],update:[27,2,1,""]},"com.vmware.nsx.node.aaa_client":{AuthPolicy:[26,1,1,""],StubFactory:[26,1,1,""]},"com.vmware.nsx.node.aaa_client.AuthPolicy":{get:[26,2,1,""],update:[26,2,1,""]},"com.vmware.nsx.node.file_store_client":{StubFactory:[26,1,1,""],Thumbprint:[26,1,1,""]},"com.vmware.nsx.node.file_store_client.Thumbprint":{get:[26,2,1,""]},"com.vmware.nsx.node.hardening_policy_client":{MandatoryAccessControl:[26,1,1,""],StubFactory:[26,1,1,""]},"com.vmware.nsx.node.hardening_policy_client.MandatoryAccessControl":{get:[26,2,1,""],update:[26,2,1,""]},"com.vmware.nsx.node.network":{interfaces_client:[29,0,0,"-"]},"com.vmware.nsx.node.network.interfaces_client":{Stats:[29,1,1,""],StubFactory:[29,1,1,""]},"com.vmware.nsx.node.network.interfaces_client.Stats":{get:[29,2,1,""]},"com.vmware.nsx.node.network_client":{Interfaces:[26,1,1,""],NameServers:[26,1,1,""],Routes:[26,1,1,""],SearchDomains:[26,1,1,""],StubFactory:[26,1,1,""]},"com.vmware.nsx.node.network_client.Interfaces":{get:[26,2,1,""],list:[26,2,1,""],update:[26,2,1,""]},"com.vmware.nsx.node.network_client.NameServers":{get:[26,2,1,""],update:[26,2,1,""]},"com.vmware.nsx.node.network_client.Routes":{"delete":[26,2,1,""],create:[26,2,1,""],get:[26,2,1,""],list:[26,2,1,""]},"com.vmware.nsx.node.network_client.SearchDomains":{get:[26,2,1,""],update:[26,2,1,""]},"com.vmware.nsx.node.services":{cluster_manager_client:[30,0,0,"-"],cm_inventory_client:[30,0,0,"-"],http_client:[30,0,0,"-"],install_upgrade_client:[30,0,0,"-"],liagent_client:[30,0,0,"-"],manager_client:[30,0,0,"-"],mgmt_plane_bus_client:[30,0,0,"-"],node_mgmt_client:[30,0,0,"-"],nsx_message_bus_client:[30,0,0,"-"],nsx_upgrade_agent_client:[30,0,0,"-"],ntp_client:[30,0,0,"-"],search_client:[30,0,0,"-"],snmp_client:[30,0,0,"-"],ssh_client:[30,0,0,"-"],syslog_client:[30,0,0,"-"],telemetry_client:[30,0,0,"-"],ui_service_client:[30,0,0,"-"]},"com.vmware.nsx.node.services.cluster_manager_client":{Status:[30,1,1,""],StubFactory:[30,1,1,""]},"com.vmware.nsx.node.services.cluster_manager_client.Status":{get:[30,2,1,""]},"com.vmware.nsx.node.services.cm_inventory_client":{Status:[30,1,1,""],StubFactory:[30,1,1,""]},"com.vmware.nsx.node.services.cm_inventory_client.Status":{get:[30,2,1,""]},"com.vmware.nsx.node.services.http_client":{Status:[30,1,1,""],StubFactory:[30,1,1,""]},"com.vmware.nsx.node.services.http_client.Status":{get:[30,2,1,""]},"com.vmware.nsx.node.services.install_upgrade_client":{Status:[30,1,1,""],StubFactory:[30,1,1,""]},"com.vmware.nsx.node.services.install_upgrade_client.Status":{get:[30,2,1,""]},"com.vmware.nsx.node.services.liagent_client":{Status:[30,1,1,""],StubFactory:[30,1,1,""]},"com.vmware.nsx.node.services.liagent_client.Status":{get:[30,2,1,""]},"com.vmware.nsx.node.services.manager_client":{Status:[30,1,1,""],StubFactory:[30,1,1,""]},"com.vmware.nsx.node.services.manager_client.Status":{get:[30,2,1,""]},"com.vmware.nsx.node.services.mgmt_plane_bus_client":{Status:[30,1,1,""],StubFactory:[30,1,1,""]},"com.vmware.nsx.node.services.mgmt_plane_bus_client.Status":{get:[30,2,1,""]},"com.vmware.nsx.node.services.node_mgmt_client":{Status:[30,1,1,""],StubFactory:[30,1,1,""]},"com.vmware.nsx.node.services.node_mgmt_client.Status":{get:[30,2,1,""]},"com.vmware.nsx.node.services.nsx_message_bus_client":{Status:[30,1,1,""],StubFactory:[30,1,1,""]},"com.vmware.nsx.node.services.nsx_message_bus_client.Status":{get:[30,2,1,""]},"com.vmware.nsx.node.services.nsx_upgrade_agent_client":{Status:[30,1,1,""],StubFactory:[30,1,1,""]},"com.vmware.nsx.node.services.nsx_upgrade_agent_client.Status":{get:[30,2,1,""]},"com.vmware.nsx.node.services.ntp_client":{Status:[30,1,1,""],StubFactory:[30,1,1,""]},"com.vmware.nsx.node.services.ntp_client.Status":{get:[30,2,1,""]},"com.vmware.nsx.node.services.search_client":{Status:[30,1,1,""],StubFactory:[30,1,1,""]},"com.vmware.nsx.node.services.search_client.Status":{get:[30,2,1,""]},"com.vmware.nsx.node.services.snmp_client":{Status:[30,1,1,""],StubFactory:[30,1,1,""]},"com.vmware.nsx.node.services.snmp_client.Status":{get:[30,2,1,""]},"com.vmware.nsx.node.services.ssh_client":{Status:[30,1,1,""],StubFactory:[30,1,1,""]},"com.vmware.nsx.node.services.ssh_client.Status":{get:[30,2,1,""]},"com.vmware.nsx.node.services.syslog_client":{Exporters:[30,1,1,""],Status:[30,1,1,""],StubFactory:[30,1,1,""]},"com.vmware.nsx.node.services.syslog_client.Exporters":{"delete":[30,2,1,""],create:[30,2,1,""],get:[30,2,1,""],list:[30,2,1,""]},"com.vmware.nsx.node.services.syslog_client.Status":{get:[30,2,1,""]},"com.vmware.nsx.node.services.telemetry_client":{Status:[30,1,1,""],StubFactory:[30,1,1,""]},"com.vmware.nsx.node.services.telemetry_client.Status":{get:[30,2,1,""]},"com.vmware.nsx.node.services.ui_service_client":{Status:[30,1,1,""],StubFactory:[30,1,1,""]},"com.vmware.nsx.node.services.ui_service_client.Status":{get:[30,2,1,""]},"com.vmware.nsx.node.services_client":{ClusterManager:[26,1,1,""],CmInventory:[26,1,1,""],Http:[26,1,1,""],InstallUpgrade:[26,1,1,""],Liagent:[26,1,1,""],Manager:[26,1,1,""],MgmtPlaneBus:[26,1,1,""],NodeMgmt:[26,1,1,""],NsxMessageBus:[26,1,1,""],NsxUpgradeAgent:[26,1,1,""],Ntp:[26,1,1,""],Search:[26,1,1,""],Snmp:[26,1,1,""],Ssh:[26,1,1,""],StubFactory:[26,1,1,""],Syslog:[26,1,1,""],Telemetry:[26,1,1,""],UiService:[26,1,1,""]},"com.vmware.nsx.node.services_client.ClusterManager":{get:[26,2,1,""],restart:[26,2,1,""],start:[26,2,1,""],stop:[26,2,1,""]},"com.vmware.nsx.node.services_client.CmInventory":{get:[26,2,1,""],restart:[26,2,1,""],start:[26,2,1,""],stop:[26,2,1,""]},"com.vmware.nsx.node.services_client.Http":{applycertificate:[26,2,1,""],get:[26,2,1,""],restart:[26,2,1,""],start:[26,2,1,""],stop:[26,2,1,""],update:[26,2,1,""]},"com.vmware.nsx.node.services_client.InstallUpgrade":{get:[26,2,1,""],restart:[26,2,1,""],start:[26,2,1,""],stop:[26,2,1,""],update:[26,2,1,""]},"com.vmware.nsx.node.services_client.Liagent":{get:[26,2,1,""],restart:[26,2,1,""],start:[26,2,1,""],stop:[26,2,1,""]},"com.vmware.nsx.node.services_client.Manager":{get:[26,2,1,""],resetmanagerlogginglevels:[26,2,1,""],restart:[26,2,1,""],start:[26,2,1,""],stop:[26,2,1,""],update:[26,2,1,""]},"com.vmware.nsx.node.services_client.MgmtPlaneBus":{get:[26,2,1,""],restart:[26,2,1,""],start:[26,2,1,""],stop:[26,2,1,""]},"com.vmware.nsx.node.services_client.NodeMgmt":{get:[26,2,1,""],restart:[26,2,1,""]},"com.vmware.nsx.node.services_client.NsxMessageBus":{get:[26,2,1,""],restart:[26,2,1,""],start:[26,2,1,""],stop:[26,2,1,""]},"com.vmware.nsx.node.services_client.NsxUpgradeAgent":{get:[26,2,1,""],restart:[26,2,1,""],start:[26,2,1,""],stop:[26,2,1,""]},"com.vmware.nsx.node.services_client.Ntp":{get:[26,2,1,""],restart:[26,2,1,""],start:[26,2,1,""],stop:[26,2,1,""],update:[26,2,1,""]},"com.vmware.nsx.node.services_client.Search":{get:[26,2,1,""],restart:[26,2,1,""],start:[26,2,1,""],stop:[26,2,1,""]},"com.vmware.nsx.node.services_client.Snmp":{get:[26,2,1,""],restart:[26,2,1,""],start:[26,2,1,""],stop:[26,2,1,""],update:[26,2,1,""]},"com.vmware.nsx.node.services_client.Ssh":{get:[26,2,1,""],removehostfingerprint:[26,2,1,""],restart:[26,2,1,""],start:[26,2,1,""],stop:[26,2,1,""],update:[26,2,1,""]},"com.vmware.nsx.node.services_client.Syslog":{get:[26,2,1,""],restart:[26,2,1,""],start:[26,2,1,""],stop:[26,2,1,""]},"com.vmware.nsx.node.services_client.Telemetry":{get:[26,2,1,""],restart:[26,2,1,""],start:[26,2,1,""],stop:[26,2,1,""]},"com.vmware.nsx.node.services_client.UiService":{get:[26,2,1,""],restart:[26,2,1,""],start:[26,2,1,""],stop:[26,2,1,""]},"com.vmware.nsx.node.tasks_client":{Response:[26,1,1,""],StubFactory:[26,1,1,""]},"com.vmware.nsx.node.tasks_client.Response":{get:[26,2,1,""]},"com.vmware.nsx.node.users_client":{SshKeys:[26,1,1,""],StubFactory:[26,1,1,""]},"com.vmware.nsx.node.users_client.SshKeys":{addsshkey:[26,2,1,""],list:[26,2,1,""],removesshkey:[26,2,1,""]},"com.vmware.nsx.node_client":{FileStore:[2,1,1,""],Logs:[2,1,1,""],Mode:[2,1,1,""],Network:[2,1,1,""],Processes:[2,1,1,""],RabbitmqManagementPort:[2,1,1,""],Services:[2,1,1,""],Status:[2,1,1,""],StubFactory:[2,1,1,""],Tasks:[2,1,1,""],Users:[2,1,1,""],Version:[2,1,1,""]},"com.vmware.nsx.node_client.FileStore":{"delete":[2,2,1,""],copyfromremotefile:[2,2,1,""],copytoremotefile:[2,2,1,""],createremotedirectory:[2,2,1,""],get:[2,2,1,""],list:[2,2,1,""]},"com.vmware.nsx.node_client.Logs":{list:[2,2,1,""]},"com.vmware.nsx.node_client.Mode":{get:[2,2,1,""]},"com.vmware.nsx.node_client.Network":{get:[2,2,1,""]},"com.vmware.nsx.node_client.Processes":{get:[2,2,1,""],list:[2,2,1,""]},"com.vmware.nsx.node_client.RabbitmqManagementPort":{"delete":[2,2,1,""],create:[2,2,1,""],get:[2,2,1,""]},"com.vmware.nsx.node_client.Services":{list:[2,2,1,""]},"com.vmware.nsx.node_client.Status":{get:[2,2,1,""]},"com.vmware.nsx.node_client.Tasks":{"delete":[2,2,1,""],cancel:[2,2,1,""],get:[2,2,1,""],list:[2,2,1,""]},"com.vmware.nsx.node_client.Users":{get:[2,2,1,""],list:[2,2,1,""],update:[2,2,1,""]},"com.vmware.nsx.node_client.Version":{get:[2,2,1,""]},"com.vmware.nsx.ns_groups_client":{EffectiveIpAddressMembers:[2,1,1,""],EffectiveLogicalPortMembers:[2,1,1,""],EffectiveLogicalSwitchMembers:[2,1,1,""],EffectiveVirtualMachineMembers:[2,1,1,""],MemberTypes:[2,1,1,""],ServiceAssociations:[2,1,1,""],StubFactory:[2,1,1,""],UnassociatedVirtualMachines:[2,1,1,""]},"com.vmware.nsx.ns_groups_client.EffectiveIpAddressMembers":{list:[2,2,1,""]},"com.vmware.nsx.ns_groups_client.EffectiveLogicalPortMembers":{list:[2,2,1,""]},"com.vmware.nsx.ns_groups_client.EffectiveLogicalSwitchMembers":{list:[2,2,1,""]},"com.vmware.nsx.ns_groups_client.EffectiveVirtualMachineMembers":{list:[2,2,1,""]},"com.vmware.nsx.ns_groups_client.MemberTypes":{get:[2,2,1,""]},"com.vmware.nsx.ns_groups_client.ServiceAssociations":{LIST_SERVICE_TYPE_FIREWALL:[2,3,1,""],LIST_SERVICE_TYPE_IPFIX:[2,3,1,""],list:[2,2,1,""]},"com.vmware.nsx.ns_groups_client.UnassociatedVirtualMachines":{list:[2,2,1,""]},"com.vmware.nsx.pktcap_client":{Session:[2,1,1,""],Sessions:[2,1,1,""],StubFactory:[2,1,1,""]},"com.vmware.nsx.pktcap_client.Session":{"delete":[2,2,1,""],create:[2,2,1,""],get:[2,2,1,""],terminate:[2,2,1,""]},"com.vmware.nsx.pktcap_client.Sessions":{"delete":[2,2,1,""],list:[2,2,1,""]},"com.vmware.nsx.pools":{ip_pools_client:[31,0,0,"-"]},"com.vmware.nsx.pools.ip_pools_client":{Allocations:[31,1,1,""],StubFactory:[31,1,1,""]},"com.vmware.nsx.pools.ip_pools_client.Allocations":{list:[31,2,1,""]},"com.vmware.nsx.pools_client":{IpBlocks:[2,1,1,""],IpPools:[2,1,1,""],IpSubnets:[2,1,1,""],MacPools:[2,1,1,""],StubFactory:[2,1,1,""],VniPools:[2,1,1,""],VtepLabelPools:[2,1,1,""]},"com.vmware.nsx.pools_client.IpBlocks":{"delete":[2,2,1,""],create:[2,2,1,""],get:[2,2,1,""],list:[2,2,1,""],update:[2,2,1,""]},"com.vmware.nsx.pools_client.IpPools":{"delete":[2,2,1,""],ALLOCATEORRELEASE_ACTION_ALLOCATE:[2,3,1,""],ALLOCATEORRELEASE_ACTION_RELEASE:[2,3,1,""],allocateorrelease:[2,2,1,""],create:[2,2,1,""],get:[2,2,1,""],list:[2,2,1,""],update:[2,2,1,""]},"com.vmware.nsx.pools_client.IpSubnets":{"delete":[2,2,1,""],ALLOCATEORRELEASEFROMIPBLOCKSUBNET_ACTION_ALLOCATE:[2,3,1,""],ALLOCATEORRELEASEFROMIPBLOCKSUBNET_ACTION_RELEASE:[2,3,1,""],allocateorreleasefromipblocksubnet:[2,2,1,""],create:[2,2,1,""],get:[2,2,1,""],list:[2,2,1,""]},"com.vmware.nsx.pools_client.MacPools":{get:[2,2,1,""],list:[2,2,1,""]},"com.vmware.nsx.pools_client.VniPools":{get:[2,2,1,""],list:[2,2,1,""],update:[2,2,1,""]},"com.vmware.nsx.pools_client.VtepLabelPools":{get:[2,2,1,""],list:[2,2,1,""]},"com.vmware.nsx.realization_state_barrier_client":{Config:[2,1,1,""],Current:[2,1,1,""],StubFactory:[2,1,1,""]},"com.vmware.nsx.realization_state_barrier_client.Config":{get:[2,2,1,""],update:[2,2,1,""]},"com.vmware.nsx.realization_state_barrier_client.Current":{get:[2,2,1,""],increment:[2,2,1,""]},"com.vmware.nsx.serviceinsertion":{sections_client:[32,0,0,"-"],services:[33,0,0,"-"],services_client:[32,0,0,"-"]},"com.vmware.nsx.serviceinsertion.sections_client":{Rules:[32,1,1,""],StubFactory:[32,1,1,""]},"com.vmware.nsx.serviceinsertion.sections_client.Rules":{"delete":[32,2,1,""],CREATEMULTIPLE_OPERATION_AFTER:[32,3,1,""],CREATEMULTIPLE_OPERATION_BEFORE:[32,3,1,""],CREATEMULTIPLE_OPERATION_BOTTOM:[32,3,1,""],CREATEMULTIPLE_OPERATION_TOP:[32,3,1,""],CREATE_OPERATION_AFTER:[32,3,1,""],CREATE_OPERATION_BEFORE:[32,3,1,""],CREATE_OPERATION_BOTTOM:[32,3,1,""],CREATE_OPERATION_TOP:[32,3,1,""],LIST_FILTER_TYPE_FILTER:[32,3,1,""],LIST_FILTER_TYPE_SEARCH:[32,3,1,""],REVISE_OPERATION_AFTER:[32,3,1,""],REVISE_OPERATION_BEFORE:[32,3,1,""],REVISE_OPERATION_BOTTOM:[32,3,1,""],REVISE_OPERATION_TOP:[32,3,1,""],create:[32,2,1,""],createmultiple:[32,2,1,""],get:[32,2,1,""],list:[32,2,1,""],revise:[32,2,1,""],update:[32,2,1,""]},"com.vmware.nsx.serviceinsertion.services":{service_instances:[34,0,0,"-"],service_instances_client:[33,0,0,"-"]},"com.vmware.nsx.serviceinsertion.services.service_instances":{instance_runtimes:[35,0,0,"-"]},"com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes":{interfaces_client:[35,0,0,"-"]},"com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.interfaces_client":{Statistics:[35,1,1,""],Status:[35,1,1,""],StubFactory:[35,1,1,""]},"com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.interfaces_client.Statistics":{GET_SOURCE_CACHED:[35,3,1,""],GET_SOURCE_REALTIME:[35,3,1,""],get:[35,2,1,""]},"com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.interfaces_client.Status":{GET_SOURCE_CACHED:[35,3,1,""],GET_SOURCE_REALTIME:[35,3,1,""],get:[35,2,1,""]},"com.vmware.nsx.serviceinsertion.services.service_instances_client":{InstanceEndpoints:[33,1,1,""],InstanceRuntimes:[33,1,1,""],StubFactory:[33,1,1,""]},"com.vmware.nsx.serviceinsertion.services.service_instances_client.InstanceEndpoints":{"delete":[33,2,1,""],create:[33,2,1,""],get:[33,2,1,""],list:[33,2,1,""]},"com.vmware.nsx.serviceinsertion.services.service_instances_client.InstanceRuntimes":{"delete":[33,2,1,""],deploy:[33,2,1,""],list:[33,2,1,""],upgrade:[33,2,1,""]},"com.vmware.nsx.serviceinsertion.services_client":{ServiceInstances:[32,1,1,""],StubFactory:[32,1,1,""]},"com.vmware.nsx.serviceinsertion.services_client.ServiceInstances":{"delete":[32,2,1,""],create:[32,2,1,""],get:[32,2,1,""],list:[32,2,1,""],update:[32,2,1,""]},"com.vmware.nsx.serviceinsertion_client":{Sections:[2,1,1,""],ServiceAttachments:[2,1,1,""],Services:[2,1,1,""],StubFactory:[2,1,1,""]},"com.vmware.nsx.serviceinsertion_client.Sections":{"delete":[2,2,1,""],CREATEWITHRULES_OPERATION_AFTER:[2,3,1,""],CREATEWITHRULES_OPERATION_BEFORE:[2,3,1,""],CREATEWITHRULES_OPERATION_BOTTOM:[2,3,1,""],CREATEWITHRULES_OPERATION_TOP:[2,3,1,""],CREATE_OPERATION_AFTER:[2,3,1,""],CREATE_OPERATION_BEFORE:[2,3,1,""],CREATE_OPERATION_BOTTOM:[2,3,1,""],CREATE_OPERATION_TOP:[2,3,1,""],LIST_EXCLUDE_APPLIED_TO_TYPE_LOGICALPORT:[2,3,1,""],LIST_EXCLUDE_APPLIED_TO_TYPE_LOGICALROUTER:[2,3,1,""],LIST_EXCLUDE_APPLIED_TO_TYPE_LOGICALSWITCH:[2,3,1,""],LIST_EXCLUDE_APPLIED_TO_TYPE_NSGROUP:[2,3,1,""],LIST_FILTER_TYPE_FILTER:[2,3,1,""],LIST_FILTER_TYPE_SEARCH:[2,3,1,""],LIST_INCLUDE_APPLIED_TO_TYPE_LOGICALPORT:[2,3,1,""],LIST_INCLUDE_APPLIED_TO_TYPE_LOGICALROUTER:[2,3,1,""],LIST_INCLUDE_APPLIED_TO_TYPE_LOGICALSWITCH:[2,3,1,""],LIST_INCLUDE_APPLIED_TO_TYPE_NSGROUP:[2,3,1,""],LIST_TYPE_L3REDIRECT:[2,3,1,""],REVISEWITHRULES_OPERATION_AFTER:[2,3,1,""],REVISEWITHRULES_OPERATION_BEFORE:[2,3,1,""],REVISEWITHRULES_OPERATION_BOTTOM:[2,3,1,""],REVISEWITHRULES_OPERATION_TOP:[2,3,1,""],REVISE_OPERATION_AFTER:[2,3,1,""],REVISE_OPERATION_BEFORE:[2,3,1,""],REVISE_OPERATION_BOTTOM:[2,3,1,""],REVISE_OPERATION_TOP:[2,3,1,""],create:[2,2,1,""],createwithrules:[2,2,1,""],get:[2,2,1,""],list:[2,2,1,""],listwithrules:[2,2,1,""],revise:[2,2,1,""],revisewithrules:[2,2,1,""],update:[2,2,1,""],updatewithrules:[2,2,1,""]},"com.vmware.nsx.serviceinsertion_client.ServiceAttachments":{"delete":[2,2,1,""],create:[2,2,1,""],get:[2,2,1,""],list:[2,2,1,""]},"com.vmware.nsx.serviceinsertion_client.Services":{"delete":[2,2,1,""],create:[2,2,1,""],get:[2,2,1,""],list:[2,2,1,""],update:[2,2,1,""]},"com.vmware.nsx.switching_profiles_client":{StubFactory:[2,1,1,""],Summary:[2,1,1,""]},"com.vmware.nsx.switching_profiles_client.Summary":{get:[2,2,1,""]},"com.vmware.nsx.tasks_client":{Response:[2,1,1,""],StubFactory:[2,1,1,""]},"com.vmware.nsx.tasks_client.Response":{get:[2,2,1,""]},"com.vmware.nsx.telemetry_client":{Agreement:[2,1,1,""],Config:[2,1,1,""],StubFactory:[2,1,1,""]},"com.vmware.nsx.telemetry_client.Agreement":{get:[2,2,1,""],update:[2,2,1,""]},"com.vmware.nsx.telemetry_client.Config":{get:[2,2,1,""],update:[2,2,1,""]},"com.vmware.nsx.traceflows_client":{Observations:[2,1,1,""],StubFactory:[2,1,1,""]},"com.vmware.nsx.traceflows_client.Observations":{LIST_COMPONENT_TYPE_BRIDGE:[2,3,1,""],LIST_COMPONENT_TYPE_DFW:[2,3,1,""],LIST_COMPONENT_TYPE_EDGE_HOSTSWITCH:[2,3,1,""],LIST_COMPONENT_TYPE_EDGE_TUNNEL:[2,3,1,""],LIST_COMPONENT_TYPE_LR:[2,3,1,""],LIST_COMPONENT_TYPE_LS:[2,3,1,""],LIST_COMPONENT_TYPE_PHYSICAL:[2,3,1,""],LIST_COMPONENT_TYPE_UNKNOWN:[2,3,1,""],LIST_RESOURCE_TYPE_TRACEFLOWOBSERVATIONDELIVERED:[2,3,1,""],LIST_RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPED:[2,3,1,""],LIST_RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPEDLOGICAL:[2,3,1,""],LIST_RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDED:[2,3,1,""],LIST_RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDEDLOGICAL:[2,3,1,""],LIST_RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVED:[2,3,1,""],LIST_RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVEDLOGICAL:[2,3,1,""],list:[2,2,1,""]},"com.vmware.nsx.transport_nodes":{statistics_client:[36,0,0,"-"]},"com.vmware.nsx.transport_nodes.statistics_client":{NatRules:[36,1,1,""],StubFactory:[36,1,1,""]},"com.vmware.nsx.transport_nodes.statistics_client.NatRules":{GET_SOURCE_CACHED:[36,3,1,""],GET_SOURCE_REALTIME:[36,3,1,""],get:[36,2,1,""]},"com.vmware.nsx.transport_nodes_client":{PnicBondStatus:[2,1,1,""],RemoteTransportNodeStatus:[2,1,1,""],State:[2,1,1,""],Status:[2,1,1,""],StubFactory:[2,1,1,""],Tunnels:[2,1,1,""]},"com.vmware.nsx.transport_nodes_client.PnicBondStatus":{list:[2,2,1,""]},"com.vmware.nsx.transport_nodes_client.RemoteTransportNodeStatus":{LIST_BFD_DIAGNOSTIC_CODE_0:[2,3,1,""],LIST_BFD_DIAGNOSTIC_CODE_1:[2,3,1,""],LIST_BFD_DIAGNOSTIC_CODE_2:[2,3,1,""],LIST_BFD_DIAGNOSTIC_CODE_3:[2,3,1,""],LIST_BFD_DIAGNOSTIC_CODE_4:[2,3,1,""],LIST_BFD_DIAGNOSTIC_CODE_5:[2,3,1,""],LIST_BFD_DIAGNOSTIC_CODE_6:[2,3,1,""],LIST_BFD_DIAGNOSTIC_CODE_7:[2,3,1,""],LIST_BFD_DIAGNOSTIC_CODE_8:[2,3,1,""],LIST_BFD_DIAGNOSTIC_CODE_ADMINISTRATIVELY_DOWN:[2,3,1,""],LIST_BFD_DIAGNOSTIC_CODE_CONCATENATED_PATH_DOWN:[2,3,1,""],LIST_BFD_DIAGNOSTIC_CODE_CONTROL_DETECTION_TIME_EXPIRED:[2,3,1,""],LIST_BFD_DIAGNOSTIC_CODE_ECHO_FUNCTION_FAILED:[2,3,1,""],LIST_BFD_DIAGNOSTIC_CODE_FORWARDING_PLANE_RESET:[2,3,1,""],LIST_BFD_DIAGNOSTIC_CODE_NEIGHBOR_SIGNALED_SESSION_DOWN:[2,3,1,""],LIST_BFD_DIAGNOSTIC_CODE_NO_DIAGNOSTIC:[2,3,1,""],LIST_BFD_DIAGNOSTIC_CODE_PATH_DOWN:[2,3,1,""],LIST_BFD_DIAGNOSTIC_CODE_REVERSE_CONCATENATED_PATH_DOWN:[2,3,1,""],LIST_SOURCE_CACHED:[2,3,1,""],LIST_SOURCE_REALTIME:[2,3,1,""],LIST_TUNNEL_STATUS_DOWN:[2,3,1,""],LIST_TUNNEL_STATUS_UP:[2,3,1,""],list:[2,2,1,""]},"com.vmware.nsx.transport_nodes_client.State":{LIST_MM_STATE_DISABLED:[2,3,1,""],LIST_MM_STATE_ENABLED:[2,3,1,""],LIST_MM_STATE_ENTERING:[2,3,1,""],LIST_MM_STATE_EXITING:[2,3,1,""],LIST_STATUS_FAILED:[2,3,1,""],LIST_STATUS_IN_PROGRESS:[2,3,1,""],LIST_STATUS_ORPHANED:[2,3,1,""],LIST_STATUS_PARTIAL_SUCCESS:[2,3,1,""],LIST_STATUS_PENDING:[2,3,1,""],LIST_STATUS_SUCCESS:[2,3,1,""],get:[2,2,1,""],list:[2,2,1,""]},"com.vmware.nsx.transport_nodes_client.Status":{GET_0_SOURCE_CACHED:[2,3,1,""],GET_0_SOURCE_REALTIME:[2,3,1,""],get:[2,2,1,""],get_0:[2,2,1,""]},"com.vmware.nsx.transport_nodes_client.Tunnels":{GET_SOURCE_CACHED:[2,3,1,""],GET_SOURCE_REALTIME:[2,3,1,""],LIST_BFD_DIAGNOSTIC_CODE_0:[2,3,1,""],LIST_BFD_DIAGNOSTIC_CODE_1:[2,3,1,""],LIST_BFD_DIAGNOSTIC_CODE_2:[2,3,1,""],LIST_BFD_DIAGNOSTIC_CODE_3:[2,3,1,""],LIST_BFD_DIAGNOSTIC_CODE_4:[2,3,1,""],LIST_BFD_DIAGNOSTIC_CODE_5:[2,3,1,""],LIST_BFD_DIAGNOSTIC_CODE_6:[2,3,1,""],LIST_BFD_DIAGNOSTIC_CODE_7:[2,3,1,""],LIST_BFD_DIAGNOSTIC_CODE_8:[2,3,1,""],LIST_BFD_DIAGNOSTIC_CODE_ADMINISTRATIVELY_DOWN:[2,3,1,""],LIST_BFD_DIAGNOSTIC_CODE_CONCATENATED_PATH_DOWN:[2,3,1,""],LIST_BFD_DIAGNOSTIC_CODE_CONTROL_DETECTION_TIME_EXPIRED:[2,3,1,""],LIST_BFD_DIAGNOSTIC_CODE_ECHO_FUNCTION_FAILED:[2,3,1,""],LIST_BFD_DIAGNOSTIC_CODE_FORWARDING_PLANE_RESET:[2,3,1,""],LIST_BFD_DIAGNOSTIC_CODE_NEIGHBOR_SIGNALED_SESSION_DOWN:[2,3,1,""],LIST_BFD_DIAGNOSTIC_CODE_NO_DIAGNOSTIC:[2,3,1,""],LIST_BFD_DIAGNOSTIC_CODE_PATH_DOWN:[2,3,1,""],LIST_BFD_DIAGNOSTIC_CODE_REVERSE_CONCATENATED_PATH_DOWN:[2,3,1,""],LIST_SOURCE_CACHED:[2,3,1,""],LIST_SOURCE_REALTIME:[2,3,1,""],LIST_STATUS_DOWN:[2,3,1,""],LIST_STATUS_UP:[2,3,1,""],get:[2,2,1,""],list:[2,2,1,""]},"com.vmware.nsx.transport_zones_client":{Status:[2,1,1,""],StubFactory:[2,1,1,""],Summary:[2,1,1,""],TransportNodeStatus:[2,1,1,""]},"com.vmware.nsx.transport_zones_client.Status":{GET_0_SOURCE_CACHED:[2,3,1,""],GET_0_SOURCE_REALTIME:[2,3,1,""],get:[2,2,1,""],get_0:[2,2,1,""]},"com.vmware.nsx.transport_zones_client.Summary":{get:[2,2,1,""]},"com.vmware.nsx.transport_zones_client.TransportNodeStatus":{GETALL_SOURCE_CACHED:[2,3,1,""],GETALL_SOURCE_REALTIME:[2,3,1,""],GETALL_STATUS_DEGRADED:[2,3,1,""],GETALL_STATUS_DOWN:[2,3,1,""],GETALL_STATUS_UNKNOWN:[2,3,1,""],GETALL_STATUS_UP:[2,3,1,""],LIST_SOURCE_CACHED:[2,3,1,""],LIST_SOURCE_REALTIME:[2,3,1,""],LIST_STATUS_DEGRADED:[2,3,1,""],LIST_STATUS_DOWN:[2,3,1,""],LIST_STATUS_UNKNOWN:[2,3,1,""],LIST_STATUS_UP:[2,3,1,""],getall:[2,2,1,""],list:[2,2,1,""]},"com.vmware.nsx.trust_management_client":{Certificates:[2,1,1,""],Crls:[2,1,1,""],Csrs:[2,1,1,""],PrincipalIdentities:[2,1,1,""],StubFactory:[2,1,1,""]},"com.vmware.nsx.trust_management_client.Certificates":{"delete":[2,2,1,""],LIST_TYPE_CERTIFICATE:[2,3,1,""],get:[2,2,1,""],importcertificate:[2,2,1,""],list:[2,2,1,""]},"com.vmware.nsx.trust_management_client.Crls":{"delete":[2,2,1,""],LIST_TYPE_CERTIFICATE:[2,3,1,""],get:[2,2,1,""],importcrl:[2,2,1,""],list:[2,2,1,""],update:[2,2,1,""]},"com.vmware.nsx.trust_management_client.Csrs":{"delete":[2,2,1,""],create:[2,2,1,""],get:[2,2,1,""],importcsr:[2,2,1,""],list:[2,2,1,""],selfsign:[2,2,1,""]},"com.vmware.nsx.trust_management_client.PrincipalIdentities":{"delete":[2,2,1,""],create:[2,2,1,""],get:[2,2,1,""],list:[2,2,1,""],updatecertificate:[2,2,1,""]},"com.vmware.nsx.ui_views_client":{StubFactory:[2,1,1,""],Widgetconfigurations:[2,1,1,""]},"com.vmware.nsx.ui_views_client.Widgetconfigurations":{"delete":[2,2,1,""],create:[2,2,1,""],get:[2,2,1,""],get_0:[2,2,1,""],update:[2,2,1,""]},"com.vmware.nsx.upgrade":{bundles_client:[37,0,0,"-"],eula_client:[37,0,0,"-"],plan_client:[37,0,0,"-"],upgrade_unit_groups_client:[37,0,0,"-"],upgrade_units_client:[37,0,0,"-"]},"com.vmware.nsx.upgrade.bundles_client":{StubFactory:[37,1,1,""],UploadStatus:[37,1,1,""]},"com.vmware.nsx.upgrade.bundles_client.UploadStatus":{get:[37,2,1,""]},"com.vmware.nsx.upgrade.eula_client":{Accept:[37,1,1,""],Acceptance:[37,1,1,""],Content:[37,1,1,""],StubFactory:[37,1,1,""]},"com.vmware.nsx.upgrade.eula_client.Accept":{create:[37,2,1,""]},"com.vmware.nsx.upgrade.eula_client.Acceptance":{get:[37,2,1,""]},"com.vmware.nsx.upgrade.eula_client.Content":{get:[37,2,1,""]},"com.vmware.nsx.upgrade.plan_client":{Settings:[37,1,1,""],StubFactory:[37,1,1,""]},"com.vmware.nsx.upgrade.plan_client.Settings":{get:[37,2,1,""],update:[37,2,1,""]},"com.vmware.nsx.upgrade.upgrade_unit_groups_client":{AggregateInfo:[37,1,1,""],Status:[37,1,1,""],StubFactory:[37,1,1,""],UpgradeUnit:[37,1,1,""]},"com.vmware.nsx.upgrade.upgrade_unit_groups_client.AggregateInfo":{list:[37,2,1,""]},"com.vmware.nsx.upgrade.upgrade_unit_groups_client.Status":{list:[37,2,1,""]},"com.vmware.nsx.upgrade.upgrade_unit_groups_client.UpgradeUnit":{reorder:[37,2,1,""]},"com.vmware.nsx.upgrade.upgrade_units_client":{AggregateInfo:[37,1,1,""],StubFactory:[37,1,1,""]},"com.vmware.nsx.upgrade.upgrade_units_client.AggregateInfo":{LIST_SELECTION_STATUS_ALL:[37,3,1,""],LIST_SELECTION_STATUS_DESELECTED:[37,3,1,""],LIST_SELECTION_STATUS_SELECTED:[37,3,1,""],list:[37,2,1,""]},"com.vmware.nsx.upgrade_client":{Bundles:[2,1,1,""],History:[2,1,1,""],Nodes:[2,1,1,""],NodesSummary:[2,1,1,""],Plan:[2,1,1,""],StatusSummary:[2,1,1,""],StubFactory:[2,1,1,""],Summary:[2,1,1,""],UpgradeUnitGroups:[2,1,1,""],UpgradeUnitGroupsStatus:[2,1,1,""],UpgradeUnits:[2,1,1,""],UpgradeUnitsStats:[2,1,1,""],VersionWhitelist:[2,1,1,""]},"com.vmware.nsx.upgrade_client.Bundles":{create:[2,2,1,""],get:[2,2,1,""]},"com.vmware.nsx.upgrade_client.History":{list:[2,2,1,""]},"com.vmware.nsx.upgrade_client.Nodes":{list:[2,2,1,""]},"com.vmware.nsx.upgrade_client.NodesSummary":{get:[2,2,1,""]},"com.vmware.nsx.upgrade_client.Plan":{continue_:[2,2,1,""],pause:[2,2,1,""],reset:[2,2,1,""],start:[2,2,1,""],upgradeselectedunits:[2,2,1,""]},"com.vmware.nsx.upgrade_client.StatusSummary":{GET_SELECTION_STATUS_ALL:[2,3,1,""],GET_SELECTION_STATUS_DESELECTED:[2,3,1,""],GET_SELECTION_STATUS_SELECTED:[2,3,1,""],get:[2,2,1,""]},"com.vmware.nsx.upgrade_client.Summary":{get:[2,2,1,""]},"com.vmware.nsx.upgrade_client.UpgradeUnitGroups":{"delete":[2,2,1,""],addupgradeunits:[2,2,1,""],create:[2,2,1,""],get:[2,2,1,""],list:[2,2,1,""],reorder:[2,2,1,""],update:[2,2,1,""]},"com.vmware.nsx.upgrade_client.UpgradeUnitGroupsStatus":{getall:[2,2,1,""]},"com.vmware.nsx.upgrade_client.UpgradeUnits":{get:[2,2,1,""],list:[2,2,1,""]},"com.vmware.nsx.upgrade_client.UpgradeUnitsStats":{get:[2,2,1,""]},"com.vmware.nsx.upgrade_client.VersionWhitelist":{get:[2,2,1,""],list:[2,2,1,""],update:[2,2,1,""]},"com.vmware.nsx.vpn":{ipsec:[39,0,0,"-"],ipsec_client:[38,0,0,"-"],l2vpn:[40,0,0,"-"],l2vpn_client:[38,0,0,"-"],services_client:[38,0,0,"-"]},"com.vmware.nsx.vpn.ipsec":{sessions_client:[39,0,0,"-"]},"com.vmware.nsx.vpn.ipsec.sessions_client":{Statistics:[39,1,1,""],Status:[39,1,1,""],StubFactory:[39,1,1,""],Summary:[39,1,1,""]},"com.vmware.nsx.vpn.ipsec.sessions_client.Statistics":{GET_SOURCE_CACHED:[39,3,1,""],GET_SOURCE_REALTIME:[39,3,1,""],get:[39,2,1,""],reset:[39,2,1,""]},"com.vmware.nsx.vpn.ipsec.sessions_client.Status":{GET_SOURCE_CACHED:[39,3,1,""],GET_SOURCE_REALTIME:[39,3,1,""],get:[39,2,1,""]},"com.vmware.nsx.vpn.ipsec.sessions_client.Summary":{GET_SOURCE_CACHED:[39,3,1,""],GET_SOURCE_REALTIME:[39,3,1,""],get:[39,2,1,""]},"com.vmware.nsx.vpn.ipsec_client":{DpdProfiles:[38,1,1,""],IkeProfiles:[38,1,1,""],LocalEndpoints:[38,1,1,""],PeerEndpoints:[38,1,1,""],Services:[38,1,1,""],Sessions:[38,1,1,""],StubFactory:[38,1,1,""],TunnelProfiles:[38,1,1,""]},"com.vmware.nsx.vpn.ipsec_client.DpdProfiles":{"delete":[38,2,1,""],create:[38,2,1,""],get:[38,2,1,""],list:[38,2,1,""],update:[38,2,1,""]},"com.vmware.nsx.vpn.ipsec_client.IkeProfiles":{"delete":[38,2,1,""],create:[38,2,1,""],get:[38,2,1,""],list:[38,2,1,""],update:[38,2,1,""]},"com.vmware.nsx.vpn.ipsec_client.LocalEndpoints":{"delete":[38,2,1,""],create:[38,2,1,""],get:[38,2,1,""],list:[38,2,1,""],update:[38,2,1,""]},"com.vmware.nsx.vpn.ipsec_client.PeerEndpoints":{"delete":[38,2,1,""],create:[38,2,1,""],get:[38,2,1,""],list:[38,2,1,""],showsensitivedata:[38,2,1,""],update:[38,2,1,""]},"com.vmware.nsx.vpn.ipsec_client.Services":{"delete":[38,2,1,""],create:[38,2,1,""],get:[38,2,1,""],list:[38,2,1,""],update:[38,2,1,""]},"com.vmware.nsx.vpn.ipsec_client.Sessions":{"delete":[38,2,1,""],LIST_SESSION_TYPE_POLICYBASEDIPSECVPNSESSION:[38,3,1,""],LIST_SESSION_TYPE_ROUTEBASEDIPSECVPNSESSION:[38,3,1,""],create:[38,2,1,""],get:[38,2,1,""],list:[38,2,1,""],update:[38,2,1,""]},"com.vmware.nsx.vpn.ipsec_client.TunnelProfiles":{"delete":[38,2,1,""],create:[38,2,1,""],get:[38,2,1,""],list:[38,2,1,""],update:[38,2,1,""]},"com.vmware.nsx.vpn.l2vpn":{sessions_client:[40,0,0,"-"]},"com.vmware.nsx.vpn.l2vpn.sessions_client":{PeerCodes:[40,1,1,""],RemoteMac:[40,1,1,""],Statistics:[40,1,1,""],Status:[40,1,1,""],StubFactory:[40,1,1,""],Summary:[40,1,1,""]},"com.vmware.nsx.vpn.l2vpn.sessions_client.PeerCodes":{get:[40,2,1,""]},"com.vmware.nsx.vpn.l2vpn.sessions_client.RemoteMac":{get:[40,2,1,""]},"com.vmware.nsx.vpn.l2vpn.sessions_client.Statistics":{GET_SOURCE_CACHED:[40,3,1,""],GET_SOURCE_REALTIME:[40,3,1,""],get:[40,2,1,""]},"com.vmware.nsx.vpn.l2vpn.sessions_client.Status":{GET_SOURCE_CACHED:[40,3,1,""],GET_SOURCE_REALTIME:[40,3,1,""],get:[40,2,1,""]},"com.vmware.nsx.vpn.l2vpn.sessions_client.Summary":{GET_SOURCE_CACHED:[40,3,1,""],GET_SOURCE_REALTIME:[40,3,1,""],get:[40,2,1,""]},"com.vmware.nsx.vpn.l2vpn_client":{Services:[38,1,1,""],Sessions:[38,1,1,""],StubFactory:[38,1,1,""]},"com.vmware.nsx.vpn.l2vpn_client.Services":{"delete":[38,2,1,""],create:[38,2,1,""],get:[38,2,1,""],list:[38,2,1,""],update:[38,2,1,""]},"com.vmware.nsx.vpn.l2vpn_client.Sessions":{"delete":[38,2,1,""],create:[38,2,1,""],get:[38,2,1,""],list:[38,2,1,""],update:[38,2,1,""]},"com.vmware.nsx.vpn.services_client":{StubFactory:[38,1,1,""],Summary:[38,1,1,""]},"com.vmware.nsx.vpn.services_client.Summary":{GET_SOURCE_CACHED:[38,3,1,""],GET_SOURCE_REALTIME:[38,3,1,""],get:[38,2,1,""]},"com.vmware.nsx_client":{Associations:[1,1,1,""],Batch:[1,1,1,""],BridgeClusters:[1,1,1,""],BridgeEndpointProfiles:[1,1,1,""],BridgeEndpoints:[1,1,1,""],Cluster:[1,1,1,""],ClusterProfiles:[1,1,1,""],ComputeCollectionTransportNodeTemplates:[1,1,1,""],EdgeClusters:[1,1,1,""],ErrorResolver:[1,1,1,""],HostSwitchProfiles:[1,1,1,""],IpSets:[1,1,1,""],IpfixCollectorProfiles:[1,1,1,""],IpfixObsPoints:[1,1,1,""],IpfixProfiles:[1,1,1,""],Licenses:[1,1,1,""],LogicalPorts:[1,1,1,""],LogicalRouterPorts:[1,1,1,""],LogicalRouters:[1,1,1,""],LogicalSwitches:[1,1,1,""],MacSets:[1,1,1,""],MdProxies:[1,1,1,""],Migration:[1,1,1,""],MirrorSessions:[1,1,1,""],NetworkMigrationSpecs:[1,1,1,""],Node:[1,1,1,""],Normalizations:[1,1,1,""],NsGroups:[1,1,1,""],NsServiceGroups:[1,1,1,""],NsServices:[1,1,1,""],ServiceProfiles:[1,1,1,""],Services:[1,1,1,""],StubFactory:[1,1,1,""],SwitchingProfiles:[1,1,1,""],Tasks:[1,1,1,""],Traceflows:[1,1,1,""],TransportNodes:[1,1,1,""],TransportZones:[1,1,1,""],TransportzoneProfiles:[1,1,1,""],TrustManagement:[1,1,1,""],UiViews:[1,1,1,""],Upgrade:[1,1,1,""]},"com.vmware.nsx_client.Associations":{LIST_ASSOCIATED_RESOURCE_TYPE_NSGROUP:[1,3,1,""],LIST_RESOURCE_TYPE_DIRECTORYGROUP:[1,3,1,""],LIST_RESOURCE_TYPE_IPSET:[1,3,1,""],LIST_RESOURCE_TYPE_LOGICALPORT:[1,3,1,""],LIST_RESOURCE_TYPE_LOGICALSWITCH:[1,3,1,""],LIST_RESOURCE_TYPE_MACSET:[1,3,1,""],LIST_RESOURCE_TYPE_NSGROUP:[1,3,1,""],LIST_RESOURCE_TYPE_VIRTUALMACHINE:[1,3,1,""],list:[1,2,1,""]},"com.vmware.nsx_client.Batch":{create:[1,2,1,""]},"com.vmware.nsx_client.BridgeClusters":{"delete":[1,2,1,""],create:[1,2,1,""],get:[1,2,1,""],list:[1,2,1,""],update:[1,2,1,""]},"com.vmware.nsx_client.BridgeEndpointProfiles":{"delete":[1,2,1,""],create:[1,2,1,""],get:[1,2,1,""],list:[1,2,1,""],update:[1,2,1,""]},"com.vmware.nsx_client.BridgeEndpoints":{"delete":[1,2,1,""],create:[1,2,1,""],get:[1,2,1,""],list:[1,2,1,""],update:[1,2,1,""]},"com.vmware.nsx_client.Cluster":{"delete":[1,2,1,""],backuptoremote:[1,2,1,""],create:[1,2,1,""],get:[1,2,1,""],get_0:[1,2,1,""],summarizeinventorytoremote:[1,2,1,""],update:[1,2,1,""]},"com.vmware.nsx_client.ClusterProfiles":{"delete":[1,2,1,""],LIST_RESOURCE_TYPE_BRIDGEHIGHAVAILABILITYCLUSTERPROFILE:[1,3,1,""],LIST_RESOURCE_TYPE_EDGEHIGHAVAILABILITYPROFILE:[1,3,1,""],create:[1,2,1,""],get:[1,2,1,""],list:[1,2,1,""],update:[1,2,1,""]},"com.vmware.nsx_client.ComputeCollectionTransportNodeTemplates":{"delete":[1,2,1,""],create:[1,2,1,""],get:[1,2,1,""],list:[1,2,1,""],update:[1,2,1,""]},"com.vmware.nsx_client.EdgeClusters":{"delete":[1,2,1,""],create:[1,2,1,""],get:[1,2,1,""],list:[1,2,1,""],replacetransportnode:[1,2,1,""],update:[1,2,1,""]},"com.vmware.nsx_client.ErrorResolver":{get:[1,2,1,""],list:[1,2,1,""],resolveerror:[1,2,1,""]},"com.vmware.nsx_client.HostSwitchProfiles":{"delete":[1,2,1,""],LIST_HOSTSWITCH_PROFILE_TYPE_EXTRACONFIGHOSTSWITCHPROFILE:[1,3,1,""],LIST_HOSTSWITCH_PROFILE_TYPE_LLDPHOSTSWITCHPROFILE:[1,3,1,""],LIST_HOSTSWITCH_PROFILE_TYPE_NIOCPROFILE:[1,3,1,""],LIST_HOSTSWITCH_PROFILE_TYPE_UPLINKHOSTSWITCHPROFILE:[1,3,1,""],create:[1,2,1,""],get:[1,2,1,""],list:[1,2,1,""],update:[1,2,1,""]},"com.vmware.nsx_client.IpSets":{"delete":[1,2,1,""],create:[1,2,1,""],get:[1,2,1,""],list:[1,2,1,""],update:[1,2,1,""]},"com.vmware.nsx_client.IpfixCollectorProfiles":{"delete":[1,2,1,""],create:[1,2,1,""],get:[1,2,1,""],list:[1,2,1,""],update:[1,2,1,""]},"com.vmware.nsx_client.IpfixObsPoints":{list:[1,2,1,""]},"com.vmware.nsx_client.IpfixProfiles":{"delete":[1,2,1,""],LIST_APPLIED_TO_ENTITY_TYPE_LOGICALPORT:[1,3,1,""],LIST_APPLIED_TO_ENTITY_TYPE_LOGICALSWITCH:[1,3,1,""],LIST_APPLIED_TO_ENTITY_TYPE_NSGROUP:[1,3,1,""],create:[1,2,1,""],get:[1,2,1,""],list:[1,2,1,""],update:[1,2,1,""]},"com.vmware.nsx_client.Licenses":{"delete":[1,2,1,""],create:[1,2,1,""],delete_0:[1,2,1,""],get:[1,2,1,""],getlicensebykey:[1,2,1,""],list:[1,2,1,""],update:[1,2,1,""]},"com.vmware.nsx_client.LogicalPorts":{"delete":[1,2,1,""],LIST_ATTACHMENT_TYPE_BRIDGEENDPOINT:[1,3,1,""],LIST_ATTACHMENT_TYPE_DHCP_SERVICE:[1,3,1,""],LIST_ATTACHMENT_TYPE_L2VPN_SESSION:[1,3,1,""],LIST_ATTACHMENT_TYPE_LOGICALROUTER:[1,3,1,""],LIST_ATTACHMENT_TYPE_METADATA_PROXY:[1,3,1,""],LIST_ATTACHMENT_TYPE_NONE:[1,3,1,""],LIST_ATTACHMENT_TYPE_VIF:[1,3,1,""],create:[1,2,1,""],get:[1,2,1,""],list:[1,2,1,""],update:[1,2,1,""]},"com.vmware.nsx_client.LogicalRouterPorts":{"delete":[1,2,1,""],LIST_RESOURCE_TYPE_LOGICALROUTERCENTRALIZEDSERVICEPORT:[1,3,1,""],LIST_RESOURCE_TYPE_LOGICALROUTERDOWNLINKPORT:[1,3,1,""],LIST_RESOURCE_TYPE_LOGICALROUTERIPTUNNELPORT:[1,3,1,""],LIST_RESOURCE_TYPE_LOGICALROUTERLINKPORTONTIER0:[1,3,1,""],LIST_RESOURCE_TYPE_LOGICALROUTERLINKPORTONTIER1:[1,3,1,""],LIST_RESOURCE_TYPE_LOGICALROUTERLOOPBACKPORT:[1,3,1,""],LIST_RESOURCE_TYPE_LOGICALROUTERUPLINKPORT:[1,3,1,""],create:[1,2,1,""],get:[1,2,1,""],list:[1,2,1,""],update:[1,2,1,""]},"com.vmware.nsx_client.LogicalRouters":{"delete":[1,2,1,""],LIST_ROUTER_TYPE_TIER0:[1,3,1,""],LIST_ROUTER_TYPE_TIER1:[1,3,1,""],create:[1,2,1,""],get:[1,2,1,""],list:[1,2,1,""],reallocate:[1,2,1,""],reprocess:[1,2,1,""],update:[1,2,1,""]},"com.vmware.nsx_client.LogicalSwitches":{"delete":[1,2,1,""],LIST_TRANSPORT_TYPE_OVERLAY:[1,3,1,""],LIST_TRANSPORT_TYPE_VLAN:[1,3,1,""],create:[1,2,1,""],get:[1,2,1,""],list:[1,2,1,""],update:[1,2,1,""]},"com.vmware.nsx_client.MacSets":{"delete":[1,2,1,""],create:[1,2,1,""],get:[1,2,1,""],list:[1,2,1,""],update:[1,2,1,""]},"com.vmware.nsx_client.MdProxies":{"delete":[1,2,1,""],create:[1,2,1,""],get:[1,2,1,""],list:[1,2,1,""],update:[1,2,1,""]},"com.vmware.nsx_client.Migration":{upgrademc:[1,2,1,""]},"com.vmware.nsx_client.MirrorSessions":{"delete":[1,2,1,""],create:[1,2,1,""],get:[1,2,1,""],list:[1,2,1,""],update:[1,2,1,""],verify:[1,2,1,""]},"com.vmware.nsx_client.NetworkMigrationSpecs":{"delete":[1,2,1,""],LIST_TYPE_HOSTPROFILENETWORKMIGRATIONSPEC:[1,3,1,""],create:[1,2,1,""],get:[1,2,1,""],list:[1,2,1,""],update:[1,2,1,""]},"com.vmware.nsx_client.Node":{get:[1,2,1,""],restart:[1,2,1,""],shutdown:[1,2,1,""],update:[1,2,1,""]},"com.vmware.nsx_client.Normalizations":{LIST_PREFERRED_NORMALIZATION_TYPE_DIRECTORYGROUP:[1,3,1,""],LIST_PREFERRED_NORMALIZATION_TYPE_IPSET:[1,3,1,""],LIST_PREFERRED_NORMALIZATION_TYPE_LOGICALPORT:[1,3,1,""],LIST_PREFERRED_NORMALIZATION_TYPE_LOGICALSWITCH:[1,3,1,""],LIST_PREFERRED_NORMALIZATION_TYPE_MACSET:[1,3,1,""],LIST_PREFERRED_NORMALIZATION_TYPE_NSGROUP:[1,3,1,""],LIST_RESOURCE_TYPE_NSGROUP:[1,3,1,""],list:[1,2,1,""]},"com.vmware.nsx_client.NsGroups":{"delete":[1,2,1,""],ADDORREMOVEEXPRESSION_ACTION_ADD_MEMBERS:[1,3,1,""],ADDORREMOVEEXPRESSION_ACTION_REMOVE_MEMBERS:[1,3,1,""],addorremoveexpression:[1,2,1,""],create:[1,2,1,""],get:[1,2,1,""],list:[1,2,1,""],update:[1,2,1,""]},"com.vmware.nsx_client.NsServiceGroups":{"delete":[1,2,1,""],create:[1,2,1,""],get:[1,2,1,""],list:[1,2,1,""],update:[1,2,1,""]},"com.vmware.nsx_client.NsServices":{"delete":[1,2,1,""],create:[1,2,1,""],get:[1,2,1,""],list:[1,2,1,""],update:[1,2,1,""]},"com.vmware.nsx_client.ServiceProfiles":{"delete":[1,2,1,""],create:[1,2,1,""],get:[1,2,1,""],list:[1,2,1,""],update:[1,2,1,""]},"com.vmware.nsx_client.Services":{"delete":[1,2,1,""],create:[1,2,1,""],get:[1,2,1,""],list:[1,2,1,""],update:[1,2,1,""]},"com.vmware.nsx_client.SwitchingProfiles":{"delete":[1,2,1,""],create:[1,2,1,""],get:[1,2,1,""],list:[1,2,1,""],update:[1,2,1,""]},"com.vmware.nsx_client.Tasks":{get:[1,2,1,""],list:[1,2,1,""]},"com.vmware.nsx_client.Traceflows":{"delete":[1,2,1,""],create:[1,2,1,""],get:[1,2,1,""],list:[1,2,1,""]},"com.vmware.nsx_client.TransportNodes":{"delete":[1,2,1,""],UPDATEMAINTENANCEMODE_ACTION_ENTER_MAINTENANCE_MODE:[1,3,1,""],UPDATEMAINTENANCEMODE_ACTION_EXIT_MAINTENANCE_MODE:[1,3,1,""],UPDATEMAINTENANCEMODE_ACTION_FORCED_ENTER_MAINTENANCE_MODE:[1,3,1,""],create:[1,2,1,""],get:[1,2,1,""],list:[1,2,1,""],resynchostconfig:[1,2,1,""],update:[1,2,1,""],updatemaintenancemode:[1,2,1,""]},"com.vmware.nsx_client.TransportZones":{"delete":[1,2,1,""],create:[1,2,1,""],get:[1,2,1,""],list:[1,2,1,""],update:[1,2,1,""]},"com.vmware.nsx_client.TransportzoneProfiles":{"delete":[1,2,1,""],create:[1,2,1,""],get:[1,2,1,""],list:[1,2,1,""],update:[1,2,1,""]},"com.vmware.nsx_client.TrustManagement":{get:[1,2,1,""]},"com.vmware.nsx_client.UiViews":{"delete":[1,2,1,""],create:[1,2,1,""],get:[1,2,1,""],get_0:[1,2,1,""],update:[1,2,1,""]},"com.vmware.nsx_client.Upgrade":{upgradeuc:[1,2,1,""]},"com.vmware.nsx_client_for_vmc":{CSPSecurityContextFilter:[1,1,1,""],VmcNsxClient:[1,1,1,""],create_nsx_client_for_vmc:[1,4,1,""]},"com.vmware.nsx_client_for_vmc.CSPSecurityContextFilter":{get_max_retries:[1,2,1,""],get_security_context:[1,2,1,""],should_retry:[1,2,1,""]},com:{vmware:[1,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","attribute","Python attribute"],"4":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:attribute","4":"py:function"},terms:{"0x00":2,"0x01":2,"2byte":2,"2xx":2,"3xx":2,"44g":2,"64bit":2,"802_3ad":2,"9bit":2,"abstract":2,"boolean":2,"break":[2,37],"byte":[2,8,14,16,29],"case":[1,2,3,15,32,33],"catch":2,"char":2,"class":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,35,36,37,38,39,40,41],"default":[1,2,3,4,5,6,9,15,18,21,23,24,25,26,30,32,37,38],"enum":[2,41],"export":[2,30],"final":2,"float":2,"function":[1,2],"import":[2,41],"int":1,"long":[1,2,3,4,5,6,9,15,18,21,23,24,25,32,37,38],"new":[1,2,15,21,23,26,32,33,38,41],"null":2,"public":[1,2,26],"return":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,35,36,37,38,39,40],"short":2,"static":[1,2,7,9,13,21,23,26],"super":2,"switch":[1,2,11,33,38,40],"throw":2,"true":[1,2],"try":2,"while":[1,2,4,21],AND:2,AWS:[2,38],Adding:15,Aging:2,And:2,Bus:[26,30],But:2,CAs:2,DNS:[2,10],Dns:2,ENS:2,For:[1,2,6,11,26],Has:2,IDs:[2,30],IKE:[2,38,39],IPs:2,Ids:[1,2],LBS:2,NFS:2,NOT:[1,2],Not:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,35,36,37,38,39,40],OVS:1,One:[1,2],PFS:2,SAs:2,TLS:2,That:[1,2,15],The:[1,2,3,9,16,20,22,23,26,30,32,36,38,41],Then:2,There:2,These:[1,2],Use:[1,2],Used:2,Useful:2,Using:2,VDS:1,VMs:[1,2,33],Will:2,With:2,________:2,___________________________________________:2,_arg:2,_host:2,_is_arg:2,_protect:2,_request_uri:2,_revis:2,_scheme:2,_server_port:2,_uri:2,aaa:[0,1,2,26,42],aaa_client:[0,1,42],abort:2,about:[1,2,7,11,13,21,23,25,26,30,31,37],abov:2,absens:26,absent:2,absolut:2,accept:[2,6,37],acceptable_vers:2,acceptablecomponentvers:2,acceptablecomponentversionlist:2,accepted_act:2,accepted_valu:2,access:[1,2,16,26],access_log_en:2,access_onli:2,accomplish:2,accord:2,account:2,account_nam:2,accuraci:2,ack:2,acknowledg:2,acl:2,acl_rule_id:2,across:[1,2,39],act:[1,2],action:[1,2,6,23],action_allow:2,action_bypass:2,action_deni:2,action_dnat:2,action_do_not_redirect:2,action_drop:2,action_no_dnat:2,action_no_nat:2,action_no_snat:2,action_overlai:2,action_overlay_nat:2,action_permit:2,action_protect:2,action_redirect:2,action_reflex:2,action_reject:2,action_snat:2,action_underlai:2,action_underlay_nat:2,actionableresourc:2,actionableresourcelistresult:[2,6],activ:[1,2,6,33],active_act:2,active_backup:2,active_flow_export_timeout:2,active_list:2,active_monitor_id:2,active_nod:2,active_sess:2,active_standbi:[1,2],active_timeout:2,active_transport_nod:2,active_vip_address:2,actual:2,adapt:2,add:[1,2,15,21,23,26,30,32,33],add_cluster_nod:2,add_cluster_node_spec:2,add_cluster_node_vm_info:6,add_memb:[1,2],addclusternodespec:2,addclusternodevminfo:[2,6],addcontrollernodespec:2,added:[1,2,11],adding:1,addit:[1,2],addition:1,addmanagementnodespec:2,addmemb:2,addmigrationunit:2,addorremoveexpress:1,addorremoveexpression_action_add_memb:1,addorremoveexpression_action_remove_memb:1,addr:2,address:[1,2,7,9,10,12,13,21,23,26,30,31],address_bind:2,address_famili:2,addressbindingentri:2,addsshkei:26,addupgradeunit:2,adjoin:2,admin:[2,7,13,26],admin_dist:2,admin_down:2,admin_st:[1,2],admin_state_dis:2,admin_state_down:2,admin_state_en:2,admin_state_graceful_dis:2,admin_state_up:2,admin_statu:2,admin_status_down:2,admin_status_up:2,administr:2,administration_cli:[0,1,42],administrative_dist:2,administratively_down:2,administratively_down_count:2,advanc:[1,2],advance_cluster_restore_request:2,advanceclusterrestoreinput:2,advanceclusterrestorerequest:2,advanced_config:2,advertis:[2,21,23],advertise_lb_snat_ip:2,advertise_lb_vip:2,advertise_nat_rout:2,advertise_nsx_connected_rout:2,advertise_rule_list:23,advertise_static_rout:2,advertised_route_typ:2,advertisednetwork:2,advertisednetworkslistresult:2,advertisement_cli:[0,1,2,21,42],advertisement_config:21,advertisementconfig:[2,21],advertisementrulefilt:2,advertiserul:2,advertiserulelist:[2,23],aes_128:2,aes_256:2,aes_gcm_128:2,aes_gcm_192:2,aes_gcm_256:2,affect:[2,38],after:[1,2,11],again:[2,15],against:[2,4],age:2,agent:[2,26,30],aggreg:[2,16,25,37,40],aggregate_traffic_count:2,aggregated_data_collection_frequ:2,aggregatedatarespons:2,aggregateddatacount:2,aggregateddatacounterex:2,aggregatedlogicalrouterportcount:2,aggregateinfo:[2,25,37],aggregaterequest:2,aggregaterespons:2,aging_tim:2,agreement:[2,37],aka:2,alarm:2,alarmlistresult:2,alarmsourc:2,alert:[2,30],alg:2,alg_ftp:2,alg_ms_rpc_tcp:2,alg_ms_rpc_udp:2,alg_nbdg_broadcast:2,alg_nbns_broadcast:2,alg_oracle_tn:2,alg_sun_rpc_tcp:2,alg_sun_rpc_udp:2,alg_tftp:2,algorithm:[1,2],algorithm_dsa:2,algorithm_ip_hash:2,algorithm_least_connect:2,algorithm_round_robin:2,algorithm_rsa:2,algorithm_weighted_least_connect:2,algorithm_weighted_round_robin:2,algtypensservic:2,alia:2,aliv:2,all:[1,2,3,6,11,12,15,16,20,21,22,23,25,26,32,33,36,37,38,39,40],allclustergroupstatu:2,allgi:2,alloc:[1,2,31],allocate_address:2,allocate_addresses_both:2,allocate_addresses_ippool:2,allocate_addresses_macpool:2,allocate_addresses_non:2,allocated_id:2,allocated_numb:2,allocated_percentag:2,allocateorreleas:2,allocateorrelease_action_alloc:2,allocateorrelease_action_releas:2,allocateorreleasefromipblocksubnet:2,allocateorreleasefromipblocksubnet_action_alloc:2,allocateorreleasefromipblocksubnet_action_releas:2,allocation_id:2,allocation_ip_address:2,allocation_list:2,allocation_pool:2,allocation_pool_typ:2,allocation_pool_type_loadbalancerallocationpool:2,allocation_profil:2,allocation_rang:2,allocation_s:2,allocation_size_larg:2,allocation_size_medium:2,allocation_size_smal:2,allocationipaddress:2,allocationipaddresslistresult:[2,31],allow:[1,2,15,41],allow_ssh_root_login:2,along:[2,7,15,32],alreadi:[1,2],also:[1,2,22,33],altern:6,alwai:[1,2],among:[2,15,32],amount:2,analysi:2,anchor:[2,15,32],ani:[1,2,7,12,26,30,38],announced_cap:2,anoth:[1,2,33],answer:[2,10],anywher:2,api:[1,2,3,11,16,18,23,26,41],api_failed_auth_lockout_period:[2,26],api_failed_auth_reset_period:[2,26],api_listen_addr:2,api_max_auth_failur:[2,26],apicli:1,apierror:2,app:[2,4],app_discoveri:[0,1,2,42],app_discovery_cli:[0,1,42],app_id:2,app_profil:2,app_profile_categori:2,app_profile_criteria:2,app_profile_id:[2,4],app_profile_nam:2,app_profile_summary_list:2,appdiscoveryappprofileresultsummari:2,appdiscoverysess:2,appdiscoverysessionresultsummari:[2,4],appdiscoverysessionslistresult:2,appdiscoveryvminfo:2,appdiscoveryvminfolistresult:[2,5],appear:2,append:[2,26],appinfo:2,appinfohostvmcsvrecord:2,appinfohostvmlistincsvformat:2,appinfolistresult:[2,4],appl:2,appli:[1,2,15,21,26],applianc:[1,2,26,30],appliance_mgmt_listen_addr:2,appliancemanagementtasklistresult:2,appliancemanagementtaskproperti:2,applic:[2,4,5,18],application_profil:2,application_profile_id:2,applicationprofil:2,applied_to:[2,15,32],applied_to_entity_id:1,applied_to_entity_typ:1,appliedto:[2,15,32],appliedtoentitytyp:1,applycertif:26,appnam:2,appplic:2,appprofil:[2,4],appprofilelistresult:[2,4],appprofilememberappscsvrecord:2,appprofilememberappslistincsvformat:2,appprofilemetainfo:2,appropri:2,arbitrari:2,architectur:1,area:[1,2],arg:2,argument:2,around:2,arp:2,arp_bindings_limit:2,arp_fail:2,arp_snoop:2,arp_snooping_en:2,arpa:2,arptabl:2,arrai:[1,2],articl:2,as_num:2,as_numb:[2,21],as_path_prepend:2,ascend:2,asdot:2,ask:2,asn:2,asplain:2,assign:[1,2],assignedbydhcp:2,associ:[1,2,6,18,26,33,35],associated_resource_typ:1,associatedresourcetyp:1,associationlistresult:[1,2],assum:2,asymmetr:2,asymmetric_credenti:2,async:2,async_response_avail:2,asynchron:[2,26],atleast:2,atom:[1,2],attach:[1,2,12,33,35,38],attached_logical_port_id:2,attachment_id:[1,2],attachment_point:2,attachment_point_tier0_lr:2,attachment_point_tier1_lr:2,attachment_statu:2,attachment_status_down:2,attachment_status_up:2,attachment_typ:[1,2],attachment_type_bridgeendpoint:2,attachment_type_dhcp_servic:2,attachment_type_l2vpn_sess:2,attachment_type_logicalrout:2,attachment_type_metadata_proxi:2,attachment_type_vif:2,attachmentcontext:2,attachmenttyp:[1,2],attack:2,attempt:[1,2,6],attent:2,attribut:[1,2,32,38,41],attribute_typ:2,attribute_type_ip_address:2,attribute_type_long:2,attribute_type_password:2,attribute_type_port:2,attribute_type_str:2,attrit:41,audit:2,audit_log_request:2,audit_password:2,audit_usernam:2,auditlog:2,auditloglistresult:2,auditlogrequest:2,auditor:2,auth:2,auth_cod:2,auth_token:2,authent:[2,26],authentication_mod:2,authentication_mode_psk:2,authentication_policy_properti:26,authentication_schem:2,authenticationpolicyproperti:[2,26],authenticationschem:2,author:2,authorit:2,authoritative_answ:2,authorized_kei:26,authpolici:26,authpriv:2,auto:[2,6],auto_install_nsx:2,autom:[1,2,6],automap:2,automat:[1,2,6,26],automcat:2,autoplumb:2,avaiabl:2,avaial:2,avail:[1,2,6],averag:2,average_bandwidth_kbp:2,average_bandwidth_mbp:2,avg_delta_sync_tim:2,avg_full_sync_tim:2,avoid:2,awai:[2,26],awk:2,b_gp_community_list:23,back:[1,2,6,41],backend:[1,2],background:2,backup:[1,2,6],backup_authentication_failur:2,backup_bad_fingerprint:2,backup_configur:6,backup_creating_cluster_backup:2,backup_creating_node_backup:2,backup_en:2,backup_generic_error:2,backup_id:2,backup_memb:2,backup_not_run_on_mast:2,backup_permission_error:2,backup_schedul:2,backup_server_unreach:2,backup_timeout:2,backup_timestamp:2,backupconfigur:[2,6],backupoperationhistori:[2,6],backupoperationstatu:2,backups_cli:[0,1,2,42],backupschedul:2,backuptimestamp:6,backuptoremot:1,backward:[1,2],bad:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,35,36,37,38,39,40],balanc:[1,2,18,19],bandwidth:2,bar1:2,bar2:2,bar:2,bare:2,barrier:2,barrier_id:15,base64:2,base:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,35,36,37,38,39,40,41],base_distinguished_nam:2,base_host_switch_profil:1,base_service_inst:32,base_switching_profil:1,base_url:2,basehostswitchprofil:[1,2],basenodeaggregateinfo:2,baseserviceinst:[2,32],baseswitchingprofil:[1,2],basic:2,basic_auth_whitelist_ip:2,basic_authent:2,basicauthenticationschem:2,batch:[1,2],batch_request:1,batchrequest:[1,2],batchrequestitem:2,batchrespons:[1,2],batchresponseitem:2,becaus:[1,2,26],becom:2,been:[2,6,11,21,31,33],befor:[1,2,6,25,26,37],begin:26,begun:2,behavior:2,behind:2,being:[1,2,6,23,33,38],believ:2,belog:2,belong:[2,33],below:[2,18],best:2,between:[1,2],beyond:2,bfd:[2,21,23],bfd_admin_down_count:2,bfd_allowed_hop:2,bfd_config:[2,21],bfd_declare_dead_multipl:2,bfd_diagnost:2,bfd_diagnostic_cod:2,bfd_down_count:2,bfd_enabl:2,bfd_init_count:2,bfd_peer_id:23,bfd_probe_interv:2,bfd_statu:2,bfd_up_count:2,bfdconfig:[2,21],bfdconfigparamet:2,bfddiagnosticcod:2,bfddiagnosticcount:2,bfdhealthmonitoringprofil:[1,2],bfdpeer:23,bfdproperti:2,bfdstatuscount:2,bgp:[0,1,2,21,23],bgp_client:[0,1,2,21,42],bgp_config:21,bgp_enabl:2,bgp_neighbor:23,bgpcommunitylist:[2,23],bgpcommunitylistlistresult:[2,23],bgpconfig:[2,21],bgpneighbor:[2,23],bgpneighboraddressfamili:2,bgpneighborlistresult:[2,23],bgpneighborsstatuslistresult:[2,24],bgpneighborstatu:2,bgprouteaggreg:2,bidirect:2,binarypacketdata:2,bind:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,35,36,37,38,39,40,41],binding_id:[2,9],binding_timestamp:2,bio:2,bios_uuid:2,bird:2,bit:2,black:2,blackhol:[2,26],blackhole_act:2,blackhole_action_discard:2,block:[2,21],block_id:2,block_non_ip_traff:2,blue:2,bodi:[1,2],body_valu:2,bond:2,bond_mod:2,bond_mode_802_3ad:2,bond_mode__802_3ad:2,bond_mode_active_backup:2,bond_primari:2,bond_slav:2,bool:[1,2,3,4,5,6,9,15,18,21,23,24,25,32,37,38],boot:[2,26,30],bootrepli:2,bootrequest:2,both:[1,2,9,25,37,39,41],bound:[2,15,32],bpdu:2,bpdu_filt:2,bpdu_filter_drop:2,bpdufilt:2,bpg:2,bridg:[1,2],bridge_clust:1,bridge_cluster_id:[1,2],bridge_clusters_cli:[0,1,42],bridge_endpoint:1,bridge_endpoint_profil:1,bridge_endpoint_profile_id:[1,2],bridge_endpoints_cli:[0,1,42],bridge_nod:2,bridgeclust:[1,2],bridgecluster_id:1,bridgeclusterlistresult:[1,2],bridgeclusternod:2,bridgeclusterstatu:2,bridgeendpoint:[1,2],bridgeendpoint_id:1,bridgeendpointlistresult:[1,2],bridgeendpointprofil:[1,2],bridgeendpointprofile_id:1,bridgeendpointprofilelistresult:[1,2],bridgeendpointstatist:2,bridgeendpointstatu:2,bridgehighavailabilityclusterprofil:[1,2],bring:2,broadcast:[2,7,13,26],broadcast_address:2,broker:2,browser:2,budget:2,buffer:2,build:2,built:2,bulk:2,bulletin:2,bulletin_id:2,bum:2,bum_bytes_in:2,bum_bytes_out:2,bum_packets_in:2,bum_packets_out:2,bundl:[2,25,37],bundle_id:[2,25,37],bundle_nam:2,bundle_s:2,bundles_cli:[0,1,2,42],burst:2,burst_size_byt:2,bus:2,byod:2,byodserviceinst:2,bypass:2,bypass_rul:2,byte_count:2,bytes_in:2,bytes_in_r:2,bytes_out:2,bytes_out_r:2,cach:[2,6,7,8,9,11,13,14,15,16,18,19,20,21,22,24,35,36,38,39,40],cache_s:2,calcul:2,call:[1,2,6],callback:33,caller:2,can:[1,2,9,23,26,30,38,41],can_skip:2,cancel:2,candid:2,cannot:[1,2,26],cant:2,cap:2,capabl:[2,11],capac:[2,18],capacity_typ:2,capacity_type_cpu:2,capacity_type_us:2,capacity_type_vm:2,capacity_usag:2,capacityusag:2,capamount:2,capdur:2,capfiles:2,capmod:2,capmode_standalon:2,capmode_stream:2,cappoint:2,cappoint_dvfilt:2,cappoint_logicalport:2,cappoint_vdrport:2,cappoint_vif:2,cappoint_vmkn:2,cappoint_vmn:2,cappoint_vn:2,caprat:2,capsourc:2,capsource_cli:2,capsource_ui:2,captur:[2,38],capvalu:2,card:1,care:2,carri:2,carrier:2,carv:2,cascad:[1,2],case_sensit:2,categori:[2,15],caus:[2,26],cc_ext_id:[2,12],ccp:2,ccp_statu:2,ccpupgradestatu:2,ceip_accept:2,cell:2,center:[1,2],centoskvm:2,centosserv:2,central:2,centralizedserviceport:2,cert:2,cert_id:2,cert_thumbprint:2,certain:[1,2],certfic:2,certif:[2,26],certificate_ca:2,certificate_chain_depth:2,certificate_id:[2,26],certificate_self_sign:2,certificate_sha256_thumbprint:2,certificate_sign:2,certificatelist:2,chain:[1,2],challeng:2,chang:[1,2,21,26,38],channel:2,charact:2,characterist:[1,2],chart:2,check:[2,3],checkifexist:2,child:2,choic:1,choos:2,chosen:2,cidr:[2,21],cipher:[2,18],cipher_ecdh_ecdsa_with_aes_128_cbc_sha256:2,cipher_ecdh_ecdsa_with_aes_128_cbc_sha:2,cipher_ecdh_ecdsa_with_aes_128_gcm_sha256:2,cipher_ecdh_ecdsa_with_aes_256_cbc_sha384:2,cipher_ecdh_ecdsa_with_aes_256_cbc_sha:2,cipher_ecdh_ecdsa_with_aes_256_gcm_sha384:2,cipher_ecdh_rsa_with_aes_128_cbc_sha256:2,cipher_ecdh_rsa_with_aes_128_cbc_sha:2,cipher_ecdh_rsa_with_aes_128_gcm_sha256:2,cipher_ecdh_rsa_with_aes_256_cbc_sha384:2,cipher_ecdh_rsa_with_aes_256_cbc_sha:2,cipher_ecdh_rsa_with_aes_256_gcm_sha384:2,cipher_ecdhe_ecdsa_with_aes_128_cbc_sha256:2,cipher_ecdhe_ecdsa_with_aes_128_cbc_sha:2,cipher_ecdhe_ecdsa_with_aes_128_gcm_sha256:2,cipher_ecdhe_ecdsa_with_aes_256_cbc_sha384:2,cipher_ecdhe_ecdsa_with_aes_256_cbc_sha:2,cipher_ecdhe_ecdsa_with_aes_256_gcm_sha384:2,cipher_ecdhe_rsa_with_aes_128_cbc_sha256:2,cipher_ecdhe_rsa_with_aes_128_cbc_sha:2,cipher_ecdhe_rsa_with_aes_128_gcm_sha256:2,cipher_ecdhe_rsa_with_aes_256_cbc_sha384:2,cipher_ecdhe_rsa_with_aes_256_cbc_sha:2,cipher_ecdhe_rsa_with_aes_256_gcm_sha384:2,cipher_group_label:2,cipher_group_label_balanc:2,cipher_group_label_custom:2,cipher_group_label_high_compat:2,cipher_group_label_high_secur:2,cipher_group_labels_balanc:2,cipher_group_labels_custom:2,cipher_group_labels_high_compat:2,cipher_group_labels_high_secur:2,cipher_rsa_with_3des_ede_cbc_sha:2,cipher_rsa_with_aes_128_cbc_sha256:2,cipher_rsa_with_aes_128_cbc_sha:2,cipher_rsa_with_aes_128_gcm_sha256:2,cipher_rsa_with_aes_256_cbc_sha256:2,cipher_rsa_with_aes_256_cbc_sha:2,cipher_rsa_with_aes_256_gcm_sha384:2,cipher_suit:2,ciphers_ecdh_ecdsa_with_aes_128_cbc_sha256:2,ciphers_ecdh_ecdsa_with_aes_128_cbc_sha:2,ciphers_ecdh_ecdsa_with_aes_128_gcm_sha256:2,ciphers_ecdh_ecdsa_with_aes_256_cbc_sha384:2,ciphers_ecdh_ecdsa_with_aes_256_cbc_sha:2,ciphers_ecdh_ecdsa_with_aes_256_gcm_sha384:2,ciphers_ecdh_rsa_with_aes_128_cbc_sha256:2,ciphers_ecdh_rsa_with_aes_128_cbc_sha:2,ciphers_ecdh_rsa_with_aes_128_gcm_sha256:2,ciphers_ecdh_rsa_with_aes_256_cbc_sha384:2,ciphers_ecdh_rsa_with_aes_256_cbc_sha:2,ciphers_ecdh_rsa_with_aes_256_gcm_sha384:2,ciphers_ecdhe_ecdsa_with_aes_128_cbc_sha256:2,ciphers_ecdhe_ecdsa_with_aes_128_cbc_sha:2,ciphers_ecdhe_ecdsa_with_aes_128_gcm_sha256:2,ciphers_ecdhe_ecdsa_with_aes_256_cbc_sha384:2,ciphers_ecdhe_ecdsa_with_aes_256_cbc_sha:2,ciphers_ecdhe_ecdsa_with_aes_256_gcm_sha384:2,ciphers_ecdhe_rsa_with_aes_128_cbc_sha256:2,ciphers_ecdhe_rsa_with_aes_128_cbc_sha:2,ciphers_ecdhe_rsa_with_aes_128_gcm_sha256:2,ciphers_ecdhe_rsa_with_aes_256_cbc_sha384:2,ciphers_ecdhe_rsa_with_aes_256_cbc_sha:2,ciphers_ecdhe_rsa_with_aes_256_gcm_sha384:2,ciphers_rsa_with_3des_ede_cbc_sha:2,ciphers_rsa_with_aes_128_cbc_sha256:2,ciphers_rsa_with_aes_128_cbc_sha:2,ciphers_rsa_with_aes_128_gcm_sha256:2,ciphers_rsa_with_aes_256_cbc_sha256:2,ciphers_rsa_with_aes_256_cbc_sha:2,ciphers_rsa_with_aes_256_gcm_sha384:2,ciphersandprotocol:18,ciphersuit:2,class_of_servic:2,classifi:[2,4],classless:2,classlessstaticrout:2,clean:[2,6],clear:[2,23],clear_password:23,clearcach:2,cli:[2,26],cli_failed_auth_lockout_period:2,cli_max_auth_failur:2,cli_password:2,cli_timeout:2,cli_usernam:2,click:2,clickabl:2,client:[1,2,15],client_api_concurrency_limit:2,client_api_rate_limit:2,client_auth:2,client_auth_ca_id:2,client_auth_crl_id:2,client_auth_ignor:2,client_auth_requir:2,client_block_en:2,client_certificate_id:2,client_certificate_issuer_dn:2,client_certificate_subject_dn:2,client_id:2,client_secret:2,client_ssl_profil:2,client_ssl_profile_bind:2,client_ssl_profile_id:2,client_supported_ssl_ciph:2,client_supported_ssl_ciphers_ecdh_ecdsa_with_aes_128_cbc_sha256:2,client_supported_ssl_ciphers_ecdh_ecdsa_with_aes_128_cbc_sha:2,client_supported_ssl_ciphers_ecdh_ecdsa_with_aes_128_gcm_sha256:2,client_supported_ssl_ciphers_ecdh_ecdsa_with_aes_256_cbc_sha384:2,client_supported_ssl_ciphers_ecdh_ecdsa_with_aes_256_cbc_sha:2,client_supported_ssl_ciphers_ecdh_ecdsa_with_aes_256_gcm_sha384:2,client_supported_ssl_ciphers_ecdh_rsa_with_aes_128_cbc_sha256:2,client_supported_ssl_ciphers_ecdh_rsa_with_aes_128_cbc_sha:2,client_supported_ssl_ciphers_ecdh_rsa_with_aes_128_gcm_sha256:2,client_supported_ssl_ciphers_ecdh_rsa_with_aes_256_cbc_sha384:2,client_supported_ssl_ciphers_ecdh_rsa_with_aes_256_cbc_sha:2,client_supported_ssl_ciphers_ecdh_rsa_with_aes_256_gcm_sha384:2,client_supported_ssl_ciphers_ecdhe_ecdsa_with_aes_128_cbc_sha256:2,client_supported_ssl_ciphers_ecdhe_ecdsa_with_aes_128_cbc_sha:2,client_supported_ssl_ciphers_ecdhe_ecdsa_with_aes_128_gcm_sha256:2,client_supported_ssl_ciphers_ecdhe_ecdsa_with_aes_256_cbc_sha384:2,client_supported_ssl_ciphers_ecdhe_ecdsa_with_aes_256_cbc_sha:2,client_supported_ssl_ciphers_ecdhe_ecdsa_with_aes_256_gcm_sha384:2,client_supported_ssl_ciphers_ecdhe_rsa_with_aes_128_cbc_sha256:2,client_supported_ssl_ciphers_ecdhe_rsa_with_aes_128_cbc_sha:2,client_supported_ssl_ciphers_ecdhe_rsa_with_aes_128_gcm_sha256:2,client_supported_ssl_ciphers_ecdhe_rsa_with_aes_256_cbc_sha384:2,client_supported_ssl_ciphers_ecdhe_rsa_with_aes_256_cbc_sha:2,client_supported_ssl_ciphers_ecdhe_rsa_with_aes_256_gcm_sha384:2,client_supported_ssl_ciphers_rsa_with_3des_ede_cbc_sha:2,client_supported_ssl_ciphers_rsa_with_aes_128_cbc_sha256:2,client_supported_ssl_ciphers_rsa_with_aes_128_cbc_sha:2,client_supported_ssl_ciphers_rsa_with_aes_128_gcm_sha256:2,client_supported_ssl_ciphers_rsa_with_aes_256_cbc_sha256:2,client_supported_ssl_ciphers_rsa_with_aes_256_cbc_sha:2,client_supported_ssl_ciphers_rsa_with_aes_256_gcm_sha384:2,client_tcp_profile_id:2,client_typ:2,client_type_collection_configur:2,client_type_control_plan:2,client_type_control_plane_platform:2,client_type_edg:2,client_type_hypervisor:2,client_type_management_plan:2,client_type_management_plane_platform:2,clientsslprofil:2,clientsslprofilebind:2,clienttypecollectionconfigur:2,close:2,close_timeout:2,cloud:[1,2],cloud_admin:2,cloud_auditor:2,cloud_service_admin:2,cloud_service_auditor:2,cluser:2,cluster:[0,1,2,26,30,42],cluster_api_certif:2,cluster_backup_status:2,cluster_cli:[0,1,42],cluster_id:2,cluster_manager_cli:[0,1,2,26,42],cluster_profil:1,cluster_profile_bind:2,cluster_profile_id:1,cluster_statu:2,clusterbackupinfo:2,clusterbackupinfolistresult:[2,6],clusterconfig:[1,2],clustergroupmemberstatu:2,clustergroupservicelead:2,clustergroupstatu:2,clustering_config:2,clustering_param:2,clustering_typ:2,clustering_type_controlclusteringconfig:2,clusteringconfig:2,clusteringinfo:2,clusterinitializationnodeinfo:2,clustermanag:26,clusternodeconfig:2,clusternodeconfiglistresult:2,clusternodestatu:[2,6],clusternodevmdeploymentconfig:2,clusternodevmdeploymentrequest:[2,6],clusternodevmdeploymentrequestlist:[2,6],clusternodevmdeploymentstatusreport:[2,7],clusterprofil:[1,2],clusterprofilelistresult:[1,2],clusterprofiletypeidentri:2,clusterrestorestatu:[2,6],clusterroleconfig:2,clustersaggregateinfo:[2,6],clusterstatu:2,cm_inventory_cli:[0,1,2,26,42],cm_local_id:2,cminventori:26,code:[1,2,15,40],collecor:2,collect:[1,2,12,16,30],collection_frequ:2,collector:[1,2,30],collector_config_id:2,collector_ip_address:2,collector_port:2,collector_profil:2,collectorconfig:2,collis:[2,8,14,29],colon:2,color:2,color_blu:2,color_green:2,color_grei:2,color_r:2,color_sky_blu:2,color_yellow:2,column:2,column_identifi:2,columnitem:2,com:[41,42],combin:[1,2],come:2,comma:[1,2,3,4,5,6,9,15,18,21,23,24,25,32,37,38],command:2,comment:2,common:2,commonli:[1,2],commun:[1,2,23,41],community_list_id:[2,23],community_str:2,community_typ:2,community_type_normalbgpcommun:2,communitylist:23,communitymatchexpress:2,communitymatchoper:2,communtylist:23,comp:2,compar:[2,16],compat:[1,2],complet:[1,2,4,11,26],complex:2,compliant:2,compon:[1,2,25,37],component_id:2,component_nam:2,component_statu:2,component_sub_typ:2,component_sub_type_lr_tier0:2,component_sub_type_lr_tier1:2,component_sub_type_lr_vrf_tier0:2,component_sub_type_ls_transit:2,component_sub_type_unknown:2,component_target_vers:2,component_typ:[2,25,37],component_type_bridg:2,component_type_ccp:2,component_type_dfw:2,component_type_edg:2,component_type_edge_hostswitch:2,component_type_edge_tunnel:2,component_type_host:2,component_type_l:2,component_type_lr:2,component_type_mp:2,component_type_phys:2,component_type_unknown:2,component_vers:2,componentmigrationstatu:2,componenttargetvers:2,componenttyp:2,componentupgradestatu:2,compos:2,compromis:2,comput:[1,2,11,12,16,26],compute_collect:[0,1,2,11,42],compute_collection_fabric_templ:2,compute_collection_id:[1,2],compute_collection_transport_node_templ:1,compute_collection_transport_node_templates_cli:[0,1,42],compute_id:2,compute_manag:2,compute_manager_id:[2,11],compute_managers_cli:[0,1,2,42],compute_managers_soft_limit:2,computecollect:[1,2],computecollectionfabrictempl:2,computecollectionfabrictemplatelistresult:2,computecollectionlistresult:2,computecollectionnetworkinterfaceslistresult:[2,12],computecollectiontransportnodetempl:[1,2],computecollectiontransportnodetemplatest:2,computecollectiontransportnodetemplatestatelist:2,computemanag:2,computemanagerlistresult:2,computemanagerstatu:[2,11],concaten:2,concatenated_path_down:2,concatenated_path_down_count:2,concret:2,concurr:[2,15],concurrentchang:[1,2,26,30],condit:2,conditional_forward:2,conditionalforwarderzon:2,config:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,35,36,37,38,39,40],config_id:2,config_pair:2,configr:2,configs_cli:[0,1,42],configu:2,configur:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,35,36,37,38,39,40],configurationst:[2,11],configurationstateel:2,conflict:[1,2,26,30],conjunct:2,connect:[1,2,11,21],connected_switch:2,connection_drop_count:2,connection_error:2,connection_initiation_mod:2,connection_initiation_mode_initi:2,connection_initiation_mode_on_demand:2,connection_initiation_mode_respond_onli:2,connection_refus:2,connection_st:2,connection_state_act:2,connection_state_connect:2,connection_state_establish:2,connection_state_idl:2,connection_state_invalid:2,connection_state_open_confirm:2,connection_state_open_s:2,connection_statu:2,connection_status_connect:2,connection_status_detail:2,connection_status_down:2,connection_status_up:2,connection_timeout:2,connectionless:2,connectivity_statu:2,connectivity_status_connect:2,connectivity_status_disconnect:2,connectivity_status_unknown:2,connector:1,consecut:2,consid:[1,2],consist:2,consol:2,consolid:2,consum:[1,2,38],consumpt:2,contain:[1,2,6,32,38,41],container_ports_onli:[1,2],containerconfigur:2,content:[2,15,37,42],content_filt:2,content_filters_al:2,content_filters_default:2,context:[1,2],context_id:2,context_logical_rout:2,context_transport_nod:2,context_typ:2,contian:2,contigu:2,continu:[2,26],continue_:2,continue_on_error:2,contraint:2,control:[1,2,6,26],control_cluster_changes_allow:2,control_cluster_listen_addr:2,control_cluster_statu:2,control_cluster_status_connect:2,control_cluster_status_disconnect:2,control_cluster_status_unknown:2,control_connection_statu:2,control_detection_time_expir:2,control_detection_time_expired_count:2,control_node_ip:2,control_plan:2,control_plane_listen_addr:2,control_plane_platform:2,control_plane_server_certif:2,controlclusteringconfig:2,controlclusternodestatu:2,controlconnstatu:2,controller_clust:2,controller_rejected_host_cert:2,controller_rol:2,controller_role_config:2,controllerclusterroleconfig:2,controllerclusterstatu:2,controllernodeaggregateinfo:2,convei:6,conveni:1,converg:2,convert:2,cooki:2,cookie_domain:2,cookie_fallback:2,cookie_garbl:2,cookie_max_idl:2,cookie_max_lif:2,cookie_mod:2,cookie_mode_insert:2,cookie_mode_prefix:2,cookie_mode_rewrit:2,cookie_nam:2,cookie_path:2,cookie_tim:2,cookie_valu:2,coordin:[1,2],copi:2,copy_from_remote_file_properti:2,copy_to_remote_file_properti:2,copyfromremotefil:2,copyfromremotefileproperti:2,copyremotefileproperti:2,copytoremotefil:2,copytoremotefileproperti:2,core:[1,2],correct:2,correspond:[1,2],could:[1,2],count:[2,16],counter:[2,16],countri:2,cover:2,cpu:2,cpu_config:2,cpu_cor:2,cpu_tim:2,cpu_usag:2,cpu_usage_count:2,cpucoreconfigforenhancednetworkingstackswitch:2,crash:2,creat:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,35,36,37,38,39,40,41],create_0:2,create_0_action_add_memb:2,create_0_action_remove_memb:2,create_0_action_update_memb:2,create_action_nod:2,create_action_nsx:2,create_nsx_client_for_vmc:1,create_operation_aft:[2,15,32],create_operation_befor:[2,15,32],create_operation_bottom:[2,15,32],create_operation_top:[2,15,32],create_remote_directory_properti:2,create_tim:2,create_us:2,created_epoch_m:2,createmultipl:[15,32],createmultiple_operation_aft:[15,32],createmultiple_operation_befor:[15,32],createmultiple_operation_bottom:[15,32],createmultiple_operation_top:[15,32],createremotedirectori:2,createremotedirectoryproperti:2,createspec:41,createwidgetconfigur:2,createwithrul:2,createwithrules_operation_aft:2,createwithrules_operation_befor:2,createwithrules_operation_bottom:2,createwithrules_operation_top:2,creation:[1,2],credenti:2,credential_kei:2,credential_typ:2,credential_verifi:2,crit:[2,30],criteria:2,criterion:2,critic:2,crl:2,crl_entri:2,crl_id:2,crl_object_data:2,crllist:2,crlobjectdata:2,cron:2,crt:2,crud:2,crypto:2,crypto_protocol:2,crypto_protocols_v1:2,crypto_protocols_v1_1:2,crypto_protocols_v1_2:2,cryptoalgorithm:2,cryptogaph:2,cryptograph:2,csp:[1,2],csp_client_credenti:2,csp_client_incoming_credenti:2,csp_org_uri:2,csp_time_drift:2,csp_url:1,cspsecuritycontextfilt:1,csr:2,csr_id:2,csrlist:2,csv:2,csvlistresult:2,csvrecord:2,cumul:38,current:[1,2,3,4,5,6,7,9,11,15,18,21,23,24,25,26,32,37,38,41],current_barrier_numb:2,current_pool_count:2,current_pool_member_count:2,current_sess:2,current_session_r:2,current_st:2,current_state_begin_tim:2,current_state_delta_sync:2,current_state_full_sync:2,current_state_idl:2,current_step:2,current_step_cluster_backup:2,current_step_messag:2,current_step_node_backup:2,current_vers:2,current_virtual_server_count:2,currentbackupoperationstatu:[2,6],currentrealizationstatebarri:2,cursor:[1,2,3,4,5,6,9,15,18,21,23,24,25,32,37,38],custom:[1,2,38],custom_data:2,customer_id:2,customized_memb:2,cycl:2,daemon:2,dai:[1,2],daili:2,dailytelemetryschedul:2,dash:2,dashboard:2,data1:2,data2:2,data:[1,2,6,7,8,9,11,13,14,15,16,18,19,20,21,22,24,35,36,38,39,40],data_length:2,data_network_id:2,data_path_not_readi:2,data_typ:2,data_type_configur:2,data_type_numb:2,data_type_password:2,data_type_statist:2,data_type_statu:2,data_type_text:2,databas:2,datacount:2,datapath:2,datasourc:2,datastor:2,datatyp:2,datatypecollectionconfigur:2,date:2,day_of_month:2,day_of_week:2,day_of_week_fridai:2,day_of_week_mondai:2,day_of_week_saturdai:2,day_of_week_sundai:2,day_of_week_thursdai:2,day_of_week_tuesdai:2,day_of_week_wednesdai:2,days_of_week:2,days_valid:2,dead:[2,38],deb:2,debug:[2,18],debuginfo:18,decid:2,declar:2,declare_dead_multipl:2,declin:2,decommiss:2,decreas:2,decrement:2,decrypt:2,decryption_failur:2,dedic:2,default_app_profil:2,default_certificate_id:2,default_forward:2,default_gatewai:2,default_gateway_address:2,default_org_id:2,default_pool_member_port:2,default_servic:[1,2],defin:[1,2,21,32,38,41],definit:[1,2],defragment:2,degrad:2,degraded_count:2,degraded_sess:2,delai:[2,16],delet:[1,2,6,9,15,21,23,26,30,32,33,38],delete_0:[1,2],delete_associated_rul:2,delete_stale_bind:2,deletestalebind:2,delimit:2,deliv:2,delivered_count:2,delta:2,delta_sync:2,delta_sync_interv:2,deni:2,denot:2,depend:[1,2,38],deploi:[2,6,33],deploy:[1,2,6,7,11,33],deployed_to:2,deployment_config:2,deployment_fail:2,deployment_in_progress:2,deployment_mod:2,deployment_mode_active_standbi:2,deployment_mode_stand_alon:2,deployment_request:2,deployment_spec:2,deployment_spec_nam:2,deployment_statu:2,deployment_status_deployment_fail:2,deployment_status_deployment_in_progress:2,deployment_status_deployment_success:2,deployment_status_undeployment_fail:2,deployment_status_undeployment_in_progress:2,deployment_status_undeployment_success:2,deployment_status_unknown:2,deployment_status_upgrade_fail:2,deployment_status_upgrade_in_progress:2,deployment_success:2,deployment_templ:2,deployment_typ:2,deployment_type_physical_machin:2,deployment_type_unknown:2,deployment_type_virtual_machin:2,deploymentconfig:2,deployments_cli:[0,1,2,6,42],deploymentspec:2,deploymenttempl:2,deploymenttyp:[1,2],deprec:[1,2],depth:2,deriv:2,descend:2,describ:[1,2],descript:[1,2,23,41],deselect:[2,25,37],desir:2,dest_network_id:2,dest_pnic:2,destin:[1,2,15,26,32],destination_address:2,destination_bgp:2,destination_ip:2,destination_nsx:2,destination_nsx_connect:2,destination_nsx_ip:2,destination_nsx_password:2,destination_nsx_port:2,destination_nsx_stat:2,destination_nsx_usernam:2,destination_port:2,destination_stat:2,destination_tier0_nat:2,destination_tier1_lb_snat:2,destination_tier1_lb_vip:2,destination_tier1_nat:2,destination_transport_port:2,destinationfilteringconfigur:2,destinationnsxapiendpoint:2,destinationprotocol:2,destinations_exclud:2,destmac:2,detach:[1,2,6],detail:[2,4,7,11,13,23,26,33],detailed_statu:2,detect:[2,8,14,29,38],determin:[1,2],devic:2,device_kei:2,device_nam:2,df_polici:2,df_policy_clear:2,df_policy_copi:2,dfw:2,dh_group:2,dh_groups_group14:2,dh_groups_group15:2,dh_groups_group16:2,dh_groups_group2:2,dh_groups_group5:2,dhcp:[0,1,2,7,13,26,42],dhcp_client:[0,1,42],dhcp_client_dropped_ipv4:2,dhcp_client_dropped_ipv6:2,dhcp_filter:2,dhcp_header:2,dhcp_ip_pool:9,dhcp_ip_pool_id:2,dhcp_profil:2,dhcp_profile_id:2,dhcp_relay_profil:2,dhcp_relay_profile_id:2,dhcp_relay_servic:2,dhcp_server_dropped_ipv4:2,dhcp_server_dropped_ipv6:2,dhcp_server_id:2,dhcp_server_ip:2,dhcp_servic:[1,2],dhcp_snoop:2,dhcp_snooping_en:2,dhcp_static_bind:9,dhcpfilter:2,dhcpheader:2,dhcpippool:[2,9],dhcpippoollistresult:[2,9],dhcpippoolusag:2,dhcpleas:[2,9],dhcpleaseperip:2,dhcpoption121:2,dhcpoption:2,dhcpprofil:2,dhcpprofilelistresult:2,dhcprelayprofil:[1,2],dhcprelayprofilelistresult:2,dhcprelayservic:[1,2],dhcprelayservicelistresult:2,dhcpserverstatu:[2,9],dhcpstaticbind:[2,9],dhcpstaticbindinglistresult:[2,9],dhcpstatist:[2,9],diagnost:[1,2],diagram:2,differ:[1,2],differenit:2,differenti:2,diffi:2,digest:2,digest_algorithm:2,digest_algorithms_sha1:2,digest_algorithms_sha2_256:2,digest_algorithms_sha2_384:2,digest_algorithms_sha2_512:2,digit:2,direct:2,direction_bidirect:2,direction_du:2,direction_egress:2,direction_in:2,direction_in_out:2,direction_ingress:2,direction_input:2,direction_out:2,direction_output:2,directli:2,directori:2,directory_path:2,directoryaddomain:2,directoryadgroup:2,directorydomain:2,directorydomainlistresult:2,directorydomainsyncnod:2,directorydomainsyncnodelistresult:2,directorydomainsyncremotenod:2,directorydomainsyncset:2,directorydomainsyncstat:2,directorygroup:[1,2],directorygrouplistresult:2,directorygroupmemb:2,directorygroupmemberlistresult:2,directoryldapserv:2,directoryldapserverlistresult:2,disabl:[2,26],disable_vm_migr:2,disablefirewal:2,disallow:2,discard:2,disconnect:2,discov:[2,12],discovered_bind:2,discovered_ip_address:2,discovered_node_id:2,discoverednod:2,discoverednodeinterfaceproperti:2,discoverednodelistresult:2,discoverednodenetworkinterfac:2,discoveredresourc:2,discoveri:[1,2,4,5],discrimin:2,disk:2,disk_store_id:2,dispatch:2,displai:[1,2,3],display:2,display_count:2,display_nam:[1,2,23],display_valu:2,disposit:2,disrupt:1,distanc:[2,26],distinguish:2,distinguished_nam:2,distribut:[2,15,32],divid:2,dnat:2,dnrout:2,dns:[0,1,2,42],dns_client:[0,1,42],dns_forward:2,dns_header:2,dns_nameserv:2,dns_server:2,dns_suffix:2,dnsanswer:[2,10],dnsforward:2,dnsforwarderlistresult:2,dnsheader:2,dnsqueryansw:2,do_not_redirect:2,dock_to_container_foot:2,document:[1,2],doe:[2,26,41],doesn:[2,26],doing:1,domain:[2,26],domain_id:2,domain_nam:2,domain_sync_node_id:2,don:1,done:1,donut:2,donutconfigur:2,donutpart:2,donutsect:2,down:[1,2,11],down_count:2,downlink:[1,2],downlink_port:2,download:[2,18],dpd:[2,38],dpd_probe_interv:2,dpd_profile_id:2,dpdprofil:38,draw:2,drift:2,drilldown:2,drilldown_id:2,drop:[2,8,14,29],dropkick:2,dropped_by_security_packet:2,dropped_count:2,dropped_packet:2,dropped_packets_in:2,dropped_packets_out:2,dsa:2,dsa_public_keyg:2,dsa_public_keyi:2,dsa_public_keyp:2,dsa_public_keyq:2,dscp:2,dscpmode:2,dsinsertparamet:2,dsrule:2,dsrulest:2,dssection:2,dssectionlistresult:2,dssectionqueryparamet:2,dssectionst:2,dsservic:2,dst_component_id:2,dst_component_nam:2,dst_component_typ:2,dst_component_type_bridg:2,dst_component_type_dfw:2,dst_component_type_edge_hostswitch:2,dst_component_type_edge_tunnel:2,dst_component_type_l:2,dst_component_type_lr:2,dst_component_type_phys:2,dst_component_type_unknown:2,dst_ip:2,dst_mac:2,dst_port:2,dst_transport_node_id:2,dst_transport_node_nam:2,dstip:2,dstmac:2,dstport:2,dual:2,due:2,durat:2,dure:[2,33],dvfilter:2,dynam:2,dynamic_res_pool_nam:2,dynamicstructur:2,ea_org:2,each:[1,2,7,13,15,21,26],eas:2,east_west:2,ecdsa:2,echo:2,echo_function_fail:2,echo_function_failed_count:2,ecmp:2,edg:[1,2,11,16,26],edge_clust:1,edge_cluster_id:[1,2],edge_cluster_member_index:2,edge_cluster_member_indic:2,edge_cluster_member_transport_nod:1,edge_config_error:2,edge_hostswitch:2,edge_nod:2,edge_node_group:2,edge_node_id:2,edge_statu:2,edge_tunnel:2,edgeclust:[1,2],edgeclusterlistresult:[1,2],edgeclustermemb:2,edgeclustermemberallocationpool:2,edgeclustermemberallocationprofil:2,edgeclustermemberlistresult:2,edgeclustermembertransportnod:[1,2],edgehighavailabilityprofil:[1,2],edgenod:[1,2],edgenodedeploymentconfig:2,edgeupgradestatu:2,edit:[1,2,38],effect:2,effectiveipaddressmemb:2,effectiveipaddressmemberlistresult:2,effectivelogicalportmemb:2,effectivelogicalswitchmemb:2,effectivememberresourcelistresult:2,effectivemembertypelistresult:2,effectivevirtualmachinememb:2,effort:2,egress:[2,26],egress_interfac:2,egressrateshap:2,either:[1,2,9],elect:2,element:[1,2],elig:1,els:[1,2,41],embed:[1,2],embeddedresourc:2,emerg:[2,30],emit:2,empti:[1,2,23],enabl:[1,2,21,23,26],enable_bfd:2,enable_full_mesh:2,enable_netx:2,enable_perfect_forward_secreci:2,enable_ssh:2,enabled_cap:2,enabled_on:2,enabled_pending_reboot:2,enablefirewal:2,encap:2,encap_genev:2,encap_stt:2,encap_unknown_encap:2,encap_vxlan:2,encapsul:2,encapsulation_mod:2,encapsulation_mode_mod:2,encapsulation_typ:2,encapsulation_type_erspan_thre:2,encapsulation_type_erspan_two:2,encapsulation_type_gr:2,encapsulation_vlan_id:2,encod:[1,2],encount:2,encrypt:2,encryption_algorithm:2,encryption_algorithms_128:2,encryption_algorithms_256:2,encryption_algorithms__128:2,encryption_algorithms__256:2,encryption_algorithms_aes_128:2,encryption_algorithms_aes_256:2,encryption_algorithms_aes_gcm_128:2,encryption_algorithms_aes_gcm_192:2,encryption_algorithms_aes_gcm_256:2,encryption_algorithms_gcm_128:2,encryption_algorithms_gcm_192:2,encryption_algorithms_gcm_256:2,encryption_algorithms_no_encrypt:2,encryption_algorithms_no_encryption_auth_aes_gmac_128:2,encryption_algorithms_no_encryption_auth_aes_gmac_192:2,encryption_algorithms_no_encryption_auth_aes_gmac_256:2,encryption_failur:2,end:[2,37],end_tim:2,end_timestamp:2,endoint:1,endpoint:[1,2,33,38],endpoint_id:2,endpoint_typ:2,endpoint_type_log:2,endpoint_type_virtu:2,endpointipconfig:2,ends_with:2,endtim:2,enforc:2,enforced_on:2,enforcedon:2,engin:2,enhanc:2,enndpoint:2,enough:2,ens_cap:2,ens_en:2,ensur:2,ent_id:2,enter:2,enter_maintenance_mod:[1,2],enterpris:[1,2],enterprise_admin:2,entir:2,entiti:[1,2,15,41],entitl:1,entity_id:2,entity_metadata:41,entity_typ:2,entri:[2,26],environ:2,ephemer:2,epoch:2,equal:2,equival:2,ereq_id:2,err:2,error:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,35,36,37,38,39,40],error_cod:2,error_code_authentication_failur:2,error_code_bad_fingerprint:2,error_code_generic_error:2,error_code_not_run_on_mast:2,error_code_permission_error:2,error_code_server_unreach:2,error_code_timeout:2,error_data:2,error_detail:2,error_id:[1,2],error_log_level:2,error_log_level_alert:2,error_log_level_crit:2,error_log_level_debug:2,error_log_level_emerg:2,error_log_level_error:2,error_log_level_info:2,error_log_level_warn:2,error_messag:2,error_resolver_metadata_list:1,error_responses_from_nova_serv:2,error_summari:2,error_threshold:2,error_valu:1,errorinfo:2,errormsg:2,errorresolv:1,errorresolverinfo:[1,2],errorresolverinfolist:[1,2],errorresolvermetadata:2,errorresolvermetadatalist:[1,2],errorresolversystemmetadata:2,errorresolveruserinputdata:2,errorresolverusermetadata:2,errors_cli:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,35,36,37,38,39,40],errorvalu:1,erspan:2,erspan_id:2,erspan_thre:2,erspan_two:2,escap:2,esp:2,essenti:1,establish:[1,2],established_connection_count:2,established_l2vpn_sess:2,established_sess:2,esx:[1,2],esx_mgmt_if_migration_dest:1,esxi:[1,2],etc:[1,2,6],eth_head:2,eth_typ:2,ether:[1,2],ether_typ:2,ethernet:2,ethernethead:2,ethertyp:2,ethertypensservic:2,ethtyp:2,eula_cli:[0,1,42],eulaaccept:[2,37],eulacont:[2,37],evalu:2,evalut:2,even:[1,2,23,38],event:33,ever:2,everi:[2,6],exact:2,exactli:2,exampl:[1,2],example_request:2,exapl:2,excahng:2,exce:2,exceed:2,except:2,exchang:[1,2,38],exclud:[2,9],exclude_applied_to_typ:2,exclude_list:2,exclude_rol:2,excludeappliedtotyp:2,excludelist:2,exclus:2,execut:[1,2],exhaust:2,exist:[1,2,15,21,26,32,40],exit:[1,2],exit_maintenance_mod:[1,2],expand:2,expect:2,expens:2,experi:2,expir:2,expire_tim:2,expiri:2,explain:41,explicit:[1,2],explicitli:2,explod:2,expon:2,export_typ:2,export_type_restrict:2,export_type_unrestrict:2,exporter_nam:[2,30],expos:1,express:[1,2],extend:2,extended_configur:2,extens:2,extent:2,extern:[1,2],external_id:2,external_transit_network:[1,2],extra:2,extra_config:2,extraconfig:2,extraconfighostswitchprofil:[1,2],fabric:[0,1,2,42],fabric_cli:[0,1,42],fabric_module_nam:2,fabric_module_vers:2,fabric_profile_bind:1,fabric_template_id:2,fabricmodul:2,fabricmodulelistresult:2,face:2,facil:[2,30],facilities_auth:2,facilities_authpriv:2,facilities_cron:2,facilities_daemon:2,facilities_ftp:2,facilities_kern:2,facilities_local0:2,facilities_local1:2,facilities_local2:2,facilities_local3:2,facilities_local4:2,facilities_local5:2,facilities_local6:2,facilities_local7:2,facilities_logalert:2,facilities_lpr:2,facilities_mail:2,facilities_new:2,facilities_syslog:2,facilities_us:2,facilities_uucp:2,factor:2,factori:1,fail:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,35,36,37,38,39,40],fail_count:2,fail_reason:2,failed_count:2,failed_l2vpn_sess:2,failed_nod:2,failed_reason:2,failed_sess:2,failed_to_cr:2,failed_to_r:2,failed_tunnel:2,failednodesupportbundleresult:2,faileov:2,failov:[1,2],failover_mod:[1,2],failover_mode_non_preempt:2,failover_mode_preempt:2,failover_ord:2,failur:[2,11],failure_caus:2,failure_cod:2,failure_messag:2,failure_statu:2,failure_status_connection_refus:2,failure_status_controller_rejected_host_cert:2,failure_status_host_rejected_controller_cert:2,failure_status_incomplete_controller_cert:2,failure_status_incomplete_host_cert:2,failure_status_keep_alive_timeout:2,failure_status_other_error:2,failure_status_other_ssl_error:2,failurepolici:2,fall:2,fall_count:2,fallback:2,fals:[1,2,15,23,25,37,38],famili:[2,3],familynam:3,fast:2,faster:2,fatal:2,fault_toler:2,favor:2,featur:2,feature_stack_collection_configur:2,feature_stack_nam:2,feature_usage_info:2,featureaccess:2,featureaccesslistresult:2,featureinfo:2,featurepermiss:2,featurepermissionlistresult:2,featurestackcollectionconfigur:2,featurestackcollectionconfigurationlist:2,featureusag:2,featureusagecsvrecord:2,featureusagelist:2,featureusagelistincsvformat:2,feedback:2,feedbackrequest:2,feedbackrespons:2,fetch:[1,2,18,38],fetch_ancestor:1,fetch_parentgroup_associ:2,few:2,fewer:[1,2,3,4,5,6,9,15,18,21,23,24,25,32,37,38],fialov:1,field:[1,2,3,4,5,6,9,15,18,21,23,24,25,32,37,38],field_nam:2,fieldspacketdata:2,fifteen:2,file:[2,6,26,41],file_nam:[2,26],file_store_cli:[0,1,2,42],file_system:2,filehash:2,fileloc:2,filenam:2,filepath:41,fileproperti:2,filepropertieslistresult:2,files:2,filestor:2,filesystem:2,filethumbprint:[2,26],filetransferauthenticationschem:2,filetransferprotocol:2,filter:[1,2,15,21,25,32,37],filter_in_ipprefixlist_id:2,filter_in_routemap_id:2,filter_out_ipprefixlist_id:2,filter_out_routemap_id:2,filter_typ:[2,15,32],filterrequest:2,filtertyp:[2,15,32],filtertype_post:2,filtertype_pr:2,fin:2,fin_wait2_timeout:2,find:[2,26],fine:2,fingerprint:[2,26],finish:2,fip:2,firewal:[0,1,2,42],firewall_cli:[0,1,42],firewall_ev:2,firewall_rul:15,firewall_rule_list:15,firewall_sect:2,firewall_section_lock:2,firewall_section_rule_list:2,firewall_statu:2,firewallrul:[2,15],firewallrulelist:[2,15],firewallrulelistresult:[2,15],firewallrulexxxlist:2,firewallsect:2,firewallsectionlistresult:2,firewallsectionlock:2,firewallsectionrulelist:2,firewallsectionssummari:2,firewallsectionssummarylist:[2,15],firewallsectionst:[2,15],firewallservic:2,firewallserviceassociationlistresult:2,firewallstat:[2,16],firewallstatslist:[2,16],firewallstatu:2,firewallstatuslistresult:2,first:[2,26,33,38,41],five:2,fix:2,flag:[1,2,23,25,37],flavor:2,flex:2,flexibl:2,flood:2,flow:[1,2],flow_direct:2,flow_end:2,flow_mirroring_en:2,flow_start:2,flush:2,folder:[2,41],follow:[1,2,41],foo1:2,foo2:2,foo:2,footer:2,footeract:2,forbidden:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,35,36,37,38,39,40],forc:[1,2,6,23,38],force_delet:6,force_en:2,forced_enter_maintenance_mod:1,forcibl:1,form:[1,2],form_factor:2,form_factor_larg:2,form_factor_medium:2,form_factor_medium_larg:2,form_factor_smal:2,format:[1,2,37],formfactor:2,forwad:2,forward:[1,2],forwarded_count:2,forwarder_id:[2,10],forwarders_cli:[0,1,2,42],forwarderzon:2,forwarding_plane_reset:2,forwarding_plane_reset_count:2,forwarding_up_tim:2,forwardingpath:2,forwardingt:21,found:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,35,36,37,38,39,40],foward:2,fqdn:[2,10,26],fragment:2,frame:2,frame_s:2,free:2,free_id:2,frequenc:[2,16],frequency_typ:2,fridai:2,from:[1,2,3,6,20,21,22,23,26,30,31,36,41],from_address:2,ftp:2,full:2,full_log:2,full_nam:2,full_sync:2,full_sync_cron_expr:2,fulli:[2,26],fully_realized_switch:2,functionalities_hcx:2,functionalities_ids_ip:2,functionalities_ng_fw:2,further:2,futur:[2,41],fw_rule:2,garbl:2,gate:2,gatewai:[1,2,26],gateway_address:2,gateway_ip:2,gener:[2,16,41],genericdhcpopt:2,genev:2,get:[1,2,3,4,5,6,7,8,9,10,11,13,14,15,16,17,18,19,20,21,23,24,25,26,27,28,29,30,32,33,35,36,37,38,39,40,41],get_0:[1,2,16],get_0_source_cach:[2,16],get_0_source_realtim:[2,16],get_max_retri:1,get_security_context:1,get_selection_status_al:2,get_selection_status_deselect:2,get_selection_status_select:2,get_source_cach:[2,6,7,8,9,11,13,14,15,16,18,19,20,35,36,38,39,40],get_source_realtim:[2,6,7,8,9,11,13,14,15,16,18,19,20,35,36,38,39,40],get_transport_type_overlai:2,get_transport_type_vlan:2,getal:[2,6,11],getall_attachment_type_bridgeendpoint:2,getall_attachment_type_dhcp_servic:2,getall_attachment_type_l2vpn_sess:2,getall_attachment_type_logicalrout:2,getall_attachment_type_metadata_proxi:2,getall_attachment_type_non:2,getall_attachment_type_vif:2,getall_source_cach:2,getall_source_realtim:2,getall_status_degrad:2,getall_status_down:2,getall_status_unknown:2,getall_status_up:2,getlicensebykei:1,getperlogicalrout:22,getperlogicalrouter_source_cach:22,getperlogicalrouter_source_realtim:22,getperrul:22,getperrule_source_cach:22,getperrule_source_realtim:22,give:[2,22],given:[1,2,3,9,10,15,16,18,19,21,26,32,33,36,38,39],givennam:3,gloabal:2,global:[2,26],global_api_concurrency_limit:2,global_collection_configur:2,global_statu:2,global_status_dis:2,global_status_en:2,globalcollectionconfigur:2,globalconfig:2,globalrestorestatu:2,goal:2,goe:2,gone:26,got:1,grace:[2,21],graceful_dis:2,graceful_restart:[2,21],gre:2,gre_kei:2,greater:2,green:2,grei:2,grid:2,gridconfigur:2,group14:2,group15:2,group16:2,group2:2,group5:2,group:[1,2,3,4,5,25,37],group_by_field_valu:2,group_distinguished_nam:2,group_id:[2,25,37],group_nam:2,group_statu:2,group_status_degrad:2,group_status_st:2,group_status_unavail:2,group_status_unst:2,group_typ:2,group_type_control:2,group_type_http:2,group_type_manag:2,group_type_polici:2,grouping_object:2,groupnam:2,grow:2,gss_org:2,guarante:2,guard:[1,2],guest:2,gui:2,guid:[1,2],ha1:2,ha2:2,ha_en:2,ha_flow_mirroring_en:2,ha_mac:2,ha_persistence_mirroring_en:2,ha_vip_config:2,ha_vip_subnet:2,had:2,handl:2,handshak:2,happen:2,hard:2,hardening_policy_cli:[0,1,2,42],hardwar:2,hardware_id:2,has:[1,2,6,11,21,33,38,41],has_error:[2,25,37],has_par:2,has_warn:2,hash:2,hash_cod:2,hash_typ:2,hash_type_sha1:2,haspar:2,have:[1,2,11,16,23,26,31,33,41],havipconfig:2,hbr:2,hcx:2,head:2,header:[1,2],header_nam:2,header_valu:2,health:2,health_degrad:2,health_down:2,health_unknown:2,health_up:2,healthcheck:2,healthi:2,heartbeat:[2,11],heatmaptransportnodesaggregatestatu:2,heatmaptransportzonestatu:2,held:2,hellman:2,hello:2,help:2,helper:1,henc:[2,16],here:[1,2],hexadecim:2,hidden:2,hide:2,high:[1,2],high_availability_mod:2,high_availability_mode_act:2,high_availability_mode_standbi:2,high_availability_statu:2,high_availability_status_act:2,high_availability_status_down:2,high_availability_status_standbi:2,high_availability_status_sync:2,high_availability_status_unknown:2,high_compat:2,high_secur:2,higher:2,highest:2,histor:2,histori:[2,6],hit:2,hold:2,hold_down_tim:2,hold_tim:2,hole:2,homogen:[1,2],honor:2,hop:[2,21,26],horizont:2,host:[1,2,7,11,13,26],host_address:2,host_credenti:2,host_id:2,host_infra_traffic_r:2,host_msg_client_info:2,host_nam:2,host_node_deployment_statu:2,host_node_deployment_status_edge_config_error:2,host_node_deployment_status_install_fail:2,host_node_deployment_status_install_in_progress:2,host_node_deployment_status_install_success:2,host_node_deployment_status_node_not_readi:2,host_node_deployment_status_node_readi:2,host_node_deployment_status_not_avail:2,host_node_deployment_status_not_prepar:2,host_node_deployment_status_pending_upgrad:2,host_node_deployment_status_registration_fail:2,host_node_deployment_status_registration_pend:2,host_node_deployment_status_uninstall_fail:2,host_node_deployment_status_uninstall_in_progress:2,host_node_deployment_status_uninstall_success:2,host_node_deployment_status_upgrade_fail:2,host_node_deployment_status_upgrade_in_progress:2,host_node_deployment_status_vm_deployment_fail:2,host_node_deployment_status_vm_deployment_in_progress:2,host_node_deployment_status_vm_deployment_queu:2,host_node_deployment_status_vm_deployment_restart:2,host_node_deployment_status_vm_power_off_fail:2,host_node_deployment_status_vm_power_off_in_progress:2,host_node_deployment_status_vm_power_on_fail:2,host_node_deployment_status_vm_power_on_in_progress:2,host_node_deployment_status_vm_undeploy_fail:2,host_node_deployment_status_vm_undeploy_in_progress:2,host_node_deployment_status_vm_undeploy_success:2,host_rejected_controller_cert:2,host_statu:2,host_switch:[1,2],host_switch_id:2,host_switch_mod:2,host_switch_mode_en:2,host_switch_mode_standard:2,host_switch_nam:[1,2],host_switch_profile_id:[1,2],host_switch_spec:[1,2],host_switch_st:2,host_typ:2,host_type_centoskvm:2,host_type_centosserv:2,host_type_esxi:2,host_type_rhelcontain:2,host_type_rhelkvm:2,host_type_rhelserv:2,host_type_ubuntukvm:2,host_type_ubuntuserv:2,host_vers:2,host_vm:2,hostaggregateinfo:2,hostaggregateinfolistresult:2,hostinfratraffictyp:2,hostnam:[1,2,30],hostnod:2,hostnodelogincredenti:2,hostprep:2,hostprofilenetworkmigrationspec:[1,2],hostswitch:[1,2,12],hostswitch_profile_typ:1,hostswitchprofil:1,hostswitchprofileslistresult:[1,2],hostswitchprofiletyp:[1,2],hostswitchprofiletypeidentri:2,hostswitchspec:2,hostswitchst:2,hostupgradestatu:2,hour:2,hour_of_dai:2,hover:2,how:[2,41],howev:1,hpm:2,hpm_client:[0,1,42],href:2,html:2,http:[1,2,15,26,30],http_client:[0,1,2,26,42],http_forward:2,http_redirect_to:2,http_redirect_to_http:2,http_request:2,http_request_r:2,http_request_rewrit:2,http_requst_rewrit:2,http_response_rewrit:2,http_version_1_0:2,http_version_1_1:2,http_version_2_0:2,httpprotocol:2,httpserviceproperti:2,httpsprotocol:2,hub:2,human:2,hybric:2,hybrid:2,hyperlink:2,hyperv:2,hypervisor:[1,2],hypervisor_os_typ:2,hypervisorostyp:2,hyphen:2,icmp:2,icmp_cod:2,icmp_echo_request_head:2,icmp_typ:2,icmpechorequesthead:2,icmptypensservic:2,icmpv4:2,icmpv6:2,icon:2,id_rsa:2,ident:2,identif:2,identifi:[1,2,15,25,26,30,32,37,40],idl:2,idle_timeout:2,idli:2,ids:[1,2],ids_ip:2,if_id:1,ifac:2,ifindex:2,igmp:2,igmptypensservic:2,ignor:2,igress:2,iii:2,ike:2,ike_flex:2,ike_log_level:2,ike_log_level_debug:2,ike_log_level_emerg:2,ike_log_level_error:2,ike_log_level_info:2,ike_log_level_warn:2,ike_profile_id:2,ike_session_st:2,ike_session_state_down:2,ike_session_state_negoti:2,ike_session_state_up:2,ike_statu:2,ike_traffic_statist:2,ike_v1:2,ike_v2:2,ike_vers:2,ike_version_flex:2,ike_version_v1:2,ike_version_v2:2,ikeprofil:38,imag:2,immedi:2,implement:2,implementation_typ:2,implementation_type_east_west:2,implementation_type_north_south:2,implementations_east_west:2,implementations_north_south:2,impli:2,implicitli:2,importcertif:2,importcrl:2,importcsr:2,improv:2,in_filter_ipprefixlist_id:2,in_filter_routemap_id:2,in_maintenance_mod:1,in_out:2,in_progress:2,in_servic:2,inaccur:2,inact:2,inbound:2,includ:[1,2,3,4,5,6,7,9,12,13,15,16,18,21,23,24,25,26,32,37,38,41],include_applied_to_typ:2,include_rol:2,include_system_own:1,includeappliedtotyp:2,included_field:[1,2,3,4,5,6,9,15,18,21,23,24,25,32,37,38],includedfieldsparamet:2,inclus:2,incom:2,incomplete_controller_cert:2,incomplete_host_cert:2,increas:2,increment:2,indentifi:2,independ:2,index:[1,2,16,42],indic:[1,2,25,37],indistinuish:2,individu:[1,2,16],inferfac:2,influenc:2,info:[2,9,25,37],inform:[1,2,6,7,11,12,13,15,18,21,23,25,26,30,31,32,33,37],infrastructur:2,ingress:2,ingressbroadcastrateshap:2,ingressrateshap:2,inherit:[2,21],init:2,init_st:2,init_state_vlan:2,initi:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,35,36,37,38,39,40],initial_vers:2,initiate_cluster_restore_request:2,initiateclusterrestorerequest:2,inject:2,inner:2,inprogress:2,input:[1,2,4,6],inrespons:2,insecur:2,insensit:[2,3],insert:[2,32,33],insert_aft:[2,15,32],insert_befor:[2,15,32],insert_bottom:[2,15,32],insert_top:[2,15,32],insid:[2,15,32],instac:33,instal:[1,2,4,11,26,30],install_fail:2,install_in_progress:2,install_success:2,install_upgrade_cli:[0,1,2,26,42],installed_apps_count:2,installedapp:4,installupgrad:26,installupgradeserviceproperti:2,instanc:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,35,36,37,38,39,40,41],instance_deployment_config:2,instance_deployment_templ:2,instance_endpoint:33,instance_runtim:[0,1,2,32,33,34],instance_runtime_id:35,instancedeploymentconfig:2,instanceendpoint:[2,33],instanceendpointlistresult:[2,33],instanceruntim:[2,33],instanceruntimelistresult:[2,33],instanceuuid:2,instanti:[2,41],instead:[1,2],instruct:[2,6],instruction_id:6,instructioninfo:2,instructionresourc:6,int32:2,int64:2,integ:2,integr:2,integrity_failur:2,intend:2,interfac:[1,2,7,8,12,13,14,17,26,29,35],interface_alia:2,interface_id:[2,7,8,13,14,26,29],interface_index:[2,35],interface_label:2,interface_nam:17,interface_typ:2,interface_type_data1:2,interface_type_data2:2,interface_type_ha1:2,interface_type_ha2:2,interface_type_manag:2,interface_type_phys:2,interface_type_virtu:2,interfaceneighborproperti:[2,17],interfaceneighborpropertylistresult:[2,17],interfaces_cli:[0,1,2,6,7,11,13,26,32,33,34,42],interfacestatist:2,intermedi:2,intern:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,35,36,37,38,39,40],internal_transit_network:[1,2],internalservererror:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,35,36,37,38,39,40],internet:[2,38],interv:2,intervalbackupschedul:2,invalid:[2,15],invalidrequest:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,35,36,37,38,39,40],inventori:[1,2,26],inventory_backup_status:2,inventory_summary_interv:2,inventory_sync_paus:2,inventory_sync_reenable_tim:2,inventoryconfig:2,invers:2,invert:2,invoc:2,invok:[1,2],ip_address:[1,2,26],ip_address_info:2,ip_address_typ:2,ip_address_type_ipv4:2,ip_address_type_ipv6:2,ip_assignment_spec:2,ip_block:2,ip_block_subnet:2,ip_configur:[2,26],ip_configuration_dhcp:2,ip_configuration_not_configur:2,ip_configuration_stat:2,ip_discoveri:1,ip_hash:2,ip_head:2,ip_list:2,ip_mac_list:2,ip_pool:2,ip_pool_id:2,ip_pool_stat:2,ip_pools_cli:[0,1,2,42],ip_prefix_list:[2,21],ip_protocol:2,ip_protocol_ipv4:2,ip_protocol_ipv4_ipv6:2,ip_protocol_ipv6:2,ip_protocol_tcp:2,ip_protocol_udp:2,ip_reass:2,ip_revision_filt:2,ip_revision_filter_ipv4:2,ip_revision_filter_ipv4_ipv6:2,ip_revision_filter_ipv6:2,ip_sec_vpn_local_endpoint:38,ip_sec_vpn_peer_endpoint:38,ip_sec_vpn_servic:38,ip_sec_vpn_sess:38,ip_sec_vpn_tunnel_profil:38,ip_sec_vpndpd_profil:38,ip_sec_vpnike_profil:38,ip_set:1,ip_set_id:1,ip_subnet:2,ipaddress:2,ipaddressinfo:2,ipallocationbas:2,ipassignmentspec:2,ipblock:2,ipblock_vmwar:2,ipblocklistresult:2,ipblocksubnet:2,ipblocksubnet_eng1:2,ipblocksubnet_eng2:2,ipblocksubnet_fin:2,ipblocksubnetlistresult:2,ipdiscoveryswitchingprofil:2,ipfix:[1,2],ipfix_cli:[0,1,42],ipfix_collector_config:2,ipfix_collector_profile_id:1,ipfix_collector_upm_profil:1,ipfix_config:2,ipfix_config_typ:2,ipfix_obs_point_config:2,ipfix_obs_points_cli:[0,1,42],ipfix_profile_id:1,ipfix_upm_profil:1,ipfixcollector:2,ipfixcollectorconfig:2,ipfixcollectorconfiglistresult:2,ipfixcollectorprofil:1,ipfixcollectorupmprofil:[1,2],ipfixcollectorupmprofilelistresult:[1,2],ipfixcollectorupmprofiletyp:1,ipfixconfig:2,ipfixconfiglistresult:2,ipfixconfigtyp:2,ipfixdfwconfig:2,ipfixdfwtemplateparamet:2,ipfixobspoint:1,ipfixobspointconfig:2,ipfixobspointslistresult:[1,2],ipfixprofil:1,ipfixserviceassociationlistresult:2,ipfixswitchconfig:2,ipfixswitchupmprofil:2,ipfixupmprofil:[1,2],ipfixupmprofilelistresult:[1,2],ipfixupmprofiletyp:1,ipinfo:2,ipmacpair:2,ipmirrordestin:2,ippool:[2,9],ippool_eng:2,ippoollistresult:2,ippoolrang:2,ippoolsubnet:2,ipprefix:2,ipprefixlist:[2,21],ipprefixlistlistresult:[2,21],ipproto:2,ipprotocolnsservic:2,ips:2,ipsec:[0,1,2,38,42],ipsec_cli:[0,1,2,42],ipsec_tunnel_profile_id:2,ipsec_vpn_dpd_profile_id:38,ipsec_vpn_ike_profile_id:38,ipsec_vpn_local_endpoint_id:38,ipsec_vpn_peer_endpoint_id:38,ipsec_vpn_service_id:[2,38],ipsec_vpn_sess:2,ipsec_vpn_session_id:[2,38],ipsec_vpn_tunnel_profile_id:38,ipsec_vti:2,ipsectunnelprofil:38,ipsecvpndpdprofil:[2,38],ipsecvpndpdprofilelistresult:[2,38],ipsecvpnikeprofil:[2,38],ipsecvpnikeprofilelistresult:[2,38],ipsecvpnikeservicesummari:[2,38],ipsecvpnikesessionstatu:2,ipsecvpnikesessionsummari:2,ipsecvpniketrafficstatist:2,ipsecvpnlocalendpoint:[2,38],ipsecvpnlocalendpointlistresult:[2,38],ipsecvpnpeerendpoint:[2,38],ipsecvpnpeerendpointlistresult:[2,38],ipsecvpnpolicyrul:2,ipsecvpnpolicysubnet:2,ipsecvpnpolicytrafficstatist:2,ipsecvpnservic:[2,38],ipsecvpnservicelistresult:[2,38],ipsecvpnsess:[2,38],ipsecvpnsessionlistresult:[2,38],ipsecvpnsessionstatist:[2,39],ipsecvpnsessionstatu:[2,39],ipsecvpnsessionsummari:[2,39],ipsecvpnsessiontrafficsummari:2,ipsecvpntrafficcount:2,ipsecvpntransportstatu:2,ipsecvpntunnelprofil:[2,38],ipsecvpntunnelprofilelistresult:[2,38],ipsecvpntunneltrafficstatist:2,ipset:[1,2],ipsetlistresult:[1,2],ipsubnet:2,ipv4:[1,2,21],ipv4_dhcp_serv:2,ipv4_ipv6:2,ipv4_unicast:2,ipv4addressproperti:2,ipv4dhcpserv:2,ipv4head:2,ipv6:[1,2],is_advertis:2,is_arp_proxy_en:2,is_befor:2,is_ca:2,is_data_collection_en:2,is_default:2,is_drilldown:2,is_ev:2,is_expir:2,is_fip:2,is_loopback_en:2,is_mh:2,is_protect:2,is_sav:2,is_secur:2,is_valid:2,iscsi:2,isn:[1,2],issu:[2,26],issuer:2,issuer_cn:2,issuer_dn:2,item:2,its:[1,2,6,15],itself:[2,6],januari:2,job:2,join:[1,2],join_condit:2,join_to_existing_clust:2,json:[1,2,41],just:2,keep:[1,2],keep_alive_interv:2,keep_alive_tim:2,keep_alive_timeout:2,kei:[1,2,3,26,38],kept:2,kern:[2,30],kernel:[1,2],kernel_vers:[1,2],key_algo:2,key_extraconfighostswitchprofil:2,key_hostprofilenetworkmigrationspec:2,key_ipdiscoveryswitchingprofil:2,key_lldphostswitchprofil:2,key_macmanagementswitchingprofil:2,key_niocprofil:2,key_portmirroringswitchingprofil:2,key_qosswitchingprofil:2,key_siz:2,key_spoofguardswitchingprofil:2,key_switchsecurityswitchingprofil:2,key_uplinkhostswitchprofil:2,keygen:2,keyvalu:2,keyvaluepair:2,keyword:1,kill:2,kilobyt:2,kind:2,know:2,known:[2,26],known_host_paramet:26,knownhostparamet:[2,26],kvm:[1,2],l2_bridg:2,l2_vpn_servic:38,l2_vpn_session:38,l2dfw:[2,15],l2vpn:[0,1,2,38,42],l2vpn_client:[0,1,2,42],l2vpn_service_id:[2,38],l2vpn_session:[1,2],l2vpn_session_id:[38,40],l2vpnattachmentcontext:2,l2vpnperlstrafficstatist:2,l2vpnservic:[2,38],l2vpnservicelistresult:[2,38],l2vpnsession:[2,38],l2vpnsessionlistresult:[2,38],l2vpnsessionpeercod:[2,40],l2vpnsessionremotemac:[2,40],l2vpnsessionremotemacsforl:2,l2vpnsessionstatist:[2,40],l2vpnsessionstatu:[2,40],l2vpnsessionsummari:[2,40],l2vpntaptrafficstatist:2,l2vpntransporttunnelstatu:2,l2vpntunnelencapsul:2,l2vpntunnelpeercod:2,l3_rout:2,l3bridgeport:2,l3dfw:[2,15],l3edg:2,l3portmirrorsess:2,l3redirect:2,l4_current_sess:2,l4_current_session_r:2,l4_max_sess:2,l4_protocol:2,l4_total_sess:2,l4port:2,l4portset:2,l4portsetnsservic:2,l4protocol_tcp:2,l4protocol_udp:2,l7_current_sess:2,l7_current_session_r:2,l7_max_sess:2,l7_total_sess:2,label:2,labelvalueconfigur:2,lacp:[1,2],lag:2,lan:2,larg:2,larger:2,largest:2,last:[1,2],last_check_tim:2,last_compute_tim:2,last_full_sync_timestamp:2,last_heartbeat_timestamp:2,last_modified_tim:2,last_modified_us:2,last_state_change_tim:2,last_sync_tim:2,last_update_timestamp:2,last_updated_tim:2,latenc:2,later:2,latest:2,layer2:2,layer3:2,layer:2,lb_admin:2,lb_app_profil:2,lb_auditor:2,lb_client_ssl_profil:2,lb_monitor:2,lb_persistence_profil:2,lb_pool:2,lb_rule:2,lb_server_ssl_profil:2,lb_servic:2,lb_tcp_profil:2,lb_virtual_serv:2,lb_virtual_server_with_rul:2,lbactivemonitor:2,lbappprofil:2,lbappprofilelistresult:2,lbclientcertificateissuerdncondit:2,lbclientcertificatesubjectdncondit:2,lbclientsslprofil:2,lbclientsslprofilelistresult:2,lbcookiepersistenceprofil:2,lbcookietim:2,lbfasttcpprofil:2,lbfastudpprofil:2,lbhttpmonitor:2,lbhttpprofil:2,lbhttpredirectact:2,lbhttprejectact:2,lbhttprequestbodycondit:2,lbhttprequestcookiecondit:2,lbhttprequesthead:2,lbhttprequestheadercondit:2,lbhttprequestheaderdeleteact:2,lbhttprequestheaderrewriteact:2,lbhttprequestmethodcondit:2,lbhttprequesturiargumentscondit:2,lbhttprequesturicondit:2,lbhttprequesturirewriteact:2,lbhttprequestversioncondit:2,lbhttpresponseheadercondit:2,lbhttpresponseheaderdeleteact:2,lbhttpresponseheaderrewriteact:2,lbhttpsmonitor:2,lbhttpsslcondit:2,lbicmpmonitor:2,lbipheadercondit:2,lbmonitor:2,lbmonitorlistresult:2,lbpassivemonitor:2,lbpersistencecookietim:2,lbpersistenceprofil:2,lbpersistenceprofilelistresult:2,lbpool:2,lbpoollistresult:2,lbpoolmemberstatist:2,lbpoolmemberstatu:2,lbpoolstatist:[2,19],lbpoolstatisticslistresult:[2,19],lbpoolstatu:[2,19],lbpoolstatuslistresult:[2,19],lbrule:2,lbruleact:2,lbrulecondit:2,lbrulelistresult:2,lbselectpoolact:2,lbselectserveract:2,lbserversslprofil:2,lbserversslprofilelistresult:2,lbservic:2,lbservicedebuginfo:[2,18],lbservicelistresult:2,lbservicestatist:[2,18],lbservicestatisticscount:2,lbservicestatu:[2,18],lbserviceusag:[2,18],lbsessioncookietim:2,lbsnatautomap:2,lbsnatipel:2,lbsnatippool:2,lbsnattransl:2,lbsourceippersistenceprofil:2,lbsslcipherandprotocollistresult:[2,18],lbsslcipherinfo:2,lbsslprofil:2,lbsslprofilelistresult:2,lbsslprotocolinfo:2,lbstatisticscount:2,lbtcpheadercondit:2,lbtcpmonitor:2,lbtcpprofil:2,lbtcpprofilelistresult:2,lbudpmonitor:2,lbvariableassignmentact:2,lbvariablecondit:2,lbvirtualserv:2,lbvirtualserverlistresult:2,lbvirtualserverstatist:[2,19],lbvirtualserverstatisticslistresult:[2,19],lbvirtualserverstatu:[2,19],lbvirtualserverstatuslistresult:[2,19],lbvirtualserverwithrul:2,lcore:2,lcp:[2,11],lcp_connectivity_statu:2,lcp_connectivity_status_degrad:2,lcp_connectivity_status_detail:2,lcp_connectivity_status_down:2,lcp_connectivity_status_unknown:2,lcp_connectivity_status_up:2,ldap:2,lead:[2,26],leader:2,leader_uuid:2,leadership:2,learn:[2,21,26],leas:[2,9],lease_tim:2,lease_vers:2,least:[1,2],least_connect:2,leav:2,length:2,less:2,level:[2,21,26,30],level_alert:2,level_crit:2,level_debug:2,level_emerg:2,level_err:2,level_info:2,level_notic:2,level_warn:2,liagent:[26,30],liagent_cli:[0,1,2,26,42],licens:[1,2,37],license_kei:[1,2],licenses_cli:[0,1,42],licenseslistresult:[1,2],licensesusag:2,life:2,lifecycl:2,lifecyl:2,lifetim:2,like:[1,2,15,16,32,38],limit:[2,15,32],limit_polici:2,limit_policy_allow:2,limit_policy_drop:2,line:[2,37],link:[1,2,7,13,26],link_aggregation_cap:2,link_aggregation_port_id:2,link_aggregation_statu:2,link_id:2,link_statu:2,link_status_down:2,link_status_up:2,linked_logical_router_port_id:2,linked_logical_switch_port_id:2,linux:2,list:[1,2,3,4,5,6,7,9,11,12,13,15,17,18,19,21,23,24,25,26,30,31,32,33,37,38,39],list_applied_to_entity_type_logicalport:1,list_applied_to_entity_type_logicalswitch:1,list_applied_to_entity_type_nsgroup:1,list_associated_resource_type_nsgroup:1,list_attachment_type_bridgeendpoint:1,list_attachment_type_dhcp_servic:1,list_attachment_type_l2vpn_sess:1,list_attachment_type_logicalrout:1,list_attachment_type_metadata_proxi:1,list_attachment_type_non:1,list_attachment_type_vif:1,list_bfd_diagnostic_code_0:2,list_bfd_diagnostic_code_1:2,list_bfd_diagnostic_code_2:2,list_bfd_diagnostic_code_3:2,list_bfd_diagnostic_code_4:2,list_bfd_diagnostic_code_5:2,list_bfd_diagnostic_code_6:2,list_bfd_diagnostic_code_7:2,list_bfd_diagnostic_code_8:2,list_bfd_diagnostic_code_administratively_down:2,list_bfd_diagnostic_code_concatenated_path_down:2,list_bfd_diagnostic_code_control_detection_time_expir:2,list_bfd_diagnostic_code_echo_function_fail:2,list_bfd_diagnostic_code_forwarding_plane_reset:2,list_bfd_diagnostic_code_neighbor_signaled_session_down:2,list_bfd_diagnostic_code_no_diagnost:2,list_bfd_diagnostic_code_path_down:2,list_bfd_diagnostic_code_reverse_concatenated_path_down:2,list_component_type_bridg:2,list_component_type_dfw:2,list_component_type_edge_hostswitch:2,list_component_type_edge_tunnel:2,list_component_type_l:2,list_component_type_lr:2,list_component_type_phys:2,list_component_type_unknown:2,list_enforced_on_bridgeendpoint:2,list_enforced_on_dhcp_servic:2,list_enforced_on_l2vpn_sess:2,list_enforced_on_logicalrout:2,list_enforced_on_metadata_proxi:2,list_enforced_on_non:2,list_enforced_on_vif:2,list_exclude_applied_to_type_logicalport:2,list_exclude_applied_to_type_logicalrout:2,list_exclude_applied_to_type_logicalswitch:2,list_exclude_applied_to_type_nsgroup:2,list_filter_type_filt:[2,15,32],list_filter_type_search:[2,15,32],list_has_parent_fals:2,list_has_parent_tru:2,list_hostswitch_profile_type_extraconfighostswitchprofil:1,list_hostswitch_profile_type_lldphostswitchprofil:1,list_hostswitch_profile_type_niocprofil:1,list_hostswitch_profile_type_uplinkhostswitchprofil:1,list_hypervisor_os_type_centoskvm:2,list_hypervisor_os_type_centosserv:2,list_hypervisor_os_type_esxi:2,list_hypervisor_os_type_hyperv:2,list_hypervisor_os_type_rhelcontain:2,list_hypervisor_os_type_rhelkvm:2,list_hypervisor_os_type_rhelserv:2,list_hypervisor_os_type_ubuntukvm:2,list_hypervisor_os_type_ubuntuserv:2,list_include_applied_to_type_logicalport:2,list_include_applied_to_type_logicalrout:2,list_include_applied_to_type_logicalswitch:2,list_include_applied_to_type_nsgroup:2,list_ipfix_config_type_ipfixdfwconfig:2,list_ipfix_config_type_ipfixswitchconfig:2,list_mm_state_dis:2,list_mm_state_en:2,list_mm_state_ent:2,list_mm_state_exit:2,list_preferred_normalization_type_directorygroup:1,list_preferred_normalization_type_ipset:1,list_preferred_normalization_type_logicalport:1,list_preferred_normalization_type_logicalswitch:1,list_preferred_normalization_type_macset:1,list_preferred_normalization_type_nsgroup:1,list_resource_type_bridgehighavailabilityclusterprofil:1,list_resource_type_directorygroup:1,list_resource_type_edgehighavailabilityprofil:1,list_resource_type_edgenod:2,list_resource_type_hostnod:2,list_resource_type_ipset:1,list_resource_type_logicalport:1,list_resource_type_logicalroutercentralizedserviceport:1,list_resource_type_logicalrouterdownlinkport:1,list_resource_type_logicalrouteriptunnelport:1,list_resource_type_logicalrouterlinkportontier0:1,list_resource_type_logicalrouterlinkportontier1:1,list_resource_type_logicalrouterloopbackport:1,list_resource_type_logicalrouteruplinkport:1,list_resource_type_logicalswitch:1,list_resource_type_macset:1,list_resource_type_nsgroup:1,list_resource_type_publiccloudgatewaynod:2,list_resource_type_traceflowobservationdeliv:2,list_resource_type_traceflowobservationdrop:2,list_resource_type_traceflowobservationdroppedlog:2,list_resource_type_traceflowobservationforward:2,list_resource_type_traceflowobservationforwardedlog:2,list_resource_type_traceflowobservationreceiv:2,list_resource_type_traceflowobservationreceivedlog:2,list_resource_type_virtualmachin:1,list_route_source_bgp:21,list_route_source_connect:21,list_route_source_stat:21,list_router_type_tier0:1,list_router_type_tier1:1,list_selection_status_al:[25,37],list_selection_status_deselect:[25,37],list_selection_status_select:[25,37],list_service_type_firewal:2,list_service_type_ipfix:2,list_session_type_policybasedipsecvpnsess:38,list_session_type_routebasedipsecvpnsess:38,list_source_cach:[2,7,13,19,21,24],list_source_realtim:[2,7,13,19,21,24],list_status_degrad:2,list_status_down:2,list_status_fail:2,list_status_finish:2,list_status_in_progress:2,list_status_orphan:2,list_status_partial_success:2,list_status_pend:2,list_status_run:2,list_status_start:2,list_status_success:2,list_status_unknown:2,list_status_up:2,list_transport_type_overlai:1,list_transport_type_vlan:1,list_tunnel_status_down:2,list_tunnel_status_up:2,list_type_certif:2,list_type_hostprofilenetworkmigrationspec:1,list_type_l3redirect:2,list_type_layer2:2,list_type_layer3:2,list_type_lbactivemonitor:2,list_type_lbcookiepersistenceprofil:2,list_type_lbfasttcpprofil:2,list_type_lbfastudpprofil:2,list_type_lbhttpmonitor:2,list_type_lbhttpprofil:2,list_type_lbhttpsmonitor:2,list_type_lbicmpmonitor:2,list_type_lbpassivemonitor:2,list_type_lbsourceippersistenceprofil:2,list_type_lbtcpmonitor:2,list_type_lbudpmonitor:2,list_type_local_us:2,list_type_principal_ident:2,list_type_remote_group:2,list_type_remote_us:2,listen:2,listener_ip:2,listresult:2,listresultqueryparamet:2,listwithrul:2,live:2,lldp:[0,1,2,42],lldphostswitchprofil:[1,2],load:[1,2,18,19,40],load_averag:2,load_balance_algorithm:2,load_balance_algorithm_destmac:2,load_balance_algorithm_srcdestipvlan:2,load_balance_algorithm_srcdestmac:2,load_balance_algorithm_srcdestmacipport:2,load_balance_algorithm_srcmac:2,loadbal:2,loadbalanc:[0,1,2,42],loadbalance_srcid:2,loadbalancer_cli:[0,1,42],loadbalancerallocationpool:2,local0:2,local1:2,local2:2,local3:2,local4:2,local5:2,local6:2,local7:2,local:[1,2,26,38],local_address:2,local_endpoint_id:2,local_endpoint_ip:2,local_id:2,local_id_on_host:2,local_ip:2,local_ip_address:2,local_port:2,local_subnet:2,local_us:2,localendpoint:38,localportmirrorsess:2,locat:2,lock:2,lock_modified_bi:2,lock_modified_tim:2,lockout:2,log:[2,26,30],log_age_limit:2,log_filt:2,log_filter_typ:2,log_filter_type_regex:2,log_filter_type_text:2,log_level:2,log_level_debug:2,log_level_error:2,log_level_fat:2,log_level_info:2,log_level_warn:2,log_nam:2,log_siz:2,logalert:2,logging_level:2,logging_level_debug:2,logging_level_error:2,logging_level_info:2,logging_level_trac:2,logging_level_warn:2,logic:[1,2,20,21,22,23,35,36,38,40],logical_count:2,logical_dhcp_serv:2,logical_port:[1,2],logical_port_id:2,logical_ports_cli:[0,1,42],logical_rout:[0,1,2,42],logical_router_id:[1,2,21,22,23,24,38],logical_router_nam:2,logical_router_port:[0,1,2,42],logical_router_port_id:[1,2,20],logical_router_ports_cli:[0,1,42],logical_routers_cli:[0,1,42],logical_servic:1,logical_switch:[1,2],logical_switch_id:[1,2,40],logical_switches_cli:[0,1,42],logical_tap_ip_pool:2,logicaldhcpserv:2,logicaldhcpserverlistresult:2,logicallocalportmirrorsess:2,logicalport:[1,2],logicalportattach:2,logicalportlistresult:[1,2],logicalportmacaddresscsvlistresult:2,logicalportmacaddresslistresult:2,logicalportmactablecsventri:2,logicalportmactableentri:2,logicalportmirrordestin:2,logicalportmirrorsess:2,logicalportmirrorsourc:2,logicalportoperationalstatu:2,logicalportst:2,logicalportstatist:2,logicalportstatussummari:2,logicalrout:[1,2,21],logicalroutercentralizedserviceport:[1,2],logicalrouterconfig:2,logicalrouterdownlinkport:[1,2],logicalrouteriptunnelport:[1,2],logicalrouterlinkport:1,logicalrouterlinkportontier0:[1,2],logicalrouterlinkportontier1:[1,2],logicalrouterlistresult:[1,2],logicalrouterloopbackport:[1,2],logicalrouterport:[1,2],logicalrouterportarpcsvrecord:2,logicalrouterportarpentri:2,logicalrouterportarpt:2,logicalrouterportarptableincsvformat:2,logicalrouterportcount:2,logicalrouterportlistresult:[1,2],logicalrouterportstatist:2,logicalrouterportstatisticspernod:2,logicalrouterportstatisticssummari:[2,20],logicalrouterroutecsvrecord:2,logicalrouterrouteentri:2,logicalrouterroutet:[2,21],logicalrouterroutetableincsvformat:2,logicalrouterstatu:2,logicalrouterstatuspernod:2,logicalrouteruplinkport:[1,2],logicalservic:[1,2],logicalservicelistresult:[1,2],logicalswitch:[1,2],logicalswitchlistresult:[1,2],logicalswitchmirrorsourc:2,logicalswitchprofil:2,logicalswitchst:2,logicalswitchstatelistresult:2,logicalswitchstatist:2,logicalswitchstatu:2,logicalswitchstatuslistresult:2,logicalswitchstatussummari:2,login:2,logincredenti:2,loginsight:2,longer:2,longest:2,look:[2,26],lookup:[2,10],loopback:[2,26],loss:2,lost:2,low:2,lower:[2,16],lowercas:2,lowest:2,lport:[1,2],lport_attachment_id:2,lport_bind:2,lport_id:[1,2],lport_nam:2,lpr:2,lr_component_id:2,lr_component_typ:2,lr_tier0:2,lr_tier1:2,lr_vrf_tier0:2,lrouter:2,ls_transit:2,lservic:2,lswitch:[1,2],lswitch_bind:2,lswitch_id:[1,2],m_ac_address_el:2,m_ac_set:1,mac:[1,2,7,9,12,13,26,40],mac_address:[1,2],mac_change_allow:2,mac_learn:2,mac_learning_limit_policy_allow:2,mac_learning_limit_policy_drop:2,mac_not_learned_packets_allow:2,mac_not_learned_packets_drop:2,mac_pool_id:2,mac_set_id:[1,2],mac_sets_cli:[0,1,42],mac_typ:2,mac_type_learn:2,mac_type_stat:2,macaddresscsvlistresult:2,macaddressel:2,macaddresselementlistresult:2,macaddresslistresult:2,machin:[1,2],maclearningcount:2,maclearningspec:2,macmanagementswitchingprofil:2,macpool:2,macpoollistresult:2,macrang:2,macs_learn:2,macset:[1,2],macsetlistresult:[1,2],mactabl:2,mactablecsvrecord:2,mactableentri:2,made:2,mai:[1,2,3,4,5,6,9,15,16,18,21,23,24,25,32,37,38,41],mail:[2,30],mainli:2,maintain:2,mainten:[1,2],maintenance_mod:2,maintenance_mode_dis:2,maintenance_mode_en:2,maintenance_mode_ent:2,maintenance_mode_exit:2,maintenance_mode_force_en:2,maintenance_mode_off:2,maintenance_mode_on:2,maintenance_mode_st:2,maintenance_mode_state_dis:2,maintenance_mode_state_en:2,maintenance_mode_state_ent:2,maintenance_mode_state_exit:2,major:2,make:[1,2,33],man:2,manag:[1,2,6,11,26,30],managed_by_serv:2,managedresourc:2,management_clust:2,management_config:2,management_network_id:2,management_plan:2,management_plane_platform:2,management_port_subnet:2,managementclusternodestatu:2,managementclusterroleconfig:2,managementclusterstatu:2,managementconfig:2,managementnodeaggregateinfo:2,managementplanebasenodeinfo:2,manager_cli:[0,1,2,26,42],manager_rol:2,manager_upload_onli:2,mandatori:[2,26],mandatory_access_control_properti:26,mandatoryaccesscontrol:26,mandatoryaccesscontrolproperti:[2,26],mani:2,manipul:2,manual:[1,2],manufactur:2,map:2,mark:2,market_plac:2,mask:[2,7,13,26],master:2,match:[1,2,3,26],match_al:2,match_ani:2,match_community_express:2,match_condit:2,match_criteria:2,match_destination_network:2,match_exact:2,match_non:2,match_oper:2,match_operator_al:2,match_operator_ani:2,match_operator_exact:2,match_operator_non:2,match_operator_regex:2,match_regex:2,match_route_typ:2,match_route_types_ani:2,match_route_types_nsx_connect:2,match_route_types_stat:2,match_route_types_t1_lb_snat:2,match_route_types_t1_lb_vip:2,match_route_types_t1_nat:2,match_servic:2,match_source_network:2,match_strageti:2,match_strategi:2,match_strategy_al:2,match_strategy_ani:2,match_typ:2,match_type_contain:2,match_type_ends_with:2,match_type_equ:2,match_type_regex:2,match_type_starts_with:2,max:[1,2,16],max_concurrent_connect:2,max_fail:2,max_flow:2,max_ip_list_s:2,max_new_connection_r:2,max_popularity_index:2,max_sess:2,max_session_count:2,max_syn_retransmiss:2,maximum:[1,2,3,4,5,6,9,15,16,18,21,23,24,25,32,37,38],maximum_hop_limit:2,maxitem:2,md_proxi:2,md_proxies_cli:[0,1,42],mdproxi:1,mean:[1,2,26],meaning:2,measur:2,mechan:2,med:2,medium:2,medium_larg:2,meet:2,mem_cach:2,mem_resid:2,mem_tot:2,mem_us:2,member:[1,2,5,6],member_app:2,member_count:2,member_group:2,member_group_distinguished_nam:2,member_group_id:2,member_index:[1,2],member_nam:2,member_node_typ:2,member_node_type_edge_nod:2,member_node_type_public_cloud_gateway_nod:2,member_node_type_unknown:2,member_statu:2,member_status_down:2,member_status_unknown:2,member_status_up:2,member_typ:1,member_uuid:2,membership:2,membership_criteria:2,membertyp:2,memori:2,memory_usag:2,mention:2,messag:[1,2,7,26,30],message_typ:2,message_type_queri:2,message_type_respons:2,messages_receiv:2,messages_s:2,messasg:2,met:2,metadata:[1,2,25,37,41],metadata_cli:41,metadata_proxi:[1,2],metadata_proxy_id:2,metadata_server_ca_id:2,metadata_server_url:2,metadataproxi:[1,2],metadataproxylistresult:[1,2],metadataproxystatist:2,metadataproxystatisticsperlogicalswitch:2,metadataproxystatu:2,metal:2,metatada:2,metatdata:2,metedata:2,meter:2,method:[1,2,6,7,8,9,11,13,14,15,16,18,19,20,21,22,23,24,25,26,32,35,36,37,38,39,40,41],method_delet:2,method_get:2,method_head:2,method_opt:2,method_patch:2,method_post:2,method_put:2,methodolog:2,metric:[2,26],mgmt:2,mgmt_addr:2,mgmt_cluster:2,mgmt_cluster_changes_allow:2,mgmt_cluster_listen_addr:2,mgmt_cluster_listen_ip_address:2,mgmt_cluster_statu:2,mgmt_cluster_status_connect:2,mgmt_cluster_status_disconnect:2,mgmt_cluster_status_unknown:2,mgmt_connection_statu:2,mgmt_connection_status_down:2,mgmt_connection_status_up:2,mgmt_plane:2,mgmt_plane_bus_cli:[0,1,2,26,42],mgmt_plane_listen_addr:2,mgmtconnstatu:2,mgmtplanebu:26,mgr:1,mgr_role_config:2,microsecond:2,middl:2,midnight:2,might:[1,2],migrat:[0,1,2,42],migration_bundle_fetch_request:2,migration_bundle_file_nam:2,migration_cli:[0,1,42],migration_coordinator_vers:2,migration_feedback_response_list:2,migration_plan_set:25,migration_setup_info:2,migration_statu:2,migration_status_fail:2,migration_status_in_progress:2,migration_status_not_start:2,migration_status_paus:2,migration_status_success:2,migration_unit:2,migration_unit_count:2,migration_unit_group:2,migration_unit_groups_cli:[0,1,2,42],migration_unit_id:[2,25],migration_unit_list:2,migration_unit_typ:2,migration_units_cli:[0,1,2,42],migrationbundlefetchrequest:2,migrationbundleid:2,migrationbundleinfo:2,migrationbundleuploadstatu:[2,25],migrationfeedbackrequest:2,migrationfeedbackrequestlistresult:2,migrationfeedbackrespons:2,migrationfeedbackresponselist:2,migrationplanset:[2,25],migrationsetupinfo:2,migrationstatu:2,migrationsummari:2,migrationunit:[2,25],migrationunitaggregateinfo:2,migrationunitaggregateinfolistresult:[2,25],migrationunitgroup:2,migrationunitgroupaggregateinfo:2,migrationunitgroupaggregateinfolistresult:[2,25],migrationunitgrouplistresult:2,migrationunitgroupsstatu:2,migrationunitgroupstatu:2,migrationunitgroupstatuslistresult:2,migrationunitlist:2,migrationunitlistresult:2,migrationunitsstat:2,migrationunitstatu:2,migrationunitstatuslistresult:[2,25],migrationunittypestat:2,migrationunittypestatslist:2,mili:2,millisec:2,millisecond:2,min_active_memb:2,minimum:2,minimum_password_length:2,minium:2,minor:2,minut:[2,16],minute_of_dai:2,mirror:[1,2],mirror_destin:2,mirror_session_id:1,mirror_sourc:2,mirrordestin:2,mirrorsess:1,mirrorsourc:2,misc:2,mismatch:2,miss:[1,2],mix:[1,2],mm_state:2,mmstate:2,mode:[1,2,38,39],mode_act:2,mode_change_onli:2,mode_id:2,mode_id_on_prem:2,mode_id_servic:2,mode_id_vmc:2,mode_id_vmc_loc:2,mode_pass:2,mode_trust:2,mode_untrust:2,model:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,35,36,37,38,39,40],model_cli:[0,1,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,35,36,37,38,39,40,42],modif:2,modifi:[1,2,15,21,23,26,32],modified_epoch_m:2,modified_feature_stack_collection_configur:2,modul:[0,34,41,42],module_nam:2,module_vers:2,modulu:2,moidonhost:2,mondai:2,monitor:[2,18],monitor_id:2,monitor_pid:2,monitor_port:2,monitor_runtime_st:2,monitor_runtime_state_run:2,monitor_runtime_state_stop:2,month:2,monthli:2,monthlytelemetryschedul:2,more:[1,2,26],moref:2,most:2,mostli:2,motd:1,mount:2,move:[1,2],mpa:2,mpa_connectivity_statu:2,mpa_connectivity_status_detail:2,mpa_connectivity_status_down:2,mpa_connectivity_status_unknown:2,mpa_connectivity_status_up:2,mpa_msg_client_info:2,mrt:2,ms_rpc_tcp:2,ms_rpc_udp:2,msgclientinfo:2,msgid:[2,30],mtep:[1,2],mtu:[1,2,7,13,26],much:2,mulitpl:2,multi:2,multi_exit_discrimin:2,multicast:2,multicast_broadcast:2,multipl:[1,2,15,32],multiplex:2,multiwidgetconfigur:2,must:[1,2,23,26,32,38],mutual:[2,9],myhybridteamingpolici:2,nack:2,nagl:2,nagle_algorithm_en:2,name:[1,2,3,12,17,26,30,41],name_dstip:2,name_dstmac:2,name_dstport:2,name_ethtyp:2,name_http:2,name_ip:2,name_ipproto:2,name_mac:2,name_port:2,name_scp:2,name_serv:2,name_sftp:2,name_srcip:2,name_srcmac:2,name_srcport:2,name_vlan:2,name_vni:2,named_team:2,namedteamingpolici:2,nameserv:[10,26],nat:[0,1,2,21,42],nat_client:[0,1,2,42],nat_pass:2,nat_rul:21,natcount:2,natrul:[2,21,36],natrulelistresult:[2,21],natstatisticsperlogicalrout:[2,22],natstatisticsperrul:[2,22],natstatisticspertransportnod:[2,36],natur:2,navig:2,nbdg_broadcast:2,nbns_broadcast:2,necessari:2,need:[1,2,38],needs_attent:2,neg:2,negat:2,negoti:[2,38],negotiated_cap:2,negotiated_tunnel:2,neigh:2,neighbor:[2,17,23],neighbor_address:2,neighbor_router_id:2,neighbor_signaled_session_down:2,neighbor_signaled_session_down_count:2,neighborproperti:2,neighbors_cli:[0,1,2,21,23],neighbors_list:2,neighborship:2,neighbour:2,neighour:2,nest:[1,2],nested_nsx:2,netmask:[2,26],network:[0,1,2,6,7,11,12,13,21,23,26,42],network_cli:[0,1,2,6,11,42],network_engin:2,network_id:2,network_interfac:2,network_map:2,network_migration_spec:1,network_migration_spec_id:2,network_op:2,network_prefix:21,networkmigrationspec:[1,2],networkmigrationspeclistresult:[1,2],networkmigrationspectypeidentri:2,never:2,newer:[33,41],newli:2,next:[1,2,3,4,5,6,9,15,18,21,23,24,25,32,37,38],next_hop:2,next_upd:2,ng_fw:2,nic:[1,2],nic_info:2,nic_metadata:2,nic_metadata_list:2,nicinfo:2,nicmetadata:2,nioc:2,niocprofil:[1,2],no_authent:2,no_back:2,no_backup:2,no_diagnost:2,no_diagnostic_count:2,no_dnat:2,no_encrypt:2,no_encryption_auth_aes_gmac_128:2,no_encryption_auth_aes_gmac_192:2,no_encryption_auth_aes_gmac_256:2,no_nat:2,no_of_vm:2,no_purg:2,no_rout:2,no_snat:2,no_standbi:2,node:[0,1,2,6,11,12,16,17,20,22,24,36,42],node_auth_provider_vidm_properti:27,node_backup_status:2,node_cli:[0,1,42],node_count:2,node_display_nam:2,node_ext_id:2,node_host_nam:2,node_http_service_properti:26,node_id:[1,2,6,7,8,11,13,14,17,36],node_install_upgrade_service_properti:26,node_interface_properti:2,node_interface_statist:2,node_ip:1,node_mgmt_cli:[0,1,2,26,42],node_name_servers_properti:26,node_network_interface_properti:26,node_not_readi:2,node_ntp_service_properti:26,node_properti:1,node_proton_service_properti:26,node_readi:[2,11],node_route_properti:26,node_search_domains_properti:26,node_snmp_service_properti:26,node_ssh_service_properti:26,node_statu:2,node_status_properti:2,node_syslog_exporter_properti:30,node_typ:[1,2],node_user_properti:2,node_user_set:2,node_uuid:2,node_vers:[1,2],node_with_issues_count:2,nodeaggregateinfo:2,nodeaggregateinfolistresult:2,nodeauthprovidervidmproperti:[2,27],nodeauthprovidervidmstatu:[2,28],nodecap:2,nodecapabilitiesresult:[2,11],nodefilesystemproperti:2,nodehttpserviceproperti:[2,26],nodeid:2,nodeidservicesmap:2,nodeinfo:2,nodeinfolistresult:2,nodeinstallupgradeserviceproperti:[2,26],nodeinterfacealia:2,nodeinterfaceproperti:[2,7,13],nodeinterfacepropertieslistresult:[2,7,13],nodeinterfacestatisticsproperti:[2,8,14,29],nodelistresult:2,nodelogproperti:2,nodelogpropertieslistresult:2,nodemgmt:26,nodemod:2,nodenameserversproperti:[2,26],nodenetworkinterfaceproperti:[2,26],nodenetworkinterfacepropertieslistresult:[2,26],nodenetworkproperti:2,nodentpserviceproperti:[2,26],nodeprocessproperti:2,nodeprocesspropertieslistresult:2,nodeproperti:[1,2],nodeprotonserviceproperti:[2,26],noderouteproperti:[2,26],noderoutepropertieslistresult:[2,26],nodes_cli:[0,1,2,42],nodesearchdomainsproperti:[2,26],nodeserviceproperti:[2,26],nodeservicepropertieslistresult:2,nodeservicestatusproperti:[2,26,30],nodesnmpserviceproperti:[2,26],nodesshserviceproperti:[2,26],nodessummari:2,nodestatu:[2,11],nodestatuslistresult:[2,11],nodestatusproperti:2,nodesummari:2,nodesummarylist:2,nodesyslogexporterproperti:[2,30],nodesyslogexporterpropertieslistresult:[2,30],nodeuserproperti:2,nodeuserpropertieslistresult:2,nodeuserset:2,nodevers:2,nomatching_policy_error:2,non:[1,2,3,38],non_authoritative_answ:2,non_eth:2,non_preempt:2,none:[1,2,3,4,5,6,7,8,9,10,11,13,14,15,16,18,19,20,21,22,23,24,25,32,35,36,37,38,39,40],noout:2,nor:2,normal:[1,2],normalbgpcommun:2,normalizedresourcelistresult:[1,2],north:2,north_south:2,not_aft:2,not_avail:2,not_befor:2,not_prepar:2,not_protect:2,not_requir:2,not_start:2,notat:2,note:[1,2,6,11,21,26],notfound:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,35,36,37,38,39,40],notic:2,notif:2,nova:2,now:2,ns_group:[1,2],ns_group_expression_list:1,ns_group_id:[1,2,5],ns_groups_client:[0,1,4,42],ns_servic:1,ns_service_group:1,ns_service_group_id:1,ns_service_id:1,nsgroup:[1,2,4],nsgroup_id:2,nsgroupcomplexexpress:2,nsgroupexpress:[1,2],nsgroupexpressionlist:[1,2],nsgrouplistresult:[1,2],nsgroupmetainfo:2,nsgroupmetainfolistresult:[2,4],nsgroupsimpleexpress:2,nsgrouptagexpress:2,nslookup:[2,10],nsservic:[1,2,15,32],nsservice_el:2,nsserviceel:2,nsservicegroup:[1,2],nsservicegrouplistresult:[1,2],nsservicelistresult:[1,2],nsx:[0,1],nsx_appliance_mod:2,nsx_client:[0,42],nsx_client_for_vmc:[0,42],nsx_connect:2,nsx_intern:2,nsx_message_bus_cli:[0,1,2,26,42],nsx_nodetype_uuid_yyyymmdd_hhmmss:2,nsx_static:2,nsx_upgrade_agent_cli:[0,1,2,26,42],nsxmessagebu:26,nsxrole:2,nsxupgradeag:26,ntk:2,ntlm:2,ntp:[2,26,30],ntp_client:[0,1,2,26,42],ntp_server:2,ntpserviceproperti:2,num:2,num_delta_sync:2,num_full_sync:2,num_lcor:2,num_logical_port:2,num_logical_switch:2,num_transport_nod:2,numa:2,numa_node_index:2,number:[1,2,3,4,5,6,7,8,9,13,14,15,16,18,21,23,24,25,26,29,30,32,37,38],number_of_uplink:2,numer:2,nxdomain:2,oauth2:2,oauth2credenti:2,object:[1,2],object_guid:2,object_id:2,observ:2,observation_domain_id:2,obtain:[1,2],occur:[1,2],octet:2,octet_delta_count:2,off:2,offer:2,offici:2,offlin:16,offline_nod:2,often:2,ofv:2,oid:2,old:[1,2],old_password:2,older:[2,41],omit:[2,6],on_demand:2,on_error:1,on_failure_polici:2,on_failure_policy_allow:2,on_failure_policy_block:2,on_prem:2,onc:[1,2,6,33],one:[1,2,26,33,38,41],onl:2,onli:[1,2,9,16,21,22,25,26,36,37,38,39,40,41],online_nod:2,op_cod:2,op_code_bootrepli:2,op_code_bootrequest:2,op_contain:2,op_equ:2,op_startswith:2,opaqu:[1,2,3,4,5,6,9,15,18,21,23,24,25,32,37,38],open:2,open_confirm:2,open_s:2,openssl:2,oper:[1,2,6,15,32,35],operation_aft:2,operation_befor:2,operation_bottom:2,operation_st:2,operation_state_fail:2,operation_state_finish:2,operation_state_in_progress:2,operation_top:2,operation_typ:2,operation_type_backup:2,operation_type_non:2,operator_and:2,optim:1,option121:2,option:[1,2,3,4,5,6,7,8,9,10,11,13,14,15,16,18,19,20,21,22,23,24,25,26,30,32,35,36,37,38,39,40],oracle_tn:2,order:[1,2],org:2,org_id:[1,2],org_rol:2,organ:[1,2],organiz:1,orginfo:2,origin:[1,2,6],origin_id:2,origin_properti:2,origin_typ:2,orphan:2,os_properti:2,os_typ:2,os_type_centoskvm:2,os_type_centosserv:2,os_type_esxi:2,os_type_hyperv:2,os_type_invalid:2,os_type_linux:2,os_type_rhelcontain:2,os_type_rhelkvm:2,os_type_rhelserv:2,os_type_ubuntukvm:2,os_type_ubuntuserv:2,os_type_window:2,os_vers:2,osi:2,other:[1,2,7,15,23,26,32,33],other_error:2,other_ssl_error:2,otherwis:[1,2],out:[2,26],out_filter_ipprefixlist_id:2,out_filter_routemap_id:2,out_of_servic:2,outbound:2,outdat:2,outer:2,outgo:2,output:[1,2,37],outward:2,over:[1,2],overal:[2,16],overall_migration_statu:2,overall_migration_status_fail:2,overall_migration_status_in_progress:2,overall_migration_status_not_start:2,overall_migration_status_paus:2,overall_migration_status_success:2,overall_upgrade_statu:2,overall_upgrade_status_fail:2,overall_upgrade_status_in_progress:2,overall_upgrade_status_not_start:2,overall_upgrade_status_paus:2,overall_upgrade_status_success:2,overflow:2,overid:2,overlai:[1,2],overlap:2,overlay_encap:2,overlay_encap_genev:2,overlay_encap_vxlan:2,overload:2,overrid:[1,2],overridden:[2,21],override_async_respons:2,overriden:[2,21],overrod:2,overwrit:[2,15],ovf:[2,33],ovf_url:2,own:[2,38],owner:2,owner_id:2,owner_vm_id:2,ownerresourcelink:2,packag:42,package_logging_level:2,package_nam:2,package_stor:2,package_url:2,packagestor:2,packet:[1,2,8,14,16,29],packet_capture_request:2,packet_count:2,packet_delta_count:2,packet_sample_prob:2,packet_typ:2,packetaddressclassifi:2,packetcaptureopt:2,packetcaptureoptionlist:2,packetcapturerequest:2,packetcapturesess:2,packetcapturesessionlist:2,packetdata:2,packets_in:2,packets_in_r:2,packets_out:2,packets_out_r:2,packets_receive_error:2,packets_receive_other_error:2,packets_sent_error:2,packets_sent_other_error:2,packetsdroppedbysecur:2,packettypeandcount:2,pad:2,page:[1,2,3,4,5,6,9,15,18,21,23,24,25,32,37,38,41,42],page_s:[1,2,3,4,5,6,9,15,18,21,23,24,25,32,37,38],pagin:[1,2,3,9,21,23,38],pair:2,parallel:2,param:[1,2],paramat:2,paramet:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,35,36,37,38,39,40,41],parent:[1,2,15],parent_compute_collect:2,parent_vif_id:[1,2],parentobjectfieldnam:2,part:[1,2,4],partial:2,partial_stat:2,partial_success:2,partially_up:2,particip:[1,2],particular:[2,38],partit:2,partner:2,pass:[1,2,41],passiv:[1,2],passive_monitor_id:2,passphras:[2,6],password:[2,6,23],passwordauthenticationschem:2,past:2,patch:2,path:2,path_down:2,path_down_count:2,pattern:1,paus:2,pause_after_each_group:2,pause_on_error:2,payload:[1,2],pbr:2,pbrinsertparamet:2,pbrrule:2,pbrrulelistresult:2,pbrsection:2,pbrsectionlistresult:2,pbrsectionqueryparamet:2,pbrsectionrulelist:2,pbrservic:2,peak:2,peak_bandwidth_kbp:2,peak_bandwidth_mbp:2,peer:[2,21,23,38,39,40],peer_address:2,peer_cod:2,peer_endpoint_id:2,peer_endpoint_ip:2,peer_id:2,peer_ip:2,peer_ip_address:2,peer_port_id:2,peer_subnet:2,peercod:40,peerendpoint:38,pem:2,pem_encod:2,pend:2,pending_upgrad:2,per:[2,15,22,32,39],per_node_statist:2,per_node_statu:2,per_transport_node_statist:2,percent:2,percent_complet:2,percentag:2,perfect:2,perform:[1,2,6,15],performact:2,performaction_action_enter_maintenance_mod:2,performaction_action_exit_maintenance_mod:2,period:2,permiss:2,permission_crud:2,permission_execut:2,permission_group:2,permission_group_read_only_api_us:2,permission_group_read_write_api_us:2,permission_group_superus:2,permission_group_undefin:2,permission_non:2,permission_read:2,permissions_crud:2,permissions_execut:2,permissions_non:2,permissions_read:2,permissions_read_api:2,permissions_read_write_api:2,permit:2,persist:[2,18],persistence_profil:2,persistence_profile_id:2,persistence_shar:2,persistenceprofil:2,persteprestorestatu:2,phase:[2,38],phase_forward:2,phase_request_rewrit:2,phase_response_rewrit:2,physic:[1,2,12],physical_address:2,physical_host:2,physical_machin:[1,2],physicalinterfac:12,pick:2,pictur:2,pid:2,ping:2,pktcap_client:[0,1,42],place:[1,2],placement:[1,2],placement_post:2,placement_pr:2,placement_typ:2,placement_type_vsphereclusternodevmdeploymentconfig:2,placement_type_vspheredeploymentconfig:2,plain:2,plan:[2,25,37],plan_client:[0,1,2,42],plane:[1,2,26],plane_debug:2,plane_mgmt:2,platform:2,pleas:[1,2,33],plot:2,plu:1,plumb:2,pnic:[1,2,12],pnic_statu:2,pnicbondstatu:2,pnicbondstatuslistresult:2,pnicmirrordestin:2,pnicmirrorsourc:2,pnics_list:2,point:[2,30],pointer:2,polici:[1,2,26],policy_failover_ord:2,policy_id:2,policy_loadbalance_srcid:2,policy_rul:2,policy_statist:2,policybasedipsecvpnsess:[2,38],pool:[0,1,2,9,18,19,42],pool_capac:2,pool_id:[2,9,19,31],pool_member_capac:2,pool_member_setting_list:2,pool_siz:2,pool_usag:2,poolmemb:2,poolmembergroup:2,poolmemberset:2,poolmembersettinglist:2,pools_client:[0,1,18,42],poolusag:2,pop:2,popul:[1,2],popular:[2,16,38],popularity_index:2,populate_refer:[1,2],port:[1,2,20,30,35,38],port_desc:2,port_id:2,port_mirroring_sess:1,port_overload:2,portconnectionbment:2,portconnectioncontainersent:2,portconnectionedgenodegroup:2,portconnectionent:2,portconnectionerror:2,portconnectionhypervisor:2,portconnectionlogicalswitch:2,portconnectionrout:2,portconnectiontunnel:2,portgroup:2,portion:[1,2],portmirroringsess:[1,2],portmirroringsessionlistresult:[1,2],portmirroringswitchingprofil:[1,2],portset:2,portstatu:2,posit:[2,15,32],possibl:[1,2,6,7,8,9,11,13,14,15,16,18,19,20,21,22,23,24,25,32,35,36,37,38,39,40],post:[1,2,11,26],potenti:2,power:2,power_st:2,power_state_unknown:2,power_state_vm_run:2,power_state_vm_stop:2,power_state_vm_suspend:2,ppid:2,pre:[2,38],preced:2,precondit:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,35,36,37,38,39,40],preconfigur:[1,2],preconfiguredendpoint:2,preconfiguredhostswitch:2,preconfiguredhostswitchspec:[1,2],predefin:2,preemmptiv:2,preemptiv:2,prefer:[1,2,26],prefer_server_ciph:2,preferred_edge_cluster_member_index:2,preferred_normalization_typ:1,preferrednormalizationtyp:1,prefix:2,prefix_length:2,prefix_oper:2,prefix_operator_eq:2,prefix_operator_g:2,prefixconfig:2,prefonfigur:1,prep:2,prepar:2,prepend:2,presenc:2,present:[1,2,23,36],preserv:2,preserve_original_vlan:2,prev_sync_end_tim:2,prev_sync_statu:2,prev_sync_status_failur:2,prev_sync_status_success:2,prev_sync_status_unknown:2,prev_sync_typ:2,prev_sync_type_delta_sync:2,prev_sync_type_full_sync:2,prev_sync_type_idl:2,prevent:[2,15],previou:[1,2,4,6],previous:[2,6],primari:2,primary_down:2,prime:2,princip:2,principal_ident:2,principal_identity_id:2,principalident:2,principalidentitylist:2,print:[2,41],priorit:2,prioriti:2,privat:2,private_kei:2,privileg:2,probabl:2,probe:2,probe_interv:2,problem:2,process:2,process_id:2,process_nam:2,procid:2,product:2,product_nam:2,product_vers:2,profil:[1,2,4,18,38],profile_id:[1,2],profile_typ:1,program:[2,40,41],progress:[2,11],prohibit:2,properli:2,properti:[1,2,17,23,26,27,38],property_nam:2,property_valu:2,propertyitem:2,propeti:2,protect:2,proto:2,proto_bird:2,proto_boot:2,proto_dhcp:2,proto_dnrout:2,proto_g:2,proto_kernel:2,proto_mrt:2,proto_ntk:2,proto_ra:2,proto_redirect:2,proto_stat:2,proto_unspec:2,proto_xorp:2,proto_zebra:2,protocol:[2,18,26,30],protocol_gr:2,protocol_icmpv4:2,protocol_icmpv6:2,protocol_identifi:2,protocol_ldap:2,protocol_li:2,protocol_li_tl:2,protocol_nam:2,protocol_name_sftp:2,protocol_numb:2,protocol_ssl_v2:2,protocol_ssl_v3:2,protocol_tcp:2,protocol_tl:2,protocol_tls_v1:2,protocol_tls_v1_1:2,protocol_tls_v1_2:2,protocol_udp:2,protocol_vers:2,protocols_ssl_v2:2,protocols_ssl_v3:2,protocols_tls_v1:2,protocols_tls_v1_1:2,protocols_tls_v1_2:2,protocolvers:2,protonpackagelogginglevel:2,protonserviceproperti:2,provid:[0,1,2,6,9,22,26,27,41],provider_url:2,providers_cli:[0,1,2,26,42],providess:1,provis:[2,38],proxi:[1,2],proxy_en:2,proxy_host:2,proxy_id:[1,2],proxy_port:2,proxy_statu:2,proxy_status_down:2,proxy_status_error:2,proxy_status_no_backup:2,proxy_status_up:2,proxyhostswitch:2,psk:[2,38],pub:2,public_cloud_gateway_nod:2,public_key_algo:2,public_key_algo_dsa:2,public_key_algo_rsa:2,public_key_length:2,publiccloudgatewaynod:2,publish:[1,2],publish_fqdn:2,pure:[2,37],purg:2,purge_ful:2,purge_no_purg:2,purpos:[1,2],put:[1,2,23],qos:1,qosbaserateshap:2,qosswitchingprofil:[1,2],qualifi:[2,26],quantiti:2,queri:[1,2,3,4,5,6,9,10,15,18,20,21,22,23,24,25,32,35,36,37,38,39,40],question:2,quicksearchrespons:2,quot:2,rabbit:[26,30],rabbitmq:2,rabbitmqmanagementport:2,rais:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,35,36,37,38,39,40],ram:2,random:2,rang:[1,2,9],rate:2,rate_limit:2,ratelimit:2,raw:2,raw_answ:2,reach:2,reachabl:2,read:[1,2,6,17,21,23,26,27,28,29,30],read_onli:2,read_only_api_us:2,read_write_api_us:2,readabl:2,readi:2,readonli:2,realiz:[2,11,15],realization_state_barrier_cli:[0,1,42],realization_state_barrier_config:2,realizationstatebarrierconfig:2,realized_bind:2,realloc:[1,2],realtim:[2,6,7,8,9,11,13,14,15,16,18,19,20,21,22,24,35,36,38,39,40],reason:2,reason_arp_fail:2,reason_bfd:2,reason_dhcp:2,reason_fw_rul:2,reason_genev:2,reason_gr:2,reason_ifac:2,reason_ip:2,reason_ip_reass:2,reason_ipsec:2,reason_ipsec_vti:2,reason_l2vpn:2,reason_l4port:2,reason_lb:2,reason_lrout:2,reason_lservic:2,reason_lswitch:2,reason_md_proxi:2,reason_nat:2,reason_neigh:2,reason_no_rout:2,reason_service_insert:2,reason_ttl_zero:2,reason_tunnel:2,reason_unknown:2,reason_vxlan:2,reason_vxstt:2,reassign:1,reboot:2,receiv:[2,8,14,29,41],receive_interv:2,receive_window_s:2,received_count:2,recent:2,recevi:2,reclassif:2,reclassifi:4,reclassification_not_requir:2,reclassification_requir:2,recogn:2,recommend:[1,2],reconcil:2,record:[1,2,3,4,5,6,9,15,18,21,23,24,25,32,37,38],recoveri:2,recurs:2,red:2,redeploi:2,redirect:[2,33],redirect_host:2,redirect_statu:2,redirect_to:[2,33],redirect_url:2,redistribut:[2,21,23],redistribution_cli:[0,1,2,21,42],redistribution_config:21,redistribution_rule_list:23,redistributionconfig:[2,21],redistributionrul:2,redistributionrulelist:[2,23],redund:2,redundant_uplink_port_id:2,ref:2,refer:[1,2,15,26,33,38],referenc:[1,2,15,32,38],reflect:[2,16],reflex:2,refresh:1,refresh_token:1,refresh_url:1,refus:2,regex:2,regist:[1,2,6,30],registerd:2,registr:2,registration_error:2,registration_fail:2,registration_pend:2,registration_statu:2,registration_status_regist:2,registration_status_unregist:2,registrationtoken:2,regular:2,regular_express:2,reject:[2,6],rel:[2,15,32],relai:[1,2],relat:[1,2],related_error:2,relatedapierror:2,relateddata:2,relateddatarequest:2,relatedobjectfieldnam:2,relationship:2,relative_url:1,relavit:2,relay_id:2,relay_profile_id:2,relayprofil:2,releas:[1,2],relev:7,reli:2,reliabl:2,remain:[1,2,11],remaining_nod:2,remainingsupportbundlenod:2,rememb:2,remot:[2,38,40,41],remote_a:2,remote_address:2,remote_as_num:2,remote_as_numb:2,remote_diagnost:2,remote_file_serv:2,remote_group:2,remote_ip:2,remote_ip_address:2,remote_mac_address:2,remote_node_display_nam:2,remote_node_id:2,remote_port:2,remote_server_fingerprint_request:2,remote_st:2,remote_state_admin_down:2,remote_state_down:2,remote_state_init:2,remote_state_unknown_st:2,remote_state_up:2,remote_us:2,remotefileserv:2,remotemac:40,remoteserverfingerprint:2,remoteserverfingerprintrequest:2,remotetransportnodestatu:2,remov:[1,2,26,30],remove_memb:[1,2],remove_nsx:2,removehostfingerprint:26,removememb:2,removesshkei:26,render:2,render_configur:2,renderconfigur:2,renew:2,reorder:[2,25,37],reorder_migration_request:[2,25],reorder_request:[2,37],reordermigrationrequest:[2,25],reorderrequest:[2,37],replac:[1,2],replaceedgeclustermembertransportnod:1,replacetransportnod:1,replai:2,replay_error:2,repli:2,replic:2,replication_mod:[1,2],replication_mode_mtep:2,replication_mode_sourc:2,reply_messag:2,reply_statu:2,repo:2,repo_sync_cli:[0,1,2,6,42],repons:2,report:2,reportappresultsforvmsrequestparamet:2,repositori:2,reposync:2,reposyncstatusreport:[2,7],repres:[1,2,33,41],represent:2,reprocess:1,repsons:2,repush:2,reput:2,req_id:2,request:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,35,36,37,38,39,40],request_bodi:2,request_body_s:2,request_head:2,request_header_s:2,request_id:15,request_method:2,request_method_get:2,request_method_head:2,request_method_opt:2,request_method_post:2,request_method_put:2,request_path:2,request_properti:2,request_statu:2,request_status_connection_error:2,request_status_data_path_not_readi:2,request_status_source_port_not_found:2,request_status_success:2,request_status_timeout:2,request_uri:[1,2],request_url:2,request_vers:2,request_version_1_0:2,request_version_1_1:2,request_version_2_0:2,request_version__1_0:2,request_version__1_1:2,request_version__2_0:2,requestid:2,requests_from_cli:2,requests_to_nova_serv:2,requir:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,29,30,31,32,33,35,36,37,38,39,40],require_overrid:2,required_cap:2,required_members_for_initi:2,reserv:2,reset:[2,26,39],reset_category_l3bridgeport:2,reset_category_l3dfw:2,reset_category_l3edg:2,reset_collection_frequ:2,resetcollectionfrequ:2,resetcollectionfrequency_action_frequ:2,resetmanagerlogginglevel:26,resid:2,resolv:[1,2,10],resolveerror:1,resolver_pres:2,resourc:[1,2,23,38],resource_id:1,resource_refer:2,resource_typ:[1,2],resource_type_algtypensservic:2,resource_type_assignedbydhcp:2,resource_type_bfdhealthmonitoringprofil:2,resource_type_binarypacketdata:2,resource_type_bridgehighavailabilityclusterprofil:2,resource_type_byodserviceinst:2,resource_type_containerconfigur:2,resource_type_dhcprelayprofil:2,resource_type_dhcprelayservic:2,resource_type_donutconfigur:2,resource_type_edgehighavailabilityprofil:2,resource_type_egressrateshap:2,resource_type_ethertypensservic:2,resource_type_extraconfighostswitchprofil:2,resource_type_fieldspacketdata:2,resource_type_gridconfigur:2,resource_type_hostprofilenetworkmigrationspec:2,resource_type_icmptypensservic:2,resource_type_igmptypensservic:2,resource_type_ingressbroadcastrateshap:2,resource_type_ingressrateshap:2,resource_type_intervalbackupschedul:2,resource_type_ipfixcollectorupmprofil:2,resource_type_ipfixdfwconfig:2,resource_type_ipfixswitchconfig:2,resource_type_ipfixswitchupmprofil:2,resource_type_ipmirrordestin:2,resource_type_ipprotocolnsservic:2,resource_type_ipsecvpntransportstatu:2,resource_type_l4portsetnsservic:2,resource_type_labelvalueconfigur:2,resource_type_lbcookiepersistenceprofil:2,resource_type_lbfasttcpprofil:2,resource_type_lbfastudpprofil:2,resource_type_lbhttpmonitor:2,resource_type_lbhttpprofil:2,resource_type_lbhttpsmonitor:2,resource_type_lbicmpmonitor:2,resource_type_lbpassivemonitor:2,resource_type_lbsourceippersistenceprofil:2,resource_type_lbtcpmonitor:2,resource_type_lbudpmonitor:2,resource_type_lldphostswitchprofil:2,resource_type_logicalportmirrordestin:2,resource_type_logicalportmirrorsourc:2,resource_type_logicalroutercentralizedserviceport:2,resource_type_logicalrouterdownlinkport:2,resource_type_logicalrouteriptunnelport:2,resource_type_logicalrouterlinkportontier0:2,resource_type_logicalrouterlinkportontier1:2,resource_type_logicalrouterloopbackport:2,resource_type_logicalrouteruplinkport:2,resource_type_logicalswitchmirrorsourc:2,resource_type_multiwidgetconfigur:2,resource_type_niocprofil:2,resource_type_nsgroupcomplexexpress:2,resource_type_nsgroupsimpleexpress:2,resource_type_nsgrouptagexpress:2,resource_type_pnicmirrordestin:2,resource_type_pnicmirrorsourc:2,resource_type_policybasedipsecvpnsess:2,resource_type_preconfiguredhostswitchspec:2,resource_type_routebasedipsecvpnsess:2,resource_type_serviceinst:2,resource_type_standardhostswitchspec:2,resource_type_staticiplistspec:2,resource_type_staticipmaclistspec:2,resource_type_staticippoolspec:2,resource_type_statsconfigur:2,resource_type_traceflowobservationdeliv:2,resource_type_traceflowobservationdrop:2,resource_type_traceflowobservationdroppedlog:2,resource_type_traceflowobservationforward:2,resource_type_traceflowobservationforwardedlog:2,resource_type_traceflowobservationreceiv:2,resource_type_traceflowobservationreceivedlog:2,resource_type_uplinkhostswitchprofil:2,resource_type_virtualserviceinst:2,resource_type_vlanmirrorsourc:2,resource_type_weeklybackupschedul:2,resourcealloc:2,resourcebusi:2,resourcelink:2,resourcepool:2,resourcerefer:2,resourcetyp:[1,2],respect:2,respond:2,respond_onli:2,respons:[1,2,15,16,26,41],response_bodi:2,response_list:2,response_status_cod:2,response_timeout:2,responses_to_cli:2,respos:2,rest:2,restart:[1,2,21,26],restartinventorysync:2,restor:[2,6],restore_cli:[0,1,2,42],restore_configur:6,restore_end_tim:2,restore_start_tim:2,restoreconfigur:[2,6],restorestep:2,restrict:[1,2],result:[1,2,3,4,5,6,9,15,18,21,23,24,25,32,37,38],result_count:2,result_overflow:2,results_directorygroup:2,results_ipset:2,results_logicalport:2,results_logicalswitch:2,results_macset:2,results_nsgroup:2,results_virtualmachin:2,resum:2,resync:1,resynchostconfig:1,retain:[1,2],retri:[1,2],retriev:[1,2,15,18],retrievesshfingerprint:2,retur:2,reus:2,reusabl:[2,38],reveal:2,revers:[2,10],reverse_concatenated_path_down:2,reverse_concatenated_path_down_count:2,revis:[2,15,32],revise_operation_aft:[2,15,32],revise_operation_befor:[2,15,32],revise_operation_bottom:[2,15,32],revise_operation_top:[2,15,32],revisewithrul:2,revisewithrules_operation_aft:2,revisewithrules_operation_befor:2,revisewithrules_operation_bottom:2,revisewithrules_operation_top:2,revision_desir:2,revisionedresourc:2,revoc:2,revocation_d:2,revok:2,rewrit:2,rewritten:2,rfc5424:2,rfc:2,rhel:2,rhelcontain:2,rhelkvm:2,rhelserv:2,rib:21,rid:2,right:2,rise_count:2,role:[1,2,6],role_auditor:2,role_bind:2,role_cloud_admin:2,role_cloud_auditor:2,role_cloud_service_admin:2,role_cloud_service_auditor:2,role_config:2,role_enterprise_admin:2,role_lb_admin:2,role_lb_auditor:2,role_network_engin:2,role_network_op:2,role_read_only_api_us:2,role_read_write_api_us:2,role_security_engin:2,role_security_op:2,role_site_reliability_auditor:2,role_site_reliability_engin:2,rolebind:2,rolebindinglistresult:2,rolelistresult:2,roles_control:2,roles_manag:2,rolewithfeatur:2,roll:2,rollbabck:2,rollback:2,rolled_back:2,root:2,root_password:2,roughli:2,round:[1,2],round_robin:2,rout:[0,1,2,21,26,42],route_aggreg:2,route_id:[2,26],route_map:21,route_map_id:2,route_sourc:21,route_to_overlai:2,route_to_overlay_nat:2,route_to_underlai:2,route_to_underlay_nat:2,route_typ:[2,26],route_type_blackhol:2,route_type_default:2,route_type_prohibit:2,route_type_stat:2,route_type_throw:2,route_type_unreach:2,routebasedipsecvpnsess:[2,38],routemap:[2,21],routemaplistresult:[2,21],routemapsequ:2,routemapsequencematch:2,routemapsequenceset:2,router:[1,2,20,21,22,23,35,36,38],router_port:2,router_typ:[1,2],router_type_tier0:2,router_type_tier1:2,routerlink:1,routertyp:1,routesourc:21,routet:21,routing_cli:[0,1,2,42],routing_config:2,routingconfig:2,routingt:21,row:2,row_list_field:2,rowlistfield:2,rpc:2,rpm:2,rsa:2,rsa_public_key_expon:2,rsa_public_key_modulu:2,rspandstmirrorsess:2,rspansrcmirrorsess:2,rst:2,rui:2,rule:[1,2,15,16,18,21,22,23,30,32,33,36],rule_count:2,rule_filt:2,rule_id:[2,15,16,21,22,32],rule_prior:2,rule_tag:2,rules_cli:[0,1,2,21,42],rulest:[2,15],run:2,runtim:[2,33],runtime_st:2,runtime_state_run:2,runtime_state_stop:2,runtime_statu:2,runtime_status_in_servic:2,runtime_status_needs_attent:2,runtime_status_not_avail:2,runtime_status_out_of_servic:2,runtimeinterfaceoperationalstatu:[2,35],runtimeinterfacestatist:[2,35],rx_broadcast:2,rx_byte:2,rx_drop:2,rx_error:2,rx_frame:2,rx_multicast:2,rx_packet:2,s2comp:2,sa_life_tim:2,sa_mismatch_errors_in:2,sa_mismatch_errors_out:2,sai:2,same:[1,2,15],sampl:2,sane:2,satisfi:2,saturdai:2,save:2,savedsearch:2,savedsearchlistresult:2,savedsearchrequest:2,scalabl:2,scenario:2,schedul:2,schedule_en:2,schema:[1,2],scheme:2,scheme_http:2,scheme_nam:2,scheme_name_bas:2,scheme_name_password:2,scope:[2,26],scope_op:2,scope_op_equ:2,scp:2,scpprotocol:2,sddc:[1,2],sddc_id:[1,2],sdk:41,search:[2,3,15,26,30,32,42],search_client:[0,1,2,26,42],search_domain:2,search_invalid_refer:[2,15],search_scop:2,search_str:3,searchdomain:26,searchrespons:2,sec:2,second:2,secondari:2,seconds_between_backup:2,secreci:2,secret:[2,6],section:[0,1,2,15,32,42],section_count:2,section_id:[2,15,16,32],section_revis:2,section_typ:2,section_type_l2dfw:2,section_type_l3dfw:2,section_type_l3redirect:2,section_type_layer2:2,section_type_layer3:2,sections_cli:[0,1,2,42],sections_summari:2,secur:[1,2,26],secure_id:2,security_context_filt:1,security_engin:2,security_op:2,securitycontext:1,securitycontextfilt:1,sed:2,see:[1,2,11,41],seen:2,segment:2,segment_id:2,select:[2,25,37],selectableresourcerefer:2,selection_statu:[2,25,37],selectionstatu:[2,25,37],self:[1,2],self_:2,self_sign:2,selfresourcelink:2,selfsign:2,semicolon:2,send:[2,41],send_en:2,sens:2,sensit:2,sent:2,separ:[1,2,3,4,5,6,9,15,18,21,23,24,25,32,37,38],seper:2,seq_number_overflow_error:2,sequenc:2,sequence_no:2,seri:2,serial:2,serial_numb:2,seriv:19,serivc:2,serv:[1,2],server:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,35,36,37,38,39,40,41],server_address:2,server_auth:2,server_auth_ca_id:2,server_auth_crl_id:2,server_auth_ignor:2,server_auth_requir:2,server_block_en:2,server_id:[2,9],server_ssl_profil:2,server_ssl_profile_bind:2,server_ssl_profile_id:2,server_tcp_profile_id:2,serverprofil:2,servers_cli:[0,1,2,42],serversslprofil:2,serversslprofilebind:2,servic:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,20,21,22,23,24,25,26,27,28,29,31,32,36,37,38,39,40,41,42],service_attach:2,service_attachment_id:2,service_bind:[1,2],service_definit:2,service_definition_id:2,service_deployment_spec:2,service_form_factor:2,service_form_factor_larg:2,service_form_factor_medium:2,service_form_factor_smal:2,service_id:[1,2,18,19,32,33,35,38],service_insert:2,service_insertion_rul:32,service_insertion_rule_list:32,service_insertion_sect:2,service_insertion_section_rule_list:2,service_inst:[0,1,2,32,33],service_instance_id:[2,32,33,35],service_instances_cli:[0,1,2,32,42],service_nam:2,service_port:2,service_profil:1,service_profile_id:1,service_properti:2,service_router_allocation_config:1,service_router_id:2,service_s:2,service_size_larg:2,service_size_medium:2,service_size_smal:2,service_statu:2,service_status_detach:2,service_status_dis:2,service_status_down:2,service_status_error:2,service_status_no_standbi:2,service_status_unknown:2,service_status_up:2,service_typ:2,service_type_eth:2,service_type_firewallserviceassociationlistresult:2,service_type_ipfixserviceassociationlistresult:2,service_type_non_eth:2,service_types_api:2,service_types_mgmt_clust:2,service_types_mgmt_plan:2,service_vm_id:2,service_vm_ovf_url:2,serviceassoci:2,serviceassociationlistresult:2,serviceattach:2,serviceattachmentlistresult:2,servicebind:2,servicedefinit:2,servicedeploy:2,servicedeploymentspec:2,serviceendpoint:2,serviceinsert:[0,1,2,42],serviceinsertion_cli:[0,1,42],serviceinsertionrul:[2,32],serviceinsertionrulelist:[2,32],serviceinsertionrulelistresult:[2,32],serviceinsertionrulexxxlist:2,serviceinsertionsect:2,serviceinsertionsectionlistresult:2,serviceinsertionsectionrulelist:2,serviceinsertionservic:2,serviceinsertionservicelistresult:2,serviceinst:[2,32],serviceinstancelistresult:[2,32],serviceip:2,serviceipslistresult:2,serviceprofil:[1,2],serviceprofilelistresult:[1,2],servicerouterallocationconfig:[1,2],services_cli:[0,1,2,42],servicesinst:2,servicetyp:2,serviceunavail:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,35,36,37,38,39,40],session:[0,1,2,4,16,38,39,40,42],session_cache_en:2,session_cache_timeout:2,session_count:2,session_id:[2,4,5,39,40],session_reclassification_paramet:4,session_reus:2,session_reused_ignor:2,session_reused_new:2,session_reused_reus:2,session_statu:2,session_status_degrad:2,session_status_down:2,session_status_up:2,session_summari:2,session_timeout:2,session_typ:[2,38],session_type_l3portmirrorsess:2,session_type_localportmirrorsess:2,session_type_logicallocalportmirrorsess:2,session_type_logicalportmirrorsess:2,session_type_rspandstmirrorsess:2,session_type_rspansrcmirrorsess:2,session_type_uplinkportmirrorsess:2,sessionid:2,sessionnam:2,sessionreclassificationparamet:[2,4],sessions_cli:[0,1,2,38,42],sessionstatu:2,sessionstatus_cr:2,sessionstatus_error:2,sessionstatus_finish:2,sessionstatus_start:2,sessionstatus_stop:2,sessiontyp:38,sessoin:2,set:[1,2,6,23,25,33,37,38],set_criteria:2,setup:2,sever:[2,30],severity_crit:2,severity_major:2,severity_minor:2,severity_unknown:2,sftp:[2,6],sftpprotocol:2,sha1:2,sha256:2,sha256_thumbprint:2,sha256sum:2,sha2_256:2,sha2_384:2,sha2_512:2,sha:2,shall:2,shaper:2,shaper_configur:2,share:[1,2],shared_secret:2,should:[1,2,3,4,5,6,9,15,18,21,23,24,25,26,32,37,38],should_retri:1,show:[1,2],show_histori:2,shown:2,showsensitivedata:[23,38],shrink:2,shut:[1,2],shutdown:1,siaggregateddatacount:2,siaggregateddatacounterex:2,sid:2,sidatacount:2,side:[2,40],sign:2,signal:2,signatur:2,signature_algorithm:2,signific:2,simaclearningcount:2,similar:[1,2],similarli:2,simpl:2,simplifi:2,simultan:[2,15],sinc:[1,2,41],singl:[1,2,9,11],singular:2,sipacketsdroppedbysecur:2,sipackettypeandcount:2,site:[2,39],site_id:39,site_reliability_auditor:2,site_reliability_engin:2,situat:[1,2],size:[1,2],size_larg:2,size_medium:2,size_smal:2,skip:2,sky_blu:2,slash:2,slave:2,slot:2,slow:2,small:[1,2],smaller:2,snap_length:2,snat:2,snat_transl:2,sni:2,sni_certificate_id:2,snmp:[2,26,30],snmp_client:[0,1,2,26,42],snmpcommun:2,snmpserviceproperti:2,snoop:2,socket:2,soft:2,softwar:[1,2],software_modul:2,software_vers:2,softwaremodul:2,softwaremoduleresult:[2,11],some:[1,2],sometim:[1,2],somewher:[1,2,23,38],soon:2,sorri:2,sorry_pool_id:2,sort:[1,2,3,4,5,6,9,15,18,21,23,24,25,32,37,38],sort_ascend:[1,2,3,4,5,6,9,15,18,21,23,24,25,32,37,38],sort_bi:[1,2,3,4,5,6,9,15,18,21,23,24,25,32,37,38],sort_kei:2,sourc:[1,2,6,7,8,9,11,13,14,15,16,18,19,20,21,22,24,26,32,35,36,38,39,40,41],source_address:2,source_arp_snoop:2,source_authentication_mod:2,source_authentication_mode_basic_authent:2,source_authentication_mode_market_plac:2,source_authentication_mode_no_authent:2,source_cach:2,source_comp:2,source_comp_id:2,source_dhcp_snoop:2,source_icmp_typ:2,source_info:41,source_invalid:2,source_ip:2,source_ip_persistence_entry_s:2,source_nsx:2,source_pn:2,source_port:2,source_port_not_found:2,source_realtim:2,source_subcomp:2,source_svc:41,source_tool:2,source_transport_port:2,source_unknown:2,source_user_defin:2,source_vm_tool:2,sourceip:2,sourcensxapiendpoint:2,sources_bgp:2,sources_exclud:2,sources_nsx_connect:2,sources_nsx_stat:2,sources_stat:2,sources_tier0_nat:2,sources_tier1_lb_snat:2,sources_tier1_lb_vip:2,sources_tier1_nat:2,sourcetyp:41,south:2,space:2,span:2,spawn:2,spec:[1,2,41],special:[2,41],specif:[1,2,6,21,23,30,38],specifi:[1,2,4,6,7,8,9,10,13,14,20,21,22,23,26,29,30,31,32,35,37,41],speed:2,speicifi:2,spitch:2,spoke:2,spoof:[1,2],spoof_guard_drop:2,spoofguard:2,spoofguardswitchingprofil:2,src:2,src_component_id:2,src_component_nam:2,src_component_typ:2,src_component_type_bridg:2,src_component_type_dfw:2,src_component_type_edge_hostswitch:2,src_component_type_edge_tunnel:2,src_component_type_l:2,src_component_type_lr:2,src_component_type_phys:2,src_component_type_unknown:2,src_interface_id:2,src_ip:2,src_mac:2,src_node_id:2,src_port:2,src_subnet_prefix_len:2,srcdestipvlan:2,srcdestmac:2,srcdestmacipport:2,srcip:2,srcmac:2,srcport:2,sre_org:2,ssh:[2,26,30],ssh_client:[0,1,2,26,42],ssh_fingerprint:2,ssh_host_ecdsa_kei:2,ssh_host_rsa_kei:2,ssh_key_base_properti:26,ssh_key_properti:26,sshkei:26,sshkeybaseproperti:[2,26],sshkeyproperti:[2,26],sshkeypropertieslistresult:[2,26],sshserviceproperti:2,ssl:[2,18],ssl_client:[0,1,2,42],ssl_profile_id:2,ssl_v2:2,ssl_v3:2,sslv2:2,sslv3:2,stabl:2,stack:2,stage:2,stale:[2,15],stale_fals:2,stale_tru:2,stale_unknown:2,stamp:2,stand:[2,33],stand_alon:2,stand_bi:2,stand_by_nod:2,standalon:[2,33],standard:[1,2],standardhostswitch:2,standardhostswitchspec:[1,2],standbi:[2,33],standby_list:2,standby_transport_nod:2,start:[2,4,26],start_app_discovery_session_paramet:2,start_on_boot:2,start_tim:2,start_timestamp:2,startappdiscoverysessionparamet:2,starts_with:2,startswith:2,starttim:2,stastic:2,stat:[2,8,14,16,29],state:[2,11,15],state_acknowledg:2,state_act:2,state_admin_down:2,state_down:2,state_fail:2,state_failed_to_cr:2,state_failed_to_r:2,state_in_progress:2,state_init:2,state_orphan:2,state_partial_success:2,state_pend:2,state_resolv:2,state_success:2,state_unknown:2,state_unknown_st:2,state_up:2,stateless:[1,2],static_hop_bfd_p:23,static_ip_pool_id:2,static_rout:[2,21],static_routes_cli:[0,1,2,21,42],staticbind:9,statichopbfdp:[2,23],statichopbfdpeerlistresult:[2,23],staticiplistspec:2,staticipmaclistspec:2,staticippoolspec:2,staticrout:[2,21],staticroutelistresult:[2,21],staticroutenexthop:2,staticst:2,statist:[1,2,9,16,18,19,20,22,35,36,38,39,40],statistics_across_all_nod:2,statistics_cli:[0,1,2,42],statitem:2,statsconfigur:2,statu:[1,2,6,7,9,11,13,18,19,24,25,26,28,30,35,37,39,40],status:2,status_cancel:2,status_degrad:2,status_detach:2,status_dis:2,status_down:2,status_en:2,status_enabled_pending_reboot:2,status_error:2,status_fail:2,status_finish:2,status_graceful_dis:2,status_in_progress:2,status_initi:2,status_kil:2,status_messag:2,status_not_start:2,status_partially_up:2,status_paus:2,status_pend:2,status_primary_down:2,status_process:2,status_run:2,status_st:2,status_success:2,status_unknown:2,status_unknown_st:2,status_unst:2,status_unus:2,status_up:2,status_upload:2,status_verifi:2,status_vm_clustering_fail:2,status_vm_clustering_in_progress:2,status_vm_clustering_success:2,status_vm_decluster_fail:2,status_vm_decluster_in_progress:2,status_vm_decluster_success:2,status_vm_deployment_fail:2,status_vm_deployment_in_progress:2,status_vm_deployment_queu:2,status_vm_online_fail:2,status_vm_power_off_fail:2,status_vm_power_off_in_progress:2,status_vm_power_on_fail:2,status_vm_power_on_in_progress:2,status_vm_undeploy_fail:2,status_vm_undeploy_in_progress:2,status_vm_undeploy_success:2,status_vm_waiting_to_clust:2,status_vm_waiting_to_come_onlin:2,status_waiting_to_register_vm:2,status_waiting_to_undeploy_vm:2,statuscount:2,statussummari:2,std:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,35,36,37,38,39,40],step:2,step_numb:2,stg:2,still:1,stop:[2,26],storag:2,storage_id:2,store:[2,6],str:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,29,30,31,32,33,35,36,37,38,39,40,41],strategi:2,stream:2,streamaddress:2,streamport:2,strength:2,strict:2,string:[1,2,3,37,41],stringmapentri:2,strong:38,struct:[1,2,32,38],struct_data:2,structur:2,structured_data:2,structureddata:2,stt:2,stub:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,35,36,37,38,39,40],stub_config:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,35,36,37,38,39,40],stub_factory_class:1,stubconfigur:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,35,36,37,38,39,40],stubfactori:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,35,36,37,38,39,40],stubfactorybas:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,35,36,37,38,39,40],sub:2,sub_system_address:2,sub_system_id:2,sub_system_typ:2,sub_vert:2,subauthor:2,subcomp:2,subcompon:2,subdivid:2,subject:2,subject_cn:2,subject_dn:2,submodul:[0,34,42],subnet:[1,2],subnet_id:2,subnet_mask:2,subpackag:42,subsequ:2,subset:2,substr:[2,3],succe:[2,26],succeed:2,succeeded_responses_from_nova_serv:2,success:2,success_nod:2,successfulli:[2,6,11,33],successnodesupportbundleresult:2,suffici:2,suffix:2,suggest:[2,38],suggested_act:2,suggested_valu:2,suit:2,sum:2,summar:2,summari:[1,2,4,15,20,25,37,38,39,40],summarizeinventorytoremot:1,summary_onli:2,summat:[20,22,36],sun:2,sun_rpc_tcp:2,sun_rpc_udp:2,sundai:2,superus:2,suppli:[1,2,3,4,5,6,9,15,18,21,23,24,25,32,37,38],support:[1,2,16,18,20,22,35,36,38,39,40,41],support_bundle_request:2,supportbundl:2,supportbundlefiletransferauthenticationschem:2,supportbundlefiletransferprotocol:2,supportbundlequeryparamet:2,supportbundleremotefileserv:2,supportbundlerequest:2,supportbundleresult:2,supported_algorithm:2,suppress:2,suppress_redirect:2,sure:[2,33],suspend:2,suspended_by_us:2,suspended_for_user_act:2,svm:2,svmdeploymentspec:2,swap:2,swap_tot:2,swap_us:2,switch_id:2,switchglob:2,switching_profile_id:[1,2],switching_profile_typ:1,switching_profiles_cli:[0,1,42],switchingprofil:1,switchingprofileslistresult:[1,2],switchingprofilestatu:2,switchingprofiletypeidentri:2,switchingtovmcmodeparamet:2,switchsecurityswitchingprofil:2,syn:2,sync:[1,2,25,37],sync_entire_domain:2,sync_set:2,synchron:[2,25,37],syntax:2,syslog:[2,26,30],syslog_cli:[0,1,2,26,42],system:[1,2,16,38,41],system_desc:2,system_metadata:2,system_nam:2,system_own:2,system_port_numb:2,system_statu:2,system_tim:[1,2],system_vers:2,t1_lb_snat:2,t1_lb_vip:2,t1_nat:2,tabl:[2,21,26],tag:2,tag_op:2,tag_op_equ:2,take:[1,2],taken:2,tansport:2,tap:2,tap_traffic_count:2,target:[1,2,33],target_display_nam:2,target_id:2,target_ip:2,target_node_id:[1,2],target_properti:2,target_resourc:2,target_statu:2,target_status:2,target_status_dis:2,target_status_en:2,target_typ:2,target_type_directorygroup:2,target_type_ipset:2,target_type_logicalport:2,target_type_logicalswitch:2,target_type_macset:2,target_type_nsgroup:2,target_type_virtualmachin:2,target_uri:[1,2],target_vers:2,targetip:2,targetresourcestatu:2,task:[1,2,26],task_id:[1,2,26],tasklistresult:[1,2],taskproperti:[1,2],tasks_client:[0,1,42],tcp:[2,30],tcp_flag:2,tcp_header:2,tcp_multiplexing_en:2,tcp_multiplexing_numb:2,tcp_profil:2,tcp_profile_id:2,tcpheader:2,tcpprofil:2,team:[1,2],teamingpolici:2,telemetri:[2,26,30],telemetry_agr:2,telemetry_agreement_displai:2,telemetry_cli:[0,1,26,42],telemetry_config:2,telemetry_proxi:2,telemetry_schedul:2,telemetryagr:2,telemetryconfig:2,telemetryproxi:2,telemetryschedul:2,tell:2,templat:[1,2],template_id:[1,2],template_paramet:2,template_st:2,temporarili:2,tenant:2,term:2,termin:2,text:2,tftp:2,tgz:2,than:[2,26],thei:[1,2,16],them:[1,2],therefor:2,thi:[1,2,3,4,5,6,9,15,16,18,21,23,24,25,26,32,33,37,38,41],think:2,those:[1,2,21,38],though:2,three:2,threshold:2,through:[1,2,30],thrown:2,thumbprint:[2,26],thursdai:2,tier0:[1,2,21,23],tier0_lr:2,tier0_nat:2,tier1:[1,2,21,23],tier1_lb_snat:2,tier1_lb_vip:2,tier1_lr:2,tier1_nat:2,tier:2,time:[1,2,26],time_since_establish:2,timedout:[1,2],timeout:[1,2],timeout_typ:2,timeout_type_fast:2,timeout_type_slow:2,timer:[2,6],timestamp:[2,6],timestamp_micro:2,timezon:[1,2],timstamp:2,titl:2,tls1:2,tls_ca_pem:2,tls_ecdh_ecdsa_with_aes_128_cbc_sha256:2,tls_ecdh_ecdsa_with_aes_128_cbc_sha:2,tls_ecdh_ecdsa_with_aes_128_gcm_sha256:2,tls_ecdh_ecdsa_with_aes_256_cbc_sha384:2,tls_ecdh_ecdsa_with_aes_256_cbc_sha:2,tls_ecdh_ecdsa_with_aes_256_gcm_sha384:2,tls_ecdh_rsa_with_aes_128_cbc_sha256:2,tls_ecdh_rsa_with_aes_128_cbc_sha:2,tls_ecdh_rsa_with_aes_128_gcm_sha256:2,tls_ecdh_rsa_with_aes_256_cbc_sha384:2,tls_ecdh_rsa_with_aes_256_cbc_sha:2,tls_ecdh_rsa_with_aes_256_gcm_sha384:2,tls_ecdhe_ecdsa_with_aes_128_cbc_sha256:2,tls_ecdhe_ecdsa_with_aes_128_cbc_sha:2,tls_ecdhe_ecdsa_with_aes_128_gcm_sha256:2,tls_ecdhe_ecdsa_with_aes_256_cbc_sha384:2,tls_ecdhe_ecdsa_with_aes_256_cbc_sha:2,tls_ecdhe_ecdsa_with_aes_256_gcm_sha384:2,tls_ecdhe_rsa_with_aes_128_cbc_sha256:2,tls_ecdhe_rsa_with_aes_128_cbc_sha:2,tls_ecdhe_rsa_with_aes_128_gcm_sha256:2,tls_ecdhe_rsa_with_aes_256_cbc_sha384:2,tls_ecdhe_rsa_with_aes_256_cbc_sha:2,tls_ecdhe_rsa_with_aes_256_gcm_sha384:2,tls_rsa_with_3des_ede_cbc_sha:2,tls_rsa_with_aes_128_cbc_sha256:2,tls_rsa_with_aes_128_cbc_sha:2,tls_rsa_with_aes_128_gcm_sha256:2,tls_rsa_with_aes_256_cbc_sha256:2,tls_rsa_with_aes_256_cbc_sha:2,tls_rsa_with_aes_256_gcm_sha384:2,tls_v1:2,tls_v1_1:2,tls_v1_2:2,tlsv1:2,togeth:[1,2],token:[1,2],too:2,tool:2,tooltip:2,top:2,topolog:[1,2],total:[2,16],total_byt:2,total_id:2,total_in_prefix_count:2,total_l2vpn_sess:2,total_out_prefix_count:2,total_packet:2,total_port:2,total_sess:2,total_session_count:2,total_step:2,total_switch:2,total_tunnel:2,totoal:2,trace:[1,2],traceflow:[1,2],traceflow_id:[1,2],traceflow_request:1,traceflowlistresult:[1,2],traceflowobserv:2,traceflowobservationcount:2,traceflowobservationdeliv:2,traceflowobservationdrop:2,traceflowobservationdroppedlog:2,traceflowobservationforward:2,traceflowobservationforwardedlog:2,traceflowobservationlistresult:2,traceflowobservationreceiv:2,traceflowobservationreceivedlog:2,traceflowrequest:[1,2],traceflows_cli:[0,1,42],track:2,traffic:[1,2],traffic_count:2,traffic_nam:2,traffic_name_fault_toler:2,traffic_name_hbr:2,traffic_name_iscsi:2,traffic_name_manag:2,traffic_name_nf:2,traffic_name_vdp:2,traffic_name_virtual_machin:2,traffic_name_vmot:2,traffic_name_vsan:2,traffic_statistics_per_logical_switch:2,traffic_summary_per_sess:2,traffic_tag:2,traffic_typ:2,transact:[1,2],transfer:2,transform:2,transform_protocol:2,transform_protocol_esp:2,transit:[1,2],translated_field:2,translated_network:2,translated_port:2,transmiss:[2,30],transmit:[2,8,14,29],transmit_interv:2,transmit_window_s:2,transpar:2,transport:[1,2,11,16,17,22,24,36],transport_head:2,transport_nod:[0,1,2,42],transport_node_id:[1,2,21,24],transport_node_nam:2,transport_node_typ:2,transport_node_type_edg:2,transport_node_type_esx:2,transport_node_type_hyperv:2,transport_node_type_oth:2,transport_node_type_public_cloud_gateway_nod:2,transport_node_type_rhelkvm:2,transport_node_type_ubuntukvm:2,transport_node_uuid:2,transport_nodes_cli:[0,1,42],transport_nodes_connect:2,transport_tunnel:2,transport_typ:[1,2],transport_type_broadcast:2,transport_type_l2_bridg:2,transport_type_l3_rout:2,transport_type_multicast:2,transport_type_overlai:2,transport_type_unicast:2,transport_type_unknown:2,transport_type_vlan:2,transport_vlan:[1,2],transport_zon:1,transport_zone_endpoint:[1,2],transport_zone_id:[1,2],transport_zone_profil:1,transport_zone_profile_id:2,transport_zones_cli:[0,1,42],transportnod:[1,2,21],transportnode_id:[1,2],transportnodelistresult:[1,2],transportnodest:2,transportnodestatelistresult:2,transportnodestatu:2,transportnodestatuslistresult:2,transportnodetemplatelistresult:[1,2],transportnodetemplatest:2,transportnodeupdateparamet:1,transportprotocolhead:2,transports_l2_bridg:2,transports_l3_rout:2,transporttyp:[1,2],transportzon:[1,2],transportzone_profile_id:1,transportzoneendpoint:2,transportzonelistresult:[1,2],transportzoneprofil:[1,2],transportzoneprofilelistresult:[1,2],transportzoneprofiletypeidentri:2,transportzonestatu:2,transportzonestatuslistresult:2,transpot:11,trasnport:2,treat:2,tri:[1,2],trigger:[1,2],troubleshoot:[2,18],truncat:2,trunk:2,trunkvlanrang:2,trust:[1,2,26],trust_ca_id:2,trust_crl_id:2,trust_management_cli:[0,1,42],trust_object_data:2,truste:2,trustmanag:1,trustmanagementdata:[1,2],trustobjectdata:2,truststor:2,ttl:2,ttl_zero:2,tuesdai:2,tunnel:[1,2,38,39,40],tunnel_down_reason:2,tunnel_encapsul:2,tunnel_id:2,tunnel_mod:2,tunnel_nam:2,tunnel_port:2,tunnel_port_id:2,tunnel_properti:2,tunnel_statist:2,tunnel_statu:2,tunnel_status_down:2,tunnel_status_negoti:2,tunnel_status_up:2,tunnellist:2,tunnelportconfig:2,tunnelprofil:38,tunnelproperti:2,tunnelstatu:2,tunnelstatuscount:2,tupl:2,turn:2,two:[1,2,33,38,41],tx_broadcast:2,tx_byte:2,tx_carrier:2,tx_coll:2,tx_drop:2,tx_error:2,tx_multicast:2,tx_packet:2,type:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,35,36,37,38,39,40],type_addcontrollernodespec:2,type_addmanagementnodespec:2,type_bond:2,type_controllerclusterroleconfig:2,type_d:2,type_detail:2,type_edg:2,type_error:2,type_group:2,type_info:2,type_inprogress:2,type_ipv4_unicast:2,type_lbhttpredirectact:2,type_lbhttprejectact:2,type_lbhttprequestbodycondit:2,type_lbhttprequestcookiecondit:2,type_lbhttprequestheadercondit:2,type_lbhttprequestheaderdeleteact:2,type_lbhttprequestheaderrewriteact:2,type_lbhttprequestmethodcondit:2,type_lbhttprequesturiargumentscondit:2,type_lbhttprequesturicondit:2,type_lbhttprequesturirewriteact:2,type_lbhttprequestversioncondit:2,type_lbhttpresponseheadercondit:2,type_lbhttpresponseheaderdeleteact:2,type_lbhttpresponseheaderrewriteact:2,type_lbhttpsslcondit:2,type_lbipheadercondit:2,type_lbpersistencecookietim:2,type_lbselectpoolact:2,type_lbselectserveract:2,type_lbsessioncookietim:2,type_lbsnatautomap:2,type_lbsnatippool:2,type_lbtcpheadercondit:2,type_lbvariableassignmentact:2,type_lbvariablecondit:2,type_local_us:2,type_managementclusterroleconfig:2,type_not_avail:2,type_numb:2,type_pn:2,type_principal_ident:2,type_regular:2,type_remote_group:2,type_remote_us:2,type_servic:2,type_str:2,type_success:2,type_unknown_typ:2,type_url:2,type_us:2,type_vpnv4_unicast:2,type_warn:2,typegroup:2,typic:2,ubuntu:2,ubuntukvm:2,ubuntuserv:2,udp:[2,30],udp_head:2,udphead:2,ui_service_cli:[0,1,2,26,42],ui_views_cli:[0,1,42],uiservic:26,uiview:1,unassociatedvirtualmachin:2,unassociatedvmlistresult:2,unauthent:[1,2],unauthor:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,35,36,37,38,39,40],unavail:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,35,36,37,38,39,40],unbind:1,unblock:2,unblocked_vlan:2,unbound:2,uncertainti:2,uncondition:2,undefin:2,undeploi:[6,33],undeploy:7,undeployment_fail:2,undeployment_in_progress:2,undeployment_success:2,under:[2,32],underli:[1,2],underscor:2,unicast:2,unicast_flooding_allow:2,uniform:2,uninstal:2,uninstall_fail:2,uninstall_in_progress:2,uninstall_success:2,uniqu:[1,2,26],unit:[2,25,37],unknown:[2,41],unknown_count:2,unknown_encap:2,unknown_st:2,unknown_typ:2,unkown:2,unlearn:2,unless:[2,6,21],unlik:2,unlimit:2,unlock:2,unmanag:2,unprepare_host:2,unqualifi:[2,26],unreach:2,unregist:[2,6],unrestrict:2,unset:[2,23],unsetpassword:23,unsetpassword_action_password:23,unspec:2,unspecifi:2,unstabl:2,until:[2,6,11,26],untrust:2,unus:2,up_count:2,up_port:2,updat:[1,2,6,9,15,21,23,25,26,27,32,37,38],update_0:2,update_memb:2,update_principal_identity_certificate_request:2,update_with_rul:2,updatecertif:2,updatemaintenancemod:1,updatemaintenancemode_action_enter_maintenance_mod:1,updatemaintenancemode_action_exit_maintenance_mod:1,updatemaintenancemode_action_forced_enter_maintenance_mod:1,updateprincipalidentitycertificaterequest:2,updatetag:2,updatetransportnodemaintenancemod:2,updatewithrul:2,upgrad:[0,1,2,26,30,33,42],upgrade_bundle_fetch_request:2,upgrade_bundle_file_nam:2,upgrade_cli:[0,1,42],upgrade_coordinator_upd:2,upgrade_coordinator_vers:2,upgrade_fail:2,upgrade_in_progress:2,upgrade_plan_set:37,upgrade_statu:2,upgrade_status_fail:2,upgrade_status_in_progress:2,upgrade_status_not_start:2,upgrade_status_paus:2,upgrade_status_start:2,upgrade_status_success:2,upgrade_unit:2,upgrade_unit_count:2,upgrade_unit_group:2,upgrade_unit_groups_cli:[0,1,2,42],upgrade_unit_id:[2,37],upgrade_unit_list:2,upgrade_unit_typ:2,upgrade_units_cli:[0,1,2,42],upgradebundlefetchrequest:2,upgradebundleid:2,upgradebundleinfo:2,upgradebundleuploadstatu:[2,37],upgradehistori:2,upgradehistorylist:2,upgradeinfra:2,upgrademc:1,upgradeplanset:[2,37],upgradeselectedunit:2,upgradestatu:2,upgradesummari:2,upgradeuc:1,upgradeunit:[2,37],upgradeunitaggregateinfo:2,upgradeunitaggregateinfolistresult:[2,37],upgradeunitgroup:2,upgradeunitgroupaggregateinfo:2,upgradeunitgroupaggregateinfolistresult:[2,37],upgradeunitgroupinfo:2,upgradeunitgrouplistresult:2,upgradeunitgroupsstatu:2,upgradeunitgroupstatu:2,upgradeunitgroupstatuslistresult:2,upgradeunitlist:2,upgradeunitlistresult:2,upgradeunitsstat:2,upgradeunitstatu:2,upgradeunitstatuslistresult:[2,37],upgradeunittypestat:2,upgradeunittypestatslist:2,uplink:[1,2],uplink_nam:[1,2],uplink_port:2,uplink_teaming_policy_nam:[1,2],uplink_typ:2,uplink_type_lag:2,uplink_type_pn:2,uplinkhostswitchprofil:[1,2],uplinkportmirrorsess:2,uplinkprofil:2,upload:[1,2,25,37],uploadstatu:[25,37],upmprofilelistresult:2,upon:2,upper:2,uppercas:2,upstream:2,upstream_serv:2,uptim:2,upto:2,upward:2,uri:[1,2,26],uri_argu:2,url:[1,2],urlalia:2,urpf_mod:2,urpf_mode_non:2,urpf_mode_strict:2,usabl:2,usag:[2,18],usage_count:2,use:[1,2,4,6,26,30,41],used:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,35,36,37,38,39,40],used_bi:2,used_protocol:2,used_protocol_ssl_v2:2,used_protocol_ssl_v3:2,used_protocol_tls_v1:2,used_protocol_tls_v1_1:2,used_protocol_tls_v1_2:2,used_ssl_ciph:2,used_ssl_cipher_ecdh_ecdsa_with_aes_128_cbc_sha256:2,used_ssl_cipher_ecdh_ecdsa_with_aes_128_cbc_sha:2,used_ssl_cipher_ecdh_ecdsa_with_aes_128_gcm_sha256:2,used_ssl_cipher_ecdh_ecdsa_with_aes_256_cbc_sha384:2,used_ssl_cipher_ecdh_ecdsa_with_aes_256_cbc_sha:2,used_ssl_cipher_ecdh_ecdsa_with_aes_256_gcm_sha384:2,used_ssl_cipher_ecdh_rsa_with_aes_128_cbc_sha256:2,used_ssl_cipher_ecdh_rsa_with_aes_128_cbc_sha:2,used_ssl_cipher_ecdh_rsa_with_aes_128_gcm_sha256:2,used_ssl_cipher_ecdh_rsa_with_aes_256_cbc_sha384:2,used_ssl_cipher_ecdh_rsa_with_aes_256_cbc_sha:2,used_ssl_cipher_ecdh_rsa_with_aes_256_gcm_sha384:2,used_ssl_cipher_ecdhe_ecdsa_with_aes_128_cbc_sha256:2,used_ssl_cipher_ecdhe_ecdsa_with_aes_128_cbc_sha:2,used_ssl_cipher_ecdhe_ecdsa_with_aes_128_gcm_sha256:2,used_ssl_cipher_ecdhe_ecdsa_with_aes_256_cbc_sha384:2,used_ssl_cipher_ecdhe_ecdsa_with_aes_256_cbc_sha:2,used_ssl_cipher_ecdhe_ecdsa_with_aes_256_gcm_sha384:2,used_ssl_cipher_ecdhe_rsa_with_aes_128_cbc_sha256:2,used_ssl_cipher_ecdhe_rsa_with_aes_128_cbc_sha:2,used_ssl_cipher_ecdhe_rsa_with_aes_128_gcm_sha256:2,used_ssl_cipher_ecdhe_rsa_with_aes_256_cbc_sha384:2,used_ssl_cipher_ecdhe_rsa_with_aes_256_cbc_sha:2,used_ssl_cipher_ecdhe_rsa_with_aes_256_gcm_sha384:2,used_ssl_cipher_rsa_with_3des_ede_cbc_sha:2,used_ssl_cipher_rsa_with_aes_128_cbc_sha256:2,used_ssl_cipher_rsa_with_aes_128_cbc_sha:2,used_ssl_cipher_rsa_with_aes_128_gcm_sha256:2,used_ssl_cipher_rsa_with_aes_256_cbc_sha256:2,used_ssl_cipher_rsa_with_aes_256_cbc_sha:2,used_ssl_cipher_rsa_with_aes_256_gcm_sha384:2,user:[1,2,3,6,21,26,30,37,38],user_defin:2,user_input_list:2,user_metadata:2,user_nam:2,user_set:2,userid:[2,26],userinfo:2,usernam:[2,3],usernamepasswordlogincredenti:2,users_cli:[0,1,2,42],uses:[1,2,26],using:[1,2,10,23,26,33],usual:2,utc:2,util:2,uucp:2,uuid:[1,2,9],v2c:2,valid:[1,2,26],valu:[1,2,6,7,8,9,11,13,14,15,16,18,19,20,21,22,23,24,25,26,32,35,36,37,38,39,40,41],value_abort:2,value_error:2,value_fail:2,value_initi:2,value_not_avail:2,value_not_start:2,value_run:2,value_success:2,value_suspend:2,value_suspended_by_us:2,value_suspended_for_user_act:2,vapi:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,35,36,37,38,39,40,41],vapiinterfac:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,35,36,37,38,39,40],vapistruct:[1,2,32,38],vari:2,variabl:[2,41],variable_nam:2,variable_valu:2,varialbe_nam:2,variou:[1,2],vc_cluster:2,vc_id:2,vc_ip:2,vc_password:2,vc_port:2,vc_usernam:2,vcenter:[1,2],vcpu:2,vcpu_usage_count:2,vdp:2,vdrport:2,vendor:2,vendor_id:2,verif:2,verifi:[1,2,26],verifiableasymmetriclogincredenti:2,version:[1,2,11,26,33,41],version_1_0:2,version_1_1:2,version_2_0:2,version__1_0:2,version__1_1:2,version__2_0:2,version_list:2,versioned_deployment_spec:2,versioneddeploymentspec:2,versionlist:2,versionwhitelist:2,vertic:2,via:[2,35],vib:2,vidm:[2,3,27,28],vidm_client:[0,1,2,26,27,42],vidm_en:2,vidminfo:2,vidminfolistresult:[2,3],view:[1,2],view_id:[1,2],viewabl:2,viewlist:[1,2],vif:[1,2],vif_typ:2,vif_type_child:2,vif_type_independ:2,vif_type_par:2,vif_uuid:2,vifattachmentcontext:2,vip:2,vipsubnet:2,virtual:[1,2,18,19],virtual_machin:[1,2],virtual_machine_tag_upd:2,virtual_serv:2,virtual_server_capac:2,virtual_server_id:[2,19],virtual_servers_cli:[0,1,2,18,42],virtualmachin:[1,2],virtualmachinelistresult:2,virtualmachinetagupd:2,virtualnetworkinterfac:2,virtualnetworkinterfacelistresult:2,virtualserv:2,virtualserviceinst:2,virut:2,visibl:2,visit:2,visual:2,viz:2,vlan:[1,2],vlan_id:2,vlan_rang:2,vlan_transport_zone_id:[1,2],vlan_trunk_spec:2,vlanmirrorsourc:2,vlantrunkspec:2,vm_clustering_fail:2,vm_clustering_in_progress:2,vm_clustering_success:2,vm_decluster_fail:2,vm_decluster_in_progress:2,vm_decluster_success:2,vm_deployment_config:2,vm_deployment_fail:2,vm_deployment_in_progress:2,vm_deployment_queu:2,vm_deployment_restart:2,vm_external_id:2,vm_id:[2,4],vm_local_id_on_host:2,vm_name:2,vm_nic_info:2,vm_online_fail:2,vm_port:2,vm_ports_stat:2,vm_power_off_fail:2,vm_power_off_in_progress:2,vm_power_on_fail:2,vm_power_on_in_progress:2,vm_run:2,vm_stop:2,vm_suspend:2,vm_tool:2,vm_tools_en:2,vm_undeploy_fail:2,vm_undeploy_in_progress:2,vm_undeploy_success:2,vm_usage_count:2,vm_vnic:2,vm_waiting_to_clust:2,vm_waiting_to_come_onlin:2,vmc:[1,2],vmc_local:2,vmc_url:1,vmcclient:1,vmcnsxclient:1,vmk0:2,vmk:[1,2],vmkernal:2,vmknic:2,vmktologicalswitchmap:2,vmnic:2,vmnicinfo:2,vmotion:2,vms:[2,5],vmware:[0,41,42],vni:[1,2],vni_pool:2,vnic:[1,2],vnic_migration_dest:1,vnipool:2,vnipoollistresult:2,vnirang:2,vpn:[0,1,2,42],vpn_session_id:2,vpnv4_unicast:2,vsan:2,vsphere:[1,2],vsphereclusternodevmdeploymentconfig:2,vspheredeploymentconfig:2,vtep_ip:2,vtep_label:2,vtep_mac_address:2,vtepcsvlistresult:2,vteplabelpool:2,vteplabelpoollistresult:2,vteplabelpoolusag:2,vteplabelrang:2,vteplistresult:2,vteptabl:2,vteptablecsvrecord:2,vteptableentri:2,vti:2,vulner:2,vxlan:2,vxstt:2,wai:[1,2],wait:2,waiting_to_register_vm:2,waiting_to_undeploy_vm:2,wan:2,want:[2,41],warn:2,warning_messag:2,warning_threshold:2,weak:2,web:2,websit:2,wednesdai:2,week:2,weekli:2,weeklybackupschedul:2,weeklytelemetryschedul:2,weight:2,weighted_least_connect:2,weighted_round_robin:2,well:[1,2],were:2,what:2,when:[1,2,11,26,30,41],where:[1,2,3,6,33],wherea:2,whether:[1,2,21,25,37],which:[1,2,3,4,5,6,9,15,18,21,23,24,25,26,30,31,32,33,36,37,38,41],white:2,white_list:2,white_list_provid:2,white_list_providers_lport_bind:2,white_list_providers_lswitch_bind:2,whitelist:2,who:2,whole:2,whose:[2,3,6],wich:2,widget:[1,2],widget_configur:2,widget_id:[1,2],widgetconfigur:2,widgetconfiguration_id:2,widgetconfigurationlist:2,widgetitem:2,window:2,wire:2,within:[1,2,25,37],withing:2,without:[2,37],won:[1,2],word:1,work:2,workflow:2,world:2,worst:1,would:[1,2,41],wrap:2,write:2,wrong:2,www:2,x509:2,x509certif:2,x509crl:2,x509crlentri:2,x_forwarded_for:2,xforwarded_for_insert:2,xforwarded_for_replac:2,xorp:2,xxd:2,xxxx:2,xyz:2,year:2,yellow:2,you:[1,2,26,41],your:[2,41],zebra:2,zero:2,zone:[1,2],zone_id:[1,2]},titles:["com package","com.vmware package","com.vmware.nsx package","com.vmware.nsx.aaa package","com.vmware.nsx.app_discovery package","com.vmware.nsx.app_discovery.sessions package","com.vmware.nsx.cluster package","com.vmware.nsx.cluster.nodes package","com.vmware.nsx.cluster.nodes.network package","com.vmware.nsx.dhcp package","com.vmware.nsx.dns package","com.vmware.nsx.fabric package","com.vmware.nsx.fabric.compute_collections package","com.vmware.nsx.fabric.nodes package","com.vmware.nsx.fabric.nodes.network package","com.vmware.nsx.firewall package","com.vmware.nsx.firewall.sections package","com.vmware.nsx.lldp package","com.vmware.nsx.loadbalancer package","com.vmware.nsx.loadbalancer.services package","com.vmware.nsx.logical_router_ports package","com.vmware.nsx.logical_routers package","com.vmware.nsx.logical_routers.nat package","com.vmware.nsx.logical_routers.routing package","com.vmware.nsx.logical_routers.routing.bgp package","com.vmware.nsx.migration package","com.vmware.nsx.node package","com.vmware.nsx.node.aaa package","com.vmware.nsx.node.aaa.providers package","com.vmware.nsx.node.network package","com.vmware.nsx.node.services package","com.vmware.nsx.pools package","com.vmware.nsx.serviceinsertion package","com.vmware.nsx.serviceinsertion.services package","com.vmware.nsx.serviceinsertion.services.service_instances package","com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes package","com.vmware.nsx.transport_nodes package","com.vmware.nsx.upgrade package","com.vmware.nsx.vpn package","com.vmware.nsx.vpn.ipsec package","com.vmware.nsx.vpn.l2vpn package","Interface definition language to python mapping for enumerated types","Welcome to NSX-T SDK\u2019s documentation!"],titleterms:{aaa:[3,27,28],aaa_client:[2,26],administration_cli:2,advertisement_cli:23,app_discoveri:[4,5],app_discovery_cli:2,backups_cli:6,bgp:24,bgp_client:23,bridge_clusters_cli:2,bridge_endpoints_cli:2,bundles_cli:[25,37],cluster:[6,7,8],cluster_cli:2,cluster_manager_cli:30,cm_inventory_cli:30,code:41,com:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40],compute_collect:12,compute_collection_transport_node_templates_cli:2,compute_managers_cli:11,configs_cli:2,definit:41,deployments_cli:7,dhcp:9,dhcp_client:2,dns:10,dns_client:2,document:[41,42],enumer:41,eula_cli:[2,37],exampl:41,fabric:[11,12,13,14],fabric_cli:2,file_store_cli:26,firewal:[15,16],firewall_cli:2,forwarders_cli:10,hardening_policy_cli:26,hpm_client:2,http_client:30,indic:42,install_upgrade_cli:30,instance_runtim:35,interfac:41,interfaces_cli:[8,14,29,35],ip_pools_cli:31,ipfix_cli:2,ipfix_obs_points_cli:2,ipsec:39,ipsec_cli:38,l2vpn:40,l2vpn_client:38,languag:41,liagent_cli:30,licenses_cli:2,lldp:17,loadbalanc:[18,19],loadbalancer_cli:2,logical_ports_cli:2,logical_rout:[21,22,23,24],logical_router_port:20,logical_router_ports_cli:2,logical_routers_cli:2,logical_switches_cli:2,mac_sets_cli:2,manager_cli:30,map:41,md_proxies_cli:2,mgmt_plane_bus_cli:30,migrat:25,migration_cli:2,migration_unit_groups_cli:25,migration_units_cli:25,model_cli:2,modul:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,35,36,37,38,39,40],nat:22,nat_client:21,neighbors_cli:24,network:[8,14,29],network_cli:[7,12,13,26],node:[7,8,13,14,26,27,28,29,30],node_cli:2,node_mgmt_cli:30,nodes_cli:[6,11],ns_groups_client:[2,5],nsx:[2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,42],nsx_client:1,nsx_client_for_vmc:1,nsx_message_bus_cli:30,nsx_upgrade_agent_cli:30,ntp_client:30,packag:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40],pktcap_client:2,plan_client:[25,37],pool:31,pools_client:[2,19],provid:28,providers_cli:27,python:41,realization_state_barrier_cli:2,redistribution_cli:23,repo_sync_cli:7,restore_cli:6,rout:[23,24],routing_cli:21,rules_cli:[15,16,22],sdk:42,search_client:30,section:16,sections_cli:[15,32],servers_cli:9,servic:[19,30,33,34,35],service_inst:[34,35],service_instances_cli:33,serviceinsert:[32,33,34,35],serviceinsertion_cli:2,services_cli:[18,26,32,38],session:5,sessions_cli:[4,39,40],snmp_client:30,ssh_client:30,ssl_client:18,static_routes_cli:23,statistics_cli:[20,36],submodul:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,35,36,37,38,39,40],subpackag:[0,1,2,4,6,7,11,13,15,18,21,23,26,27,32,33,34,38],switching_profiles_cli:2,syslog_cli:30,tabl:42,tasks_client:[2,26],telemetry_cli:[2,30],traceflows_cli:2,transport_nod:36,transport_nodes_cli:[2,17],transport_zones_cli:2,trust_management_cli:2,type:41,ui_service_cli:30,ui_views_cli:2,upgrad:37,upgrade_cli:2,upgrade_unit_groups_cli:37,upgrade_units_cli:37,users_cli:26,vidm_client:[3,28],virtual_servers_cli:19,vmware:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40],vpn:[38,39,40],welcom:42}}) \ No newline at end of file diff --git a/nsx/nsx_policy/.buildinfo b/nsx/nsx_policy/.buildinfo index cb8881de..ed8d5219 100644 --- a/nsx/nsx_policy/.buildinfo +++ b/nsx/nsx_policy/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: d118d18c2744cfeda73360c7342d3ffb +config: 0d7ef7ae45469da7b7faa958be6007d1 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/nsx/nsx_policy/.doctrees/com.doctree b/nsx/nsx_policy/.doctrees/com.doctree index 8704256d..feb24020 100644 Binary files a/nsx/nsx_policy/.doctrees/com.doctree and b/nsx/nsx_policy/.doctrees/com.doctree differ diff --git a/nsx/nsx_policy/.doctrees/com.vmware.doctree b/nsx/nsx_policy/.doctrees/com.vmware.doctree index 69edd6bb..c44707f2 100644 Binary files a/nsx/nsx_policy/.doctrees/com.vmware.doctree and b/nsx/nsx_policy/.doctrees/com.vmware.doctree differ diff --git a/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.aaa.doctree b/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.aaa.doctree index 8000c6c1..d2af3993 100644 Binary files a/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.aaa.doctree and b/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.aaa.doctree differ diff --git a/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.cluster.doctree b/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.cluster.doctree index afc6ad8b..1f6e3c85 100644 Binary files a/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.cluster.doctree and b/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.cluster.doctree differ diff --git a/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.doctree b/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.doctree index 235a8678..e7aa4ba3 100644 Binary files a/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.doctree and b/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.doctree differ diff --git a/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.infra.doctree b/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.infra.doctree index 8c94632c..44ce8635 100644 Binary files a/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.infra.doctree and b/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.infra.doctree differ diff --git a/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.infra.domains.doctree b/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.infra.domains.doctree index 795df099..4ce80b84 100644 Binary files a/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.infra.domains.doctree and b/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.infra.domains.doctree differ diff --git a/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.infra.domains.groups.doctree b/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.infra.domains.groups.doctree index 35428075..048d735d 100644 Binary files a/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.infra.domains.groups.doctree and b/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.infra.domains.groups.doctree differ diff --git a/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.infra.networks.doctree b/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.infra.networks.doctree deleted file mode 100644 index d8d23d0d..00000000 Binary files a/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.infra.networks.doctree and /dev/null differ diff --git a/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.infra.providers.doctree b/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.infra.providers.doctree deleted file mode 100644 index fa82b55d..00000000 Binary files a/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.infra.providers.doctree and /dev/null differ diff --git a/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.infra.providers.l2vpn_context.doctree b/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.infra.providers.l2vpn_context.doctree deleted file mode 100644 index be5c4504..00000000 Binary files a/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.infra.providers.l2vpn_context.doctree and /dev/null differ diff --git a/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.infra.realized_state.doctree b/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.infra.realized_state.doctree index 75b139fc..b88d6bb0 100644 Binary files a/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.infra.realized_state.doctree and b/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.infra.realized_state.doctree differ diff --git a/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.infra.realized_state.enforcement_points.doctree b/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.infra.realized_state.enforcement_points.doctree index deec9b84..9566fce8 100644 Binary files a/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.infra.realized_state.enforcement_points.doctree and b/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.infra.realized_state.enforcement_points.doctree differ diff --git a/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.infra.realized_state.enforcement_points.ops.doctree b/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.infra.realized_state.enforcement_points.ops.doctree index 2c90d74f..61d7b84e 100644 Binary files a/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.infra.realized_state.enforcement_points.ops.doctree and b/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.infra.realized_state.enforcement_points.ops.doctree differ diff --git a/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.infra.tier_0s.doctree b/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.infra.tier_0s.doctree new file mode 100644 index 00000000..a36107ce Binary files /dev/null and b/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.infra.tier_0s.doctree differ diff --git a/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.infra.tier_0s.locale_services.doctree b/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.infra.tier_0s.locale_services.doctree new file mode 100644 index 00000000..f32fe22e Binary files /dev/null and b/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.infra.tier_0s.locale_services.doctree differ diff --git a/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.doctree b/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.doctree new file mode 100644 index 00000000..3382a77e Binary files /dev/null and b/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.doctree differ diff --git a/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.infra.tier_1s.doctree b/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.infra.tier_1s.doctree new file mode 100644 index 00000000..7cb98d2d Binary files /dev/null and b/nsx/nsx_policy/.doctrees/com.vmware.nsx_policy.infra.tier_1s.doctree differ diff --git a/nsx/nsx_policy/.doctrees/enumeration.doctree b/nsx/nsx_policy/.doctrees/enumeration.doctree index 809c834b..54c2376d 100644 Binary files a/nsx/nsx_policy/.doctrees/enumeration.doctree and b/nsx/nsx_policy/.doctrees/enumeration.doctree differ diff --git a/nsx/nsx_policy/.doctrees/environment.pickle b/nsx/nsx_policy/.doctrees/environment.pickle index 2068ef2e..543f8c7c 100644 Binary files a/nsx/nsx_policy/.doctrees/environment.pickle and b/nsx/nsx_policy/.doctrees/environment.pickle differ diff --git a/nsx/nsx_policy/.doctrees/index.doctree b/nsx/nsx_policy/.doctrees/index.doctree index 1a8a112b..6e861864 100644 Binary files a/nsx/nsx_policy/.doctrees/index.doctree and b/nsx/nsx_policy/.doctrees/index.doctree differ diff --git a/nsx/nsx_policy/_sources/com.vmware.nsx_policy.infra.domains.groups.rst.txt b/nsx/nsx_policy/_sources/com.vmware.nsx_policy.infra.domains.groups.rst.txt index a5da4c53..774a3aaa 100644 --- a/nsx/nsx_policy/_sources/com.vmware.nsx_policy.infra.domains.groups.rst.txt +++ b/nsx/nsx_policy/_sources/com.vmware.nsx_policy.infra.domains.groups.rst.txt @@ -9,6 +9,14 @@ com.vmware.nsx\_policy.infra.domains.groups package Submodules ---------- +com.vmware.nsx\_policy.infra.domains.groups.members\_client module +------------------------------------------------------------------ + +.. automodule:: com.vmware.nsx_policy.infra.domains.groups.members_client + :members: + :undoc-members: + :show-inheritance: + com.vmware.nsx\_policy.infra.domains.groups.statistics\_client module --------------------------------------------------------------------- diff --git a/nsx/nsx_policy/_sources/com.vmware.nsx_policy.infra.domains.rst.txt b/nsx/nsx_policy/_sources/com.vmware.nsx_policy.infra.domains.rst.txt index 2a0d6577..0c16c192 100644 --- a/nsx/nsx_policy/_sources/com.vmware.nsx_policy.infra.domains.rst.txt +++ b/nsx/nsx_policy/_sources/com.vmware.nsx_policy.infra.domains.rst.txt @@ -24,10 +24,10 @@ com.vmware.nsx\_policy.infra.domains.communication\_maps\_client module :undoc-members: :show-inheritance: -com.vmware.nsx\_policy.infra.domains.edge\_communication\_maps\_client module ------------------------------------------------------------------------------ +com.vmware.nsx\_policy.infra.domains.gateway\_policies\_client module +--------------------------------------------------------------------- -.. automodule:: com.vmware.nsx_policy.infra.domains.edge_communication_maps_client +.. automodule:: com.vmware.nsx_policy.infra.domains.gateway_policies_client :members: :undoc-members: :show-inheritance: @@ -40,10 +40,10 @@ com.vmware.nsx\_policy.infra.domains.groups\_client module :undoc-members: :show-inheritance: -com.vmware.nsx\_policy.infra.domains.redirection\_communication\_maps\_client module ------------------------------------------------------------------------------------- +com.vmware.nsx\_policy.infra.domains.redirection\_policies\_client module +------------------------------------------------------------------------- -.. automodule:: com.vmware.nsx_policy.infra.domains.redirection_communication_maps_client +.. automodule:: com.vmware.nsx_policy.infra.domains.redirection_policies_client :members: :undoc-members: :show-inheritance: diff --git a/nsx/nsx_policy/_sources/com.vmware.nsx_policy.infra.providers.l2vpn_context.rst.txt b/nsx/nsx_policy/_sources/com.vmware.nsx_policy.infra.providers.l2vpn_context.rst.txt deleted file mode 100644 index f66fe8e0..00000000 --- a/nsx/nsx_policy/_sources/com.vmware.nsx_policy.infra.providers.l2vpn_context.rst.txt +++ /dev/null @@ -1,20 +0,0 @@ -com.vmware.nsx\_policy.infra.providers.l2vpn\_context package -============================================================= - -.. automodule:: com.vmware.nsx_policy.infra.providers.l2vpn_context - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -com.vmware.nsx\_policy.infra.providers.l2vpn\_context.l2vpns\_client module ---------------------------------------------------------------------------- - -.. automodule:: com.vmware.nsx_policy.infra.providers.l2vpn_context.l2vpns_client - :members: - :undoc-members: - :show-inheritance: - - diff --git a/nsx/nsx_policy/_sources/com.vmware.nsx_policy.infra.providers.rst.txt b/nsx/nsx_policy/_sources/com.vmware.nsx_policy.infra.providers.rst.txt deleted file mode 100644 index 1598f6c7..00000000 --- a/nsx/nsx_policy/_sources/com.vmware.nsx_policy.infra.providers.rst.txt +++ /dev/null @@ -1,51 +0,0 @@ -com.vmware.nsx\_policy.infra.providers package -============================================== - -.. automodule:: com.vmware.nsx_policy.infra.providers - :members: - :undoc-members: - :show-inheritance: - -Subpackages ------------ - -.. toctree:: - - com.vmware.nsx_policy.infra.providers.l2vpn_context - -Submodules ----------- - -com.vmware.nsx\_policy.infra.providers.bgp\_client module ---------------------------------------------------------- - -.. automodule:: com.vmware.nsx_policy.infra.providers.bgp_client - :members: - :undoc-members: - :show-inheritance: - -com.vmware.nsx\_policy.infra.providers.l2vpn\_context\_client module --------------------------------------------------------------------- - -.. automodule:: com.vmware.nsx_policy.infra.providers.l2vpn_context_client - :members: - :undoc-members: - :show-inheritance: - -com.vmware.nsx\_policy.infra.providers.l3vpns\_client module ------------------------------------------------------------- - -.. automodule:: com.vmware.nsx_policy.infra.providers.l3vpns_client - :members: - :undoc-members: - :show-inheritance: - -com.vmware.nsx\_policy.infra.providers.service\_instances\_client module ------------------------------------------------------------------------- - -.. automodule:: com.vmware.nsx_policy.infra.providers.service_instances_client - :members: - :undoc-members: - :show-inheritance: - - diff --git a/nsx/nsx_policy/_sources/com.vmware.nsx_policy.infra.rst.txt b/nsx/nsx_policy/_sources/com.vmware.nsx_policy.infra.rst.txt index f5c30e2c..93329e84 100644 --- a/nsx/nsx_policy/_sources/com.vmware.nsx_policy.infra.rst.txt +++ b/nsx/nsx_policy/_sources/com.vmware.nsx_policy.infra.rst.txt @@ -12,9 +12,9 @@ Subpackages .. toctree:: com.vmware.nsx_policy.infra.domains - com.vmware.nsx_policy.infra.networks - com.vmware.nsx_policy.infra.providers com.vmware.nsx_policy.infra.realized_state + com.vmware.nsx_policy.infra.tier_0s + com.vmware.nsx_policy.infra.tier_1s Submodules ---------- @@ -35,14 +35,6 @@ com.vmware.nsx\_policy.infra.domains\_client module :undoc-members: :show-inheritance: -com.vmware.nsx\_policy.infra.networks\_client module ----------------------------------------------------- - -.. automodule:: com.vmware.nsx_policy.infra.networks_client - :members: - :undoc-members: - :show-inheritance: - com.vmware.nsx\_policy.infra.partner\_services\_client module ------------------------------------------------------------- @@ -51,14 +43,6 @@ com.vmware.nsx\_policy.infra.partner\_services\_client module :undoc-members: :show-inheritance: -com.vmware.nsx\_policy.infra.providers\_client module ------------------------------------------------------ - -.. automodule:: com.vmware.nsx_policy.infra.providers_client - :members: - :undoc-members: - :show-inheritance: - com.vmware.nsx\_policy.infra.realized\_state\_client module ----------------------------------------------------------- @@ -75,4 +59,20 @@ com.vmware.nsx\_policy.infra.services\_client module :undoc-members: :show-inheritance: +com.vmware.nsx\_policy.infra.tier\_0s\_client module +---------------------------------------------------- + +.. automodule:: com.vmware.nsx_policy.infra.tier_0s_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx\_policy.infra.tier\_1s\_client module +---------------------------------------------------- + +.. automodule:: com.vmware.nsx_policy.infra.tier_1s_client + :members: + :undoc-members: + :show-inheritance: + diff --git a/nsx/nsx_policy/_sources/com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.rst.txt b/nsx/nsx_policy/_sources/com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.rst.txt new file mode 100644 index 00000000..3c63f190 --- /dev/null +++ b/nsx/nsx_policy/_sources/com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.rst.txt @@ -0,0 +1,20 @@ +com.vmware.nsx\_policy.infra.tier\_0s.locale\_services.l2vpn\_context package +============================================================================= + +.. automodule:: com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.nsx\_policy.infra.tier\_0s.locale\_services.l2vpn\_context.l2vpns\_client module +------------------------------------------------------------------------------------------- + +.. automodule:: com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.l2vpns_client + :members: + :undoc-members: + :show-inheritance: + + diff --git a/nsx/nsx_policy/_sources/com.vmware.nsx_policy.infra.tier_0s.locale_services.rst.txt b/nsx/nsx_policy/_sources/com.vmware.nsx_policy.infra.tier_0s.locale_services.rst.txt new file mode 100644 index 00000000..d0d2c5af --- /dev/null +++ b/nsx/nsx_policy/_sources/com.vmware.nsx_policy.infra.tier_0s.locale_services.rst.txt @@ -0,0 +1,59 @@ +com.vmware.nsx\_policy.infra.tier\_0s.locale\_services package +============================================================== + +.. automodule:: com.vmware.nsx_policy.infra.tier_0s.locale_services + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context + +Submodules +---------- + +com.vmware.nsx\_policy.infra.tier\_0s.locale\_services.bgp\_client module +------------------------------------------------------------------------- + +.. automodule:: com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx\_policy.infra.tier\_0s.locale\_services.byod\_service\_instances\_client module +---------------------------------------------------------------------------------------------- + +.. automodule:: com.vmware.nsx_policy.infra.tier_0s.locale_services.byod_service_instances_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx\_policy.infra.tier\_0s.locale\_services.endpoints\_client module +------------------------------------------------------------------------------- + +.. automodule:: com.vmware.nsx_policy.infra.tier_0s.locale_services.endpoints_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx\_policy.infra.tier\_0s.locale\_services.l2vpn\_context\_client module +------------------------------------------------------------------------------------ + +.. automodule:: com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.nsx\_policy.infra.tier\_0s.locale\_services.l3vpns\_client module +---------------------------------------------------------------------------- + +.. automodule:: com.vmware.nsx_policy.infra.tier_0s.locale_services.l3vpns_client + :members: + :undoc-members: + :show-inheritance: + + diff --git a/nsx/nsx_policy/_sources/com.vmware.nsx_policy.infra.tier_0s.rst.txt b/nsx/nsx_policy/_sources/com.vmware.nsx_policy.infra.tier_0s.rst.txt new file mode 100644 index 00000000..7641430d --- /dev/null +++ b/nsx/nsx_policy/_sources/com.vmware.nsx_policy.infra.tier_0s.rst.txt @@ -0,0 +1,27 @@ +com.vmware.nsx\_policy.infra.tier\_0s package +============================================= + +.. automodule:: com.vmware.nsx_policy.infra.tier_0s + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + com.vmware.nsx_policy.infra.tier_0s.locale_services + +Submodules +---------- + +com.vmware.nsx\_policy.infra.tier\_0s.locale\_services\_client module +--------------------------------------------------------------------- + +.. automodule:: com.vmware.nsx_policy.infra.tier_0s.locale_services_client + :members: + :undoc-members: + :show-inheritance: + + diff --git a/nsx/nsx_policy/_sources/com.vmware.nsx_policy.infra.networks.rst.txt b/nsx/nsx_policy/_sources/com.vmware.nsx_policy.infra.tier_1s.rst.txt similarity index 51% rename from nsx/nsx_policy/_sources/com.vmware.nsx_policy.infra.networks.rst.txt rename to nsx/nsx_policy/_sources/com.vmware.nsx_policy.infra.tier_1s.rst.txt index 149a8e0e..31eb8f53 100644 --- a/nsx/nsx_policy/_sources/com.vmware.nsx_policy.infra.networks.rst.txt +++ b/nsx/nsx_policy/_sources/com.vmware.nsx_policy.infra.tier_1s.rst.txt @@ -1,7 +1,7 @@ -com.vmware.nsx\_policy.infra.networks package +com.vmware.nsx\_policy.infra.tier\_1s package ============================================= -.. automodule:: com.vmware.nsx_policy.infra.networks +.. automodule:: com.vmware.nsx_policy.infra.tier_1s :members: :undoc-members: :show-inheritance: @@ -9,18 +9,18 @@ com.vmware.nsx\_policy.infra.networks package Submodules ---------- -com.vmware.nsx\_policy.infra.networks.nat\_client module +com.vmware.nsx\_policy.infra.tier\_1s.nat\_client module -------------------------------------------------------- -.. automodule:: com.vmware.nsx_policy.infra.networks.nat_client +.. automodule:: com.vmware.nsx_policy.infra.tier_1s.nat_client :members: :undoc-members: :show-inheritance: -com.vmware.nsx\_policy.infra.networks.segments\_client module +com.vmware.nsx\_policy.infra.tier\_1s.segments\_client module ------------------------------------------------------------- -.. automodule:: com.vmware.nsx_policy.infra.networks.segments_client +.. automodule:: com.vmware.nsx_policy.infra.tier_1s.segments_client :members: :undoc-members: :show-inheritance: diff --git a/nsx/nsx_policy/_sources/com.vmware.nsx_policy.rst.txt b/nsx/nsx_policy/_sources/com.vmware.nsx_policy.rst.txt index de5d6ad5..71ccb826 100644 --- a/nsx/nsx_policy/_sources/com.vmware.nsx_policy.rst.txt +++ b/nsx/nsx_policy/_sources/com.vmware.nsx_policy.rst.txt @@ -90,6 +90,14 @@ com.vmware.nsx\_policy.tasks\_client module :undoc-members: :show-inheritance: +com.vmware.nsx\_policy.telemetry\_client module +----------------------------------------------- + +.. automodule:: com.vmware.nsx_policy.telemetry_client + :members: + :undoc-members: + :show-inheritance: + com.vmware.nsx\_policy.trust\_management\_client module ------------------------------------------------------- diff --git a/nsx/nsx_policy/_sources/com.vmware.rst.txt b/nsx/nsx_policy/_sources/com.vmware.rst.txt index 2ecf966f..d199cf63 100644 --- a/nsx/nsx_policy/_sources/com.vmware.rst.txt +++ b/nsx/nsx_policy/_sources/com.vmware.rst.txt @@ -24,4 +24,12 @@ com.vmware.nsx\_policy\_client module :undoc-members: :show-inheritance: +com.vmware.nsx\_policy\_client\_for\_vmc module +----------------------------------------------- + +.. automodule:: com.vmware.nsx_policy_client_for_vmc + :members: + :undoc-members: + :show-inheritance: + diff --git a/nsx/nsx_policy/_sources/index.rst.txt b/nsx/nsx_policy/_sources/index.rst.txt index 5c02889f..fa7bd997 100644 --- a/nsx/nsx_policy/_sources/index.rst.txt +++ b/nsx/nsx_policy/_sources/index.rst.txt @@ -1,5 +1,5 @@ .. NSX-T Policy SDK documentation master file, created by - sphinx-quickstart on Mon Apr 30 15:58:55 2018. + sphinx-quickstart on Fri Oct 26 14:25:30 2018. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. diff --git a/nsx/nsx_policy/_static/basic.css b/nsx/nsx_policy/_static/basic.css index 19ced105..104f076a 100644 --- a/nsx/nsx_policy/_static/basic.css +++ b/nsx/nsx_policy/_static/basic.css @@ -81,6 +81,10 @@ div.sphinxsidebar input { font-size: 1em; } +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + div.sphinxsidebar #searchbox input[type="text"] { float: left; width: 80%; @@ -427,6 +431,13 @@ table.field-list td, table.field-list th { hyphens: manual; } +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist td { + vertical-align: top; +} + + /* -- other body styles ----------------------------------------------------- */ ol.arabic { diff --git a/nsx/nsx_policy/_static/css/badge_only.css b/nsx/nsx_policy/_static/css/badge_only.css index 012e63fe..323730ae 100644 --- a/nsx/nsx_policy/_static/css/badge_only.css +++ b/nsx/nsx_policy/_static/css/badge_only.css @@ -1 +1 @@ -.fa:before{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:before,.clearfix:after{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-weight:normal;font-style:normal;src:url("../fonts/fontawesome-webfont.eot");src:url("../fonts/fontawesome-webfont.eot?#iefix") format("embedded-opentype"),url("../fonts/fontawesome-webfont.woff") format("woff"),url("../fonts/fontawesome-webfont.ttf") format("truetype"),url("../fonts/fontawesome-webfont.svg#FontAwesome") format("svg")}.fa:before{display:inline-block;font-family:FontAwesome;font-style:normal;font-weight:normal;line-height:1;text-decoration:inherit}a .fa{display:inline-block;text-decoration:inherit}li .fa{display:inline-block}li .fa-large:before,li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-0.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before,ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before{content:""}.icon-book:before{content:""}.fa-caret-down:before{content:""}.icon-caret-down:before{content:""}.fa-caret-up:before{content:""}.icon-caret-up:before{content:""}.fa-caret-left:before{content:""}.icon-caret-left:before{content:""}.fa-caret-right:before{content:""}.icon-caret-right:before{content:""}.rst-versions{position:fixed;bottom:0;left:0;overflow-y:scroll;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;z-index:400}.rst-versions a{color:#2980B9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27AE60;*zoom:1}.rst-versions .rst-current-version:before,.rst-versions .rst-current-version:after{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book{float:left}.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#E74C3C;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#F1C40F;color:#000}.rst-versions.shift-up{max-height:100%}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:gray;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:solid 1px #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px}.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge .fa-book{float:none}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book{float:left}.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge .rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width: 768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} +.fa:before{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:before,.clearfix:after{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-weight:normal;font-style:normal;src:url("../fonts/fontawesome-webfont.eot");src:url("../fonts/fontawesome-webfont.eot?#iefix") format("embedded-opentype"),url("../fonts/fontawesome-webfont.woff") format("woff"),url("../fonts/fontawesome-webfont.ttf") format("truetype"),url("../fonts/fontawesome-webfont.svg#FontAwesome") format("svg")}.fa:before{display:inline-block;font-family:FontAwesome;font-style:normal;font-weight:normal;line-height:1;text-decoration:inherit}a .fa{display:inline-block;text-decoration:inherit}li .fa{display:inline-block}li .fa-large:before,li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-0.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before,ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before{content:""}.icon-book:before{content:""}.fa-caret-down:before{content:""}.icon-caret-down:before{content:""}.fa-caret-up:before{content:""}.icon-caret-up:before{content:""}.fa-caret-left:before{content:""}.icon-caret-left:before{content:""}.fa-caret-right:before{content:""}.icon-caret-right:before{content:""}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;z-index:400}.rst-versions a{color:#2980B9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27AE60;*zoom:1}.rst-versions .rst-current-version:before,.rst-versions .rst-current-version:after{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book{float:left}.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#E74C3C;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#F1C40F;color:#000}.rst-versions.shift-up{height:auto;max-height:100%}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:gray;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:solid 1px #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px}.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge .fa-book{float:none}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book{float:left}.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge .rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width: 768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} diff --git a/nsx/nsx_policy/_static/css/theme.css b/nsx/nsx_policy/_static/css/theme.css index d85a101f..b19dbfe5 100644 --- a/nsx/nsx_policy/_static/css/theme.css +++ b/nsx/nsx_policy/_static/css/theme.css @@ -1,4 +1,6 @@ -*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}audio:not([controls]){display:none}[hidden]{display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:hover,a:active{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:bold}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;color:#000;text-decoration:none}mark{background:#ff0;color:#000;font-style:italic;font-weight:bold}pre,code,.rst-content tt,.rst-content code,kbd,samp{font-family:monospace,serif;_font-family:"courier new",monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:before,q:after{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-0.5em}sub{bottom:-0.25em}ul,ol,dl{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure{margin:0}form{margin:0}fieldset{border:0;margin:0;padding:0}label{cursor:pointer}legend{border:0;*margin-left:-7px;padding:0;white-space:normal}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type="button"],input[type="reset"],input[type="submit"]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0;*width:13px;*height:13px}input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}input[type="search"]::-webkit-search-decoration,input[type="search"]::-webkit-search-cancel-button{-webkit-appearance:none}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}textarea{overflow:auto;vertical-align:top;resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none !important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{html,body,section{background:none !important}*{box-shadow:none !important;text-shadow:none !important;filter:none !important;-ms-filter:none !important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:.5cm}p,h2,.rst-content .toctree-wrapper p.caption,h3{orphans:3;widows:3}h2,.rst-content .toctree-wrapper p.caption,h3{page-break-after:avoid}}.fa:before,.wy-menu-vertical li span.toctree-expand:before,.wy-menu-vertical li.on a span.toctree-expand:before,.wy-menu-vertical li.current>a span.toctree-expand:before,.rst-content .admonition-title:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content dl dt .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.rst-content code.download span:first-child:before,.icon:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-alert,.rst-content .note,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .warning,.rst-content .seealso,.rst-content .admonition-todo,.rst-content .admonition,.btn,input[type="text"],input[type="password"],input[type="email"],input[type="url"],input[type="date"],input[type="month"],input[type="time"],input[type="datetime"],input[type="datetime-local"],input[type="week"],input[type="number"],input[type="search"],input[type="tel"],input[type="color"],select,textarea,.wy-menu-vertical li.on a,.wy-menu-vertical li.current>a,.wy-side-nav-search>a,.wy-side-nav-search .wy-dropdown>a,.wy-nav-top a{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:before,.clearfix:after{display:table;content:""}.clearfix:after{clear:both}/*! +/* sphinx_rtd_theme version 0.4.2 | MIT license */ +/* Built 20181005 13:10 */ +*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}audio:not([controls]){display:none}[hidden]{display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:hover,a:active{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:bold}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;color:#000;text-decoration:none}mark{background:#ff0;color:#000;font-style:italic;font-weight:bold}pre,code,.rst-content tt,.rst-content code,kbd,samp{font-family:monospace,serif;_font-family:"courier new",monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:before,q:after{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-0.5em}sub{bottom:-0.25em}ul,ol,dl{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure{margin:0}form{margin:0}fieldset{border:0;margin:0;padding:0}label{cursor:pointer}legend{border:0;*margin-left:-7px;padding:0;white-space:normal}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type="button"],input[type="reset"],input[type="submit"]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0;*width:13px;*height:13px}input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}input[type="search"]::-webkit-search-decoration,input[type="search"]::-webkit-search-cancel-button{-webkit-appearance:none}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}textarea{overflow:auto;vertical-align:top;resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none !important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{html,body,section{background:none !important}*{box-shadow:none !important;text-shadow:none !important;filter:none !important;-ms-filter:none !important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:.5cm}p,h2,.rst-content .toctree-wrapper p.caption,h3{orphans:3;widows:3}h2,.rst-content .toctree-wrapper p.caption,h3{page-break-after:avoid}}.fa:before,.wy-menu-vertical li span.toctree-expand:before,.wy-menu-vertical li.on a span.toctree-expand:before,.wy-menu-vertical li.current>a span.toctree-expand:before,.rst-content .admonition-title:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content dl dt .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.rst-content code.download span:first-child:before,.icon:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-alert,.rst-content .note,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .warning,.rst-content .seealso,.rst-content .admonition-todo,.rst-content .admonition,.btn,input[type="text"],input[type="password"],input[type="email"],input[type="url"],input[type="date"],input[type="month"],input[type="time"],input[type="datetime"],input[type="datetime-local"],input[type="week"],input[type="number"],input[type="search"],input[type="tel"],input[type="color"],select,textarea,.wy-menu-vertical li.on a,.wy-menu-vertical li.current>a,.wy-side-nav-search>a,.wy-side-nav-search .wy-dropdown>a,.wy-nav-top a{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:before,.clearfix:after{display:table;content:""}.clearfix:after{clear:both}/*! * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) - */@font-face{font-family:'FontAwesome';src:url("../fonts/fontawesome-webfont.eot?v=4.7.0");src:url("../fonts/fontawesome-webfont.eot?#iefix&v=4.7.0") format("embedded-opentype"),url("../fonts/fontawesome-webfont.woff2?v=4.7.0") format("woff2"),url("../fonts/fontawesome-webfont.woff?v=4.7.0") format("woff"),url("../fonts/fontawesome-webfont.ttf?v=4.7.0") format("truetype"),url("../fonts/fontawesome-webfont.svg?v=4.7.0#fontawesomeregular") format("svg");font-weight:normal;font-style:normal}.fa,.wy-menu-vertical li span.toctree-expand,.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li.current>a span.toctree-expand,.rst-content .admonition-title,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content dl dt .headerlink,.rst-content p.caption .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.rst-content code.download span:first-child,.icon{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.3333333333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.2857142857em;text-align:center}.fa-ul{padding-left:0;margin-left:2.1428571429em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.1428571429em;width:2.1428571429em;top:.1428571429em;text-align:center}.fa-li.fa-lg{left:-1.8571428571em}.fa-border{padding:.2em .25em .15em;border:solid 0.08em #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa.fa-pull-left,.wy-menu-vertical li span.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a span.fa-pull-left.toctree-expand,.wy-menu-vertical li.current>a span.fa-pull-left.toctree-expand,.rst-content .fa-pull-left.admonition-title,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content dl dt .fa-pull-left.headerlink,.rst-content p.caption .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.rst-content code.download span.fa-pull-left:first-child,.fa-pull-left.icon{margin-right:.3em}.fa.fa-pull-right,.wy-menu-vertical li span.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a span.fa-pull-right.toctree-expand,.wy-menu-vertical li.current>a span.fa-pull-right.toctree-expand,.rst-content .fa-pull-right.admonition-title,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content dl dt .fa-pull-right.headerlink,.rst-content p.caption .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.rst-content code.download span.fa-pull-right:first-child,.fa-pull-right.icon{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.wy-menu-vertical li span.pull-left.toctree-expand,.wy-menu-vertical li.on a span.pull-left.toctree-expand,.wy-menu-vertical li.current>a span.pull-left.toctree-expand,.rst-content .pull-left.admonition-title,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content dl dt .pull-left.headerlink,.rst-content p.caption .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.rst-content code.download span.pull-left:first-child,.pull-left.icon{margin-right:.3em}.fa.pull-right,.wy-menu-vertical li span.pull-right.toctree-expand,.wy-menu-vertical li.on a span.pull-right.toctree-expand,.wy-menu-vertical li.current>a span.pull-right.toctree-expand,.rst-content .pull-right.admonition-title,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content dl dt .pull-right.headerlink,.rst-content p.caption .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.rst-content code.download span.pull-right:first-child,.pull-right.icon{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s infinite linear;animation:fa-spin 2s infinite linear}.fa-pulse{-webkit-animation:fa-spin 1s infinite steps(8);animation:fa-spin 1s infinite steps(8)}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scale(-1, 1);-ms-transform:scale(-1, 1);transform:scale(-1, 1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scale(1, -1);-ms-transform:scale(1, -1);transform:scale(1, -1)}:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270,:root .fa-flip-horizontal,:root .fa-flip-vertical{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-remove:before,.fa-close:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-gear:before,.fa-cog:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content tt.download span:first-child:before,.rst-content code.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-rotate-right:before,.fa-repeat:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-photo:before,.fa-image:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.rst-content .admonition-title:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-warning:before,.fa-exclamation-triangle:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-gears:before,.fa-cogs:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-save:before,.fa-floppy-o:before{content:""}.fa-square:before{content:""}.fa-navicon:before,.fa-reorder:before,.fa-bars:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.wy-dropdown .caret:before,.icon-caret-down:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-unsorted:before,.fa-sort:before{content:""}.fa-sort-down:before,.fa-sort-desc:before{content:""}.fa-sort-up:before,.fa-sort-asc:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-legal:before,.fa-gavel:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-flash:before,.fa-bolt:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-paste:before,.fa-clipboard:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-unlink:before,.fa-chain-broken:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.on a span.toctree-expand:before,.wy-menu-vertical li.current>a span.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-toggle-down:before,.fa-caret-square-o-down:before{content:""}.fa-toggle-up:before,.fa-caret-square-o-up:before{content:""}.fa-toggle-right:before,.fa-caret-square-o-right:before{content:""}.fa-euro:before,.fa-eur:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-rupee:before,.fa-inr:before{content:""}.fa-cny:before,.fa-rmb:before,.fa-yen:before,.fa-jpy:before{content:""}.fa-ruble:before,.fa-rouble:before,.fa-rub:before{content:""}.fa-won:before,.fa-krw:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-toggle-left:before,.fa-caret-square-o-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-turkish-lira:before,.fa-try:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li span.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-institution:before,.fa-bank:before,.fa-university:before{content:""}.fa-mortar-board:before,.fa-graduation-cap:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-photo-o:before,.fa-file-picture-o:before,.fa-file-image-o:before{content:""}.fa-file-zip-o:before,.fa-file-archive-o:before{content:""}.fa-file-sound-o:before,.fa-file-audio-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-saver:before,.fa-support:before,.fa-life-ring:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-resistance:before,.fa-rebel:before{content:""}.fa-ge:before,.fa-empire:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-y-combinator-square:before,.fa-yc-square:before,.fa-hacker-news:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-send:before,.fa-paper-plane:before{content:""}.fa-send-o:before,.fa-paper-plane-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-soccer-ball-o:before,.fa-futbol-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-shekel:before,.fa-sheqel:before,.fa-ils:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-hotel:before,.fa-bed:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-yc:before,.fa-y-combinator:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery:before,.fa-battery-full:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-stop-o:before,.fa-hand-paper-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-tv:before,.fa-television:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-asl-interpreting:before,.fa-american-sign-language-interpreting:before{content:""}.fa-deafness:before,.fa-hard-of-hearing:before,.fa-deaf:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-signing:before,.fa-sign-language:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-vcard:before,.fa-address-card:before{content:""}.fa-vcard-o:before,.fa-address-card-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer:before,.fa-thermometer-full:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bathtub:before,.fa-s15:before,.fa-bath:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0, 0, 0, 0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.wy-menu-vertical li span.toctree-expand,.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li.current>a span.toctree-expand,.rst-content .admonition-title,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content dl dt .headerlink,.rst-content p.caption .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.rst-content code.download span:first-child,.icon,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context{font-family:inherit}.fa:before,.wy-menu-vertical li span.toctree-expand:before,.wy-menu-vertical li.on a span.toctree-expand:before,.wy-menu-vertical li.current>a span.toctree-expand:before,.rst-content .admonition-title:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content dl dt .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.rst-content code.download span:first-child:before,.icon:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before{font-family:"FontAwesome";display:inline-block;font-style:normal;font-weight:normal;line-height:1;text-decoration:inherit}a .fa,a .wy-menu-vertical li span.toctree-expand,.wy-menu-vertical li a span.toctree-expand,.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li.current>a span.toctree-expand,a .rst-content .admonition-title,.rst-content a .admonition-title,a .rst-content h1 .headerlink,.rst-content h1 a .headerlink,a .rst-content h2 .headerlink,.rst-content h2 a .headerlink,a .rst-content h3 .headerlink,.rst-content h3 a .headerlink,a .rst-content h4 .headerlink,.rst-content h4 a .headerlink,a .rst-content h5 .headerlink,.rst-content h5 a .headerlink,a .rst-content h6 .headerlink,.rst-content h6 a .headerlink,a .rst-content dl dt .headerlink,.rst-content dl dt a .headerlink,a .rst-content p.caption .headerlink,.rst-content p.caption a .headerlink,a .rst-content table>caption .headerlink,.rst-content table>caption a .headerlink,a .rst-content tt.download span:first-child,.rst-content tt.download a span:first-child,a .rst-content code.download span:first-child,.rst-content code.download a span:first-child,a .icon{display:inline-block;text-decoration:inherit}.btn .fa,.btn .wy-menu-vertical li span.toctree-expand,.wy-menu-vertical li .btn span.toctree-expand,.btn .wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li.on a .btn span.toctree-expand,.btn .wy-menu-vertical li.current>a span.toctree-expand,.wy-menu-vertical li.current>a .btn span.toctree-expand,.btn .rst-content .admonition-title,.rst-content .btn .admonition-title,.btn .rst-content h1 .headerlink,.rst-content h1 .btn .headerlink,.btn .rst-content h2 .headerlink,.rst-content h2 .btn .headerlink,.btn .rst-content h3 .headerlink,.rst-content h3 .btn .headerlink,.btn .rst-content h4 .headerlink,.rst-content h4 .btn .headerlink,.btn .rst-content h5 .headerlink,.rst-content h5 .btn .headerlink,.btn .rst-content h6 .headerlink,.rst-content h6 .btn .headerlink,.btn .rst-content dl dt .headerlink,.rst-content dl dt .btn .headerlink,.btn .rst-content p.caption .headerlink,.rst-content p.caption .btn .headerlink,.btn .rst-content table>caption .headerlink,.rst-content table>caption .btn .headerlink,.btn .rst-content tt.download span:first-child,.rst-content tt.download .btn span:first-child,.btn .rst-content code.download span:first-child,.rst-content code.download .btn span:first-child,.btn .icon,.nav .fa,.nav .wy-menu-vertical li span.toctree-expand,.wy-menu-vertical li .nav span.toctree-expand,.nav .wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li.on a .nav span.toctree-expand,.nav .wy-menu-vertical li.current>a span.toctree-expand,.wy-menu-vertical li.current>a .nav span.toctree-expand,.nav .rst-content .admonition-title,.rst-content .nav .admonition-title,.nav .rst-content h1 .headerlink,.rst-content h1 .nav .headerlink,.nav .rst-content h2 .headerlink,.rst-content h2 .nav .headerlink,.nav .rst-content h3 .headerlink,.rst-content h3 .nav .headerlink,.nav .rst-content h4 .headerlink,.rst-content h4 .nav .headerlink,.nav .rst-content h5 .headerlink,.rst-content h5 .nav .headerlink,.nav .rst-content h6 .headerlink,.rst-content h6 .nav .headerlink,.nav .rst-content dl dt .headerlink,.rst-content dl dt .nav .headerlink,.nav .rst-content p.caption .headerlink,.rst-content p.caption .nav .headerlink,.nav .rst-content table>caption .headerlink,.rst-content table>caption .nav .headerlink,.nav .rst-content tt.download span:first-child,.rst-content tt.download .nav span:first-child,.nav .rst-content code.download span:first-child,.rst-content code.download .nav span:first-child,.nav .icon{display:inline}.btn .fa.fa-large,.btn .wy-menu-vertical li span.fa-large.toctree-expand,.wy-menu-vertical li .btn span.fa-large.toctree-expand,.btn .rst-content .fa-large.admonition-title,.rst-content .btn .fa-large.admonition-title,.btn .rst-content h1 .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.btn .rst-content dl dt .fa-large.headerlink,.rst-content dl dt .btn .fa-large.headerlink,.btn .rst-content p.caption .fa-large.headerlink,.rst-content p.caption .btn .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.rst-content tt.download .btn span.fa-large:first-child,.btn .rst-content code.download span.fa-large:first-child,.rst-content code.download .btn span.fa-large:first-child,.btn .fa-large.icon,.nav .fa.fa-large,.nav .wy-menu-vertical li span.fa-large.toctree-expand,.wy-menu-vertical li .nav span.fa-large.toctree-expand,.nav .rst-content .fa-large.admonition-title,.rst-content .nav .fa-large.admonition-title,.nav .rst-content h1 .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.nav .rst-content dl dt .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.nav .rst-content p.caption .fa-large.headerlink,.rst-content p.caption .nav .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.nav .rst-content code.download span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.nav .fa-large.icon{line-height:.9em}.btn .fa.fa-spin,.btn .wy-menu-vertical li span.fa-spin.toctree-expand,.wy-menu-vertical li .btn span.fa-spin.toctree-expand,.btn .rst-content .fa-spin.admonition-title,.rst-content .btn .fa-spin.admonition-title,.btn .rst-content h1 .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.btn .rst-content dl dt .fa-spin.headerlink,.rst-content dl dt .btn .fa-spin.headerlink,.btn .rst-content p.caption .fa-spin.headerlink,.rst-content p.caption .btn .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.rst-content tt.download .btn span.fa-spin:first-child,.btn .rst-content code.download span.fa-spin:first-child,.rst-content code.download .btn span.fa-spin:first-child,.btn .fa-spin.icon,.nav .fa.fa-spin,.nav .wy-menu-vertical li span.fa-spin.toctree-expand,.wy-menu-vertical li .nav span.fa-spin.toctree-expand,.nav .rst-content .fa-spin.admonition-title,.rst-content .nav .fa-spin.admonition-title,.nav .rst-content h1 .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.nav .rst-content dl dt .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.nav .rst-content p.caption .fa-spin.headerlink,.rst-content p.caption .nav .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.nav .rst-content code.download span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.nav .fa-spin.icon{display:inline-block}.btn.fa:before,.wy-menu-vertical li span.btn.toctree-expand:before,.rst-content .btn.admonition-title:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content dl dt .btn.headerlink:before,.rst-content p.caption .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.rst-content code.download span.btn:first-child:before,.btn.icon:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.wy-menu-vertical li span.btn.toctree-expand:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content p.caption .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.rst-content code.download span.btn:first-child:hover:before,.btn.icon:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .wy-menu-vertical li span.toctree-expand:before,.wy-menu-vertical li .btn-mini span.toctree-expand:before,.btn-mini .rst-content .admonition-title:before,.rst-content .btn-mini .admonition-title:before,.btn-mini .rst-content h1 .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.btn-mini .rst-content dl dt .headerlink:before,.rst-content dl dt .btn-mini .headerlink:before,.btn-mini .rst-content p.caption .headerlink:before,.rst-content p.caption .btn-mini .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.rst-content tt.download .btn-mini span:first-child:before,.btn-mini .rst-content code.download span:first-child:before,.rst-content code.download .btn-mini span:first-child:before,.btn-mini .icon:before{font-size:14px;vertical-align:-15%}.wy-alert,.rst-content .note,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .warning,.rst-content .seealso,.rst-content .admonition-todo,.rst-content .admonition{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.wy-alert-title,.rst-content .admonition-title{color:#fff;font-weight:bold;display:block;color:#fff;background:#6ab0de;margin:-12px;padding:6px 12px;margin-bottom:12px}.wy-alert.wy-alert-danger,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.admonition{background:#fdf3f2}.wy-alert.wy-alert-danger .wy-alert-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .danger .wy-alert-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .danger .admonition-title,.rst-content .error .admonition-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition .admonition-title{background:#f29f97}.wy-alert.wy-alert-warning,.rst-content .wy-alert-warning.note,.rst-content .attention,.rst-content .caution,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.tip,.rst-content .warning,.rst-content .wy-alert-warning.seealso,.rst-content .admonition-todo,.rst-content .wy-alert-warning.admonition{background:#ffedcc}.wy-alert.wy-alert-warning .wy-alert-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .attention .wy-alert-title,.rst-content .caution .wy-alert-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .attention .admonition-title,.rst-content .caution .admonition-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .warning .admonition-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .admonition-todo .admonition-title,.rst-content .wy-alert-warning.admonition .admonition-title{background:#f0b37e}.wy-alert.wy-alert-info,.rst-content .note,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.rst-content .seealso,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.admonition{background:#e7f2fa}.wy-alert.wy-alert-info .wy-alert-title,.rst-content .note .wy-alert-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.rst-content .note .admonition-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .seealso .admonition-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition .admonition-title{background:#6ab0de}.wy-alert.wy-alert-success,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.warning,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.admonition{background:#dbfaf4}.wy-alert.wy-alert-success .wy-alert-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .hint .wy-alert-title,.rst-content .important .wy-alert-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .hint .admonition-title,.rst-content .important .admonition-title,.rst-content .tip .admonition-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition .admonition-title{background:#1abc9c}.wy-alert.wy-alert-neutral,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.admonition{background:#f3f6f6}.wy-alert.wy-alert-neutral .wy-alert-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition .admonition-title{color:#404040;background:#e1e4e5}.wy-alert.wy-alert-neutral a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a{color:#2980B9}.wy-alert p:last-child,.rst-content .note p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.rst-content .seealso p:last-child,.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0px;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,0.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27AE60}.wy-tray-container li.wy-tray-item-info{background:#2980B9}.wy-tray-container li.wy-tray-item-warning{background:#E67E22}.wy-tray-container li.wy-tray-item-danger{background:#E74C3C}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width: 768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px 12px;color:#fff;border:1px solid rgba(0,0,0,0.1);background-color:#27AE60;text-decoration:none;font-weight:normal;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;box-shadow:0px 1px 2px -1px rgba(255,255,255,0.5) inset,0px -2px 0px 0px rgba(0,0,0,0.1) inset;outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:0px -1px 0px 0px rgba(0,0,0,0.05) inset,0px 2px 0px 0px rgba(0,0,0,0.1) inset;padding:8px 12px 6px 12px}.btn:visited{color:#fff}.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn-disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn-disabled:hover,.btn-disabled:focus,.btn-disabled:active{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980B9 !important}.btn-info:hover{background-color:#2e8ece !important}.btn-neutral{background-color:#f3f6f6 !important;color:#404040 !important}.btn-neutral:hover{background-color:#e5ebeb !important;color:#404040}.btn-neutral:visited{color:#404040 !important}.btn-success{background-color:#27AE60 !important}.btn-success:hover{background-color:#295 !important}.btn-danger{background-color:#E74C3C !important}.btn-danger:hover{background-color:#ea6153 !important}.btn-warning{background-color:#E67E22 !important}.btn-warning:hover{background-color:#e98b39 !important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f !important}.btn-link{background-color:transparent !important;color:#2980B9;box-shadow:none;border-color:transparent !important}.btn-link:hover{background-color:transparent !important;color:#409ad5 !important;box-shadow:none}.btn-link:active{background-color:transparent !important;color:#409ad5 !important;box-shadow:none}.btn-link:visited{color:#9B59B6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:before,.wy-btn-group:after{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:solid 1px #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,0.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980B9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:solid 1px #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type="search"]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980B9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned input,.wy-form-aligned textarea,.wy-form-aligned select,.wy-form-aligned .wy-help-inline,.wy-form-aligned label{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{border:0;margin:0;padding:0}legend{display:block;width:100%;border:0;padding:0;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label{display:block;margin:0 0 .3125em 0;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;*zoom:1;max-width:68em;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:before,.wy-control-group:after{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group:before,.wy-control-group:after{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#E74C3C}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full input[type="text"],.wy-control-group .wy-form-full input[type="password"],.wy-control-group .wy-form-full input[type="email"],.wy-control-group .wy-form-full input[type="url"],.wy-control-group .wy-form-full input[type="date"],.wy-control-group .wy-form-full input[type="month"],.wy-control-group .wy-form-full input[type="time"],.wy-control-group .wy-form-full input[type="datetime"],.wy-control-group .wy-form-full input[type="datetime-local"],.wy-control-group .wy-form-full input[type="week"],.wy-control-group .wy-form-full input[type="number"],.wy-control-group .wy-form-full input[type="search"],.wy-control-group .wy-form-full input[type="tel"],.wy-control-group .wy-form-full input[type="color"],.wy-control-group .wy-form-halves input[type="text"],.wy-control-group .wy-form-halves input[type="password"],.wy-control-group .wy-form-halves input[type="email"],.wy-control-group .wy-form-halves input[type="url"],.wy-control-group .wy-form-halves input[type="date"],.wy-control-group .wy-form-halves input[type="month"],.wy-control-group .wy-form-halves input[type="time"],.wy-control-group .wy-form-halves input[type="datetime"],.wy-control-group .wy-form-halves input[type="datetime-local"],.wy-control-group .wy-form-halves input[type="week"],.wy-control-group .wy-form-halves input[type="number"],.wy-control-group .wy-form-halves input[type="search"],.wy-control-group .wy-form-halves input[type="tel"],.wy-control-group .wy-form-halves input[type="color"],.wy-control-group .wy-form-thirds input[type="text"],.wy-control-group .wy-form-thirds input[type="password"],.wy-control-group .wy-form-thirds input[type="email"],.wy-control-group .wy-form-thirds input[type="url"],.wy-control-group .wy-form-thirds input[type="date"],.wy-control-group .wy-form-thirds input[type="month"],.wy-control-group .wy-form-thirds input[type="time"],.wy-control-group .wy-form-thirds input[type="datetime"],.wy-control-group .wy-form-thirds input[type="datetime-local"],.wy-control-group .wy-form-thirds input[type="week"],.wy-control-group .wy-form-thirds input[type="number"],.wy-control-group .wy-form-thirds input[type="search"],.wy-control-group .wy-form-thirds input[type="tel"],.wy-control-group .wy-form-thirds input[type="color"]{width:100%}.wy-control-group .wy-form-full{float:left;display:block;margin-right:2.3576515979%;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.3576515979%;width:48.821174201%}.wy-control-group .wy-form-halves:last-child{margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(2n+1){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.3576515979%;width:31.7615656014%}.wy-control-group .wy-form-thirds:last-child{margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control{margin:6px 0 0 0;font-size:90%}.wy-control-no-input{display:inline-block;margin:6px 0 0 0;font-size:90%}.wy-control-group.fluid-input input[type="text"],.wy-control-group.fluid-input input[type="password"],.wy-control-group.fluid-input input[type="email"],.wy-control-group.fluid-input input[type="url"],.wy-control-group.fluid-input input[type="date"],.wy-control-group.fluid-input input[type="month"],.wy-control-group.fluid-input input[type="time"],.wy-control-group.fluid-input input[type="datetime"],.wy-control-group.fluid-input input[type="datetime-local"],.wy-control-group.fluid-input input[type="week"],.wy-control-group.fluid-input input[type="number"],.wy-control-group.fluid-input input[type="search"],.wy-control-group.fluid-input input[type="tel"],.wy-control-group.fluid-input input[type="color"]{width:100%}.wy-form-message-inline{display:inline-block;padding-left:.3em;color:#666;vertical-align:middle;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;*overflow:visible}input[type="text"],input[type="password"],input[type="email"],input[type="url"],input[type="date"],input[type="month"],input[type="time"],input[type="datetime"],input[type="datetime-local"],input[type="week"],input[type="number"],input[type="search"],input[type="tel"],input[type="color"]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type="datetime-local"]{padding:.34375em .625em}input[disabled]{cursor:default}input[type="checkbox"],input[type="radio"]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box;padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type="search"]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none}input[type="text"]:focus,input[type="password"]:focus,input[type="email"]:focus,input[type="url"]:focus,input[type="date"]:focus,input[type="month"]:focus,input[type="time"]:focus,input[type="datetime"]:focus,input[type="datetime-local"]:focus,input[type="week"]:focus,input[type="number"]:focus,input[type="search"]:focus,input[type="tel"]:focus,input[type="color"]:focus{outline:0;outline:thin dotted \9;border-color:#333}input.no-focus:focus{border-color:#ccc !important}input[type="file"]:focus,input[type="radio"]:focus,input[type="checkbox"]:focus{outline:thin dotted #333;outline:1px auto #129FEA}input[type="text"][disabled],input[type="password"][disabled],input[type="email"][disabled],input[type="url"][disabled],input[type="date"][disabled],input[type="month"][disabled],input[type="time"][disabled],input[type="datetime"][disabled],input[type="datetime-local"][disabled],input[type="week"][disabled],input[type="number"][disabled],input[type="search"][disabled],input[type="tel"][disabled],input[type="color"][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,textarea:focus:invalid,select:focus:invalid{color:#E74C3C;border:1px solid #E74C3C}input:focus:invalid:focus,textarea:focus:invalid:focus,select:focus:invalid:focus{border-color:#E74C3C}input[type="file"]:focus:invalid:focus,input[type="radio"]:focus:invalid:focus,input[type="checkbox"]:focus:invalid:focus{outline-color:#E74C3C}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}select[disabled],textarea[disabled],input[readonly],select[readonly],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type="radio"][disabled],input[type="checkbox"][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:solid 1px #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{position:absolute;content:"";display:block;left:0;top:0;width:36px;height:12px;border-radius:4px;background:#ccc;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{position:absolute;content:"";display:block;width:18px;height:18px;border-radius:4px;background:#999;left:-3px;top:-3px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27AE60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#E74C3C}.wy-control-group.wy-control-group-error input[type="text"],.wy-control-group.wy-control-group-error input[type="password"],.wy-control-group.wy-control-group-error input[type="email"],.wy-control-group.wy-control-group-error input[type="url"],.wy-control-group.wy-control-group-error input[type="date"],.wy-control-group.wy-control-group-error input[type="month"],.wy-control-group.wy-control-group-error input[type="time"],.wy-control-group.wy-control-group-error input[type="datetime"],.wy-control-group.wy-control-group-error input[type="datetime-local"],.wy-control-group.wy-control-group-error input[type="week"],.wy-control-group.wy-control-group-error input[type="number"],.wy-control-group.wy-control-group-error input[type="search"],.wy-control-group.wy-control-group-error input[type="tel"],.wy-control-group.wy-control-group-error input[type="color"]{border:solid 1px #E74C3C}.wy-control-group.wy-control-group-error textarea{border:solid 1px #E74C3C}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27AE60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#E74C3C}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#E67E22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980B9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width: 480px){.wy-form button[type="submit"]{margin:.7em 0 0}.wy-form input[type="text"],.wy-form input[type="password"],.wy-form input[type="email"],.wy-form input[type="url"],.wy-form input[type="date"],.wy-form input[type="month"],.wy-form input[type="time"],.wy-form input[type="datetime"],.wy-form input[type="datetime-local"],.wy-form input[type="week"],.wy-form input[type="number"],.wy-form input[type="search"],.wy-form input[type="tel"],.wy-form input[type="color"]{margin-bottom:.3em;display:block}.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type="password"],.wy-form input[type="email"],.wy-form input[type="url"],.wy-form input[type="date"],.wy-form input[type="month"],.wy-form input[type="time"],.wy-form input[type="datetime"],.wy-form input[type="datetime-local"],.wy-form input[type="week"],.wy-form input[type="number"],.wy-form input[type="search"],.wy-form input[type="tel"],.wy-form input[type="color"]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0 0}.wy-form .wy-help-inline,.wy-form-message-inline,.wy-form-message{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width: 768px){.tablet-hide{display:none}}@media screen and (max-width: 480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.wy-table,.rst-content table.docutils,.rst-content table.field-list{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.wy-table caption,.rst-content table.docutils caption,.rst-content table.field-list caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.wy-table td,.rst-content table.docutils td,.rst-content table.field-list td,.wy-table th,.rst-content table.docutils th,.rst-content table.field-list th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.wy-table td:first-child,.rst-content table.docutils td:first-child,.rst-content table.field-list td:first-child,.wy-table th:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list th:first-child{border-left-width:0}.wy-table thead,.rst-content table.docutils thead,.rst-content table.field-list thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.wy-table thead th,.rst-content table.docutils thead th,.rst-content table.field-list thead th{font-weight:bold;border-bottom:solid 2px #e1e4e5}.wy-table td,.rst-content table.docutils td,.rst-content table.field-list td{background-color:transparent;vertical-align:middle}.wy-table td p,.rst-content table.docutils td p,.rst-content table.field-list td p{line-height:18px}.wy-table td p:last-child,.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child{margin-bottom:0}.wy-table .wy-table-cell-min,.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min{width:1%;padding-right:0}.wy-table .wy-table-cell-min input[type=checkbox],.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox],.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:gray;font-size:90%}.wy-table-tertiary{color:gray;font-size:80%}.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td,.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td{background-color:#f3f6f6}.wy-table-backed{background-color:#f3f6f6}.wy-table-bordered-all,.rst-content table.docutils{border:1px solid #e1e4e5}.wy-table-bordered-all td,.rst-content table.docutils td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.wy-table-bordered-all tbody>tr:last-child td,.rst-content table.docutils tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px 0;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0 !important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980B9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9B59B6}html{height:100%;overflow-x:hidden}body{font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;font-weight:normal;color:#404040;min-height:100%;overflow-x:hidden;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#E67E22 !important}a.wy-text-warning:hover{color:#eb9950 !important}.wy-text-info{color:#2980B9 !important}a.wy-text-info:hover{color:#409ad5 !important}.wy-text-success{color:#27AE60 !important}a.wy-text-success:hover{color:#36d278 !important}.wy-text-danger{color:#E74C3C !important}a.wy-text-danger:hover{color:#ed7669 !important}.wy-text-neutral{color:#404040 !important}a.wy-text-neutral:hover{color:#595959 !important}h1,h2,.rst-content .toctree-wrapper p.caption,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:"Roboto Slab","ff-tisa-web-pro","Georgia",Arial,sans-serif}p{line-height:24px;margin:0;font-size:16px;margin-bottom:24px}h1{font-size:175%}h2,.rst-content .toctree-wrapper p.caption{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}code,.rst-content tt,.rst-content code{white-space:nowrap;max-width:100%;background:#fff;border:solid 1px #e1e4e5;font-size:75%;padding:0 5px;font-family:Consolas,"Andale Mono WT","Andale Mono","Lucida Console","Lucida Sans Typewriter","DejaVu Sans Mono","Bitstream Vera Sans Mono","Liberation Mono","Nimbus Mono L",Monaco,"Courier New",Courier,monospace;color:#E74C3C;overflow-x:auto}code.code-large,.rst-content tt.code-large{font-size:90%}.wy-plain-list-disc,.rst-content .section ul,.rst-content .toctree-wrapper ul,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.wy-plain-list-disc li,.rst-content .section ul li,.rst-content .toctree-wrapper ul li,article ul li{list-style:disc;margin-left:24px}.wy-plain-list-disc li p:last-child,.rst-content .section ul li p:last-child,.rst-content .toctree-wrapper ul li p:last-child,article ul li p:last-child{margin-bottom:0}.wy-plain-list-disc li ul,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li ul,article ul li ul{margin-bottom:0}.wy-plain-list-disc li li,.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,article ul li li{list-style:circle}.wy-plain-list-disc li li li,.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,article ul li li li{list-style:square}.wy-plain-list-disc li ol li,.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,article ul li ol li{list-style:decimal}.wy-plain-list-decimal,.rst-content .section ol,.rst-content ol.arabic,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.wy-plain-list-decimal li,.rst-content .section ol li,.rst-content ol.arabic li,article ol li{list-style:decimal;margin-left:24px}.wy-plain-list-decimal li p:last-child,.rst-content .section ol li p:last-child,.rst-content ol.arabic li p:last-child,article ol li p:last-child{margin-bottom:0}.wy-plain-list-decimal li ul,.rst-content .section ol li ul,.rst-content ol.arabic li ul,article ol li ul{margin-bottom:0}.wy-plain-list-decimal li ul li,.rst-content .section ol li ul li,.rst-content ol.arabic li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:before,.wy-breadcrumbs:after{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs li{display:inline-block}.wy-breadcrumbs li.wy-breadcrumbs-aside{float:right}.wy-breadcrumbs li a{display:inline-block;padding:5px}.wy-breadcrumbs li a:first-child{padding-left:0}.wy-breadcrumbs li code,.wy-breadcrumbs li .rst-content tt,.rst-content .wy-breadcrumbs li tt{padding:5px;border:none;background:none}.wy-breadcrumbs li code.literal,.wy-breadcrumbs li .rst-content tt.literal,.rst-content .wy-breadcrumbs li tt.literal{color:#404040}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width: 480px){.wy-breadcrumbs-extra{display:none}.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:before,.wy-menu-horiz:after{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz ul,.wy-menu-horiz li{display:inline-block}.wy-menu-horiz li:hover{background:rgba(255,255,255,0.1)}.wy-menu-horiz li.divide-left{border-left:solid 1px #404040}.wy-menu-horiz li.divide-right{border-right:solid 1px #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{height:32px;display:inline-block;line-height:32px;padding:0 1.618em;margin-bottom:0;display:block;font-weight:bold;text-transform:uppercase;font-size:80%;color:#6f6f6f;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:solid 1px #404040}.wy-menu-vertical li.divide-bottom{border-bottom:solid 1px #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:gray;border-right:solid 1px #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.wy-menu-vertical li code,.wy-menu-vertical li .rst-content tt,.rst-content .wy-menu-vertical li tt{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li span.toctree-expand{display:block;float:left;margin-left:-1.2em;font-size:.8em;line-height:1.6em;color:#4d4d4d}.wy-menu-vertical li.on a,.wy-menu-vertical li.current>a{color:#404040;padding:.4045em 1.618em;font-weight:bold;position:relative;background:#fcfcfc;border:none;padding-left:1.618em -4px}.wy-menu-vertical li.on a:hover,.wy-menu-vertical li.current>a:hover{background:#fcfcfc}.wy-menu-vertical li.on a:hover span.toctree-expand,.wy-menu-vertical li.current>a:hover span.toctree-expand{color:gray}.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li.current>a span.toctree-expand{display:block;font-size:.8em;line-height:1.6em;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:solid 1px #c9c9c9;border-top:solid 1px #c9c9c9}.wy-menu-vertical li.toctree-l1.current li.toctree-l2>ul,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>ul{display:none}.wy-menu-vertical li.toctree-l1.current li.toctree-l2.current>ul,.wy-menu-vertical li.toctree-l2.current li.toctree-l3.current>ul{display:block}.wy-menu-vertical li.toctree-l2.current>a{background:#c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{display:block;background:#c9c9c9;padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l2 a:hover span.toctree-expand{color:gray}.wy-menu-vertical li.toctree-l2 span.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3{font-size:.9em}.wy-menu-vertical li.toctree-l3.current>a{background:#bdbdbd;padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{display:block;background:#bdbdbd;padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l3 a:hover span.toctree-expand{color:gray}.wy-menu-vertical li.toctree-l3 span.toctree-expand{color:#969696}.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#b3b3b3;font-weight:normal}.wy-menu-vertical a{display:inline-block;line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#b3b3b3}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover span.toctree-expand{color:#b3b3b3}.wy-menu-vertical a:active{background-color:#2980B9;cursor:pointer;color:#fff}.wy-menu-vertical a:active span.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980B9;text-align:center;padding:.809em;display:block;color:#fcfcfc;margin-bottom:.809em}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em auto;height:45px;width:45px;background-color:#2980B9;padding:5px;border-radius:100%}.wy-side-nav-search>a,.wy-side-nav-search .wy-dropdown>a{color:#fcfcfc;font-size:100%;font-weight:bold;display:inline-block;padding:4px 6px;margin-bottom:.809em}.wy-side-nav-search>a:hover,.wy-side-nav-search .wy-dropdown>a:hover{background:rgba(255,255,255,0.1)}.wy-side-nav-search>a img.logo,.wy-side-nav-search .wy-dropdown>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search>a.icon img.logo,.wy-side-nav-search .wy-dropdown>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:normal;color:rgba(255,255,255,0.3)}.wy-nav .wy-menu-vertical header{color:#2980B9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980B9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980B9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:before,.wy-nav-top:after{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:bold}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980B9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,0.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:gray}footer p{margin-bottom:12px}footer span.commit code,footer span.commit .rst-content tt,.rst-content footer span.commit tt{padding:0px;font-family:Consolas,"Andale Mono WT","Andale Mono","Lucida Console","Lucida Sans Typewriter","DejaVu Sans Mono","Bitstream Vera Sans Mono","Liberation Mono","Nimbus Mono L",Monaco,"Courier New",Courier,monospace;font-size:1em;background:none;border:none;color:gray}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:before,.rst-footer-buttons:after{width:100%}.rst-footer-buttons:before,.rst-footer-buttons:after{display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:before,.rst-breadcrumbs-buttons:after{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:solid 1px #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:solid 1px #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:gray;font-size:90%}@media screen and (max-width: 768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-side-scroll{width:auto}.wy-side-nav-search{width:auto}.wy-menu.wy-menu-vertical{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width: 1100px){.wy-nav-content-wrap{background:rgba(0,0,0,0.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,footer,.wy-nav-side{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;overflow-y:scroll;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;z-index:400}.rst-versions a{color:#2980B9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27AE60;*zoom:1}.rst-versions .rst-current-version:before,.rst-versions .rst-current-version:after{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .wy-menu-vertical li span.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version span.toctree-expand,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content p.caption .headerlink,.rst-content p.caption .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .icon{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#E74C3C;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#F1C40F;color:#000}.rst-versions.shift-up{max-height:100%}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:gray;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:solid 1px #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px}.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge .rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width: 768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content img{max-width:100%;height:auto}.rst-content div.figure{margin-bottom:24px}.rst-content div.figure p.caption{font-style:italic}.rst-content div.figure p:last-child.caption{margin-bottom:0px}.rst-content div.figure.align-center{text-align:center}.rst-content .section>img,.rst-content .section>a>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block,.rst-content div[class^='highlight']{border:1px solid #e1e4e5;padding:0px;overflow-x:auto;margin:1px 0 24px 0}.rst-content pre.literal-block div[class^='highlight'],.rst-content div[class^='highlight'] div[class^='highlight']{border:none;margin:0}.rst-content div[class^='highlight'] td.code{width:100%}.rst-content .linenodiv pre{border-right:solid 1px #e6e9ea;margin:0;padding:12px 12px;font-family:Consolas,"Andale Mono WT","Andale Mono","Lucida Console","Lucida Sans Typewriter","DejaVu Sans Mono","Bitstream Vera Sans Mono","Liberation Mono","Nimbus Mono L",Monaco,"Courier New",Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^='highlight'] pre{white-space:pre;margin:0;padding:12px 12px;font-family:Consolas,"Andale Mono WT","Andale Mono","Lucida Console","Lucida Sans Typewriter","DejaVu Sans Mono","Bitstream Vera Sans Mono","Liberation Mono","Nimbus Mono L",Monaco,"Courier New",Courier,monospace;display:block;overflow:auto}.rst-content pre.literal-block,.rst-content div[class^='highlight'] pre,.rst-content .linenodiv pre{font-size:12px;line-height:normal}@media print{.rst-content .codeblock,.rst-content div[class^='highlight'],.rst-content div[class^='highlight'] pre{white-space:pre-wrap}}.rst-content .note .last,.rst-content .attention .last,.rst-content .caution .last,.rst-content .danger .last,.rst-content .error .last,.rst-content .hint .last,.rst-content .important .last,.rst-content .tip .last,.rst-content .warning .last,.rst-content .seealso .last,.rst-content .admonition-todo .last,.rst-content .admonition .last{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,0.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent !important;border-color:rgba(0,0,0,0.1) !important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha li{list-style:upper-alpha}.rst-content .section ol p,.rst-content .section ul p{margin-bottom:12px}.rst-content .line-block{margin-left:0px;margin-bottom:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0px}.rst-content .topic-title{font-weight:bold;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0px 0px 24px 24px}.rst-content .align-left{float:left;margin:0px 24px 24px 0px}.rst-content .align-center{margin:auto;display:block}.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content .toctree-wrapper p.caption .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content dl dt .headerlink,.rst-content p.caption .headerlink,.rst-content table>caption .headerlink{visibility:hidden;font-size:14px}.rst-content h1 .headerlink:after,.rst-content h2 .headerlink:after,.rst-content .toctree-wrapper p.caption .headerlink:after,.rst-content h3 .headerlink:after,.rst-content h4 .headerlink:after,.rst-content h5 .headerlink:after,.rst-content h6 .headerlink:after,.rst-content dl dt .headerlink:after,.rst-content p.caption .headerlink:after,.rst-content table>caption .headerlink:after{content:"";font-family:FontAwesome}.rst-content h1:hover .headerlink:after,.rst-content h2:hover .headerlink:after,.rst-content .toctree-wrapper p.caption:hover .headerlink:after,.rst-content h3:hover .headerlink:after,.rst-content h4:hover .headerlink:after,.rst-content h5:hover .headerlink:after,.rst-content h6:hover .headerlink:after,.rst-content dl dt:hover .headerlink:after,.rst-content p.caption:hover .headerlink:after,.rst-content table>caption:hover .headerlink:after{visibility:visible}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:solid 1px #e1e4e5}.rst-content .sidebar p,.rst-content .sidebar ul,.rst-content .sidebar dl{font-size:90%}.rst-content .sidebar .last{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:"Roboto Slab","ff-tisa-web-pro","Georgia",Arial,sans-serif;font-weight:bold;background:#e1e4e5;padding:6px 12px;margin:-24px;margin-bottom:24px;font-size:100%}.rst-content .highlighted{background:#F1C40F;display:inline-block;font-weight:bold;padding:0 6px}.rst-content .footnote-reference,.rst-content .citation-reference{vertical-align:baseline;position:relative;top:-0.4em;line-height:0;font-size:90%}.rst-content table.docutils.citation,.rst-content table.docutils.footnote{background:none;border:none;color:gray}.rst-content table.docutils.citation td,.rst-content table.docutils.citation tr,.rst-content table.docutils.footnote td,.rst-content table.docutils.footnote tr{border:none;background-color:transparent !important;white-space:normal}.rst-content table.docutils.citation td.label,.rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}.rst-content table.docutils.citation tt,.rst-content table.docutils.citation code,.rst-content table.docutils.footnote tt,.rst-content table.docutils.footnote code{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}.rst-content table.field-list{border:none}.rst-content table.field-list td{border:none}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content tt,.rst-content tt,.rst-content code{color:#000;padding:2px 5px}.rst-content tt big,.rst-content tt em,.rst-content tt big,.rst-content code big,.rst-content tt em,.rst-content code em{font-size:100% !important;line-height:normal}.rst-content tt.literal,.rst-content tt.literal,.rst-content code.literal{color:#E74C3C}.rst-content tt.xref,a .rst-content tt,.rst-content tt.xref,.rst-content code.xref,a .rst-content tt,a .rst-content code{font-weight:bold;color:#404040}.rst-content a tt,.rst-content a tt,.rst-content a code{color:#2980B9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:bold}.rst-content dl p,.rst-content dl table,.rst-content dl ul,.rst-content dl ol{margin-bottom:12px !important}.rst-content dl dd{margin:0 0 12px 24px}.rst-content dl:not(.docutils){margin-bottom:24px}.rst-content dl:not(.docutils) dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980B9;border-top:solid 3px #6ab0de;padding:6px;position:relative}.rst-content dl:not(.docutils) dt:before{color:#6ab0de}.rst-content dl:not(.docutils) dt .headerlink{color:#404040;font-size:100% !important}.rst-content dl:not(.docutils) dl dt{margin-bottom:6px;border:none;border-left:solid 3px #ccc;background:#f0f0f0;color:#555}.rst-content dl:not(.docutils) dl dt .headerlink{color:#404040;font-size:100% !important}.rst-content dl:not(.docutils) dt:first-child{margin-top:0}.rst-content dl:not(.docutils) tt,.rst-content dl:not(.docutils) tt,.rst-content dl:not(.docutils) code{font-weight:bold}.rst-content dl:not(.docutils) tt.descname,.rst-content dl:not(.docutils) tt.descclassname,.rst-content dl:not(.docutils) tt.descname,.rst-content dl:not(.docutils) code.descname,.rst-content dl:not(.docutils) tt.descclassname,.rst-content dl:not(.docutils) code.descclassname{background-color:transparent;border:none;padding:0;font-size:100% !important}.rst-content dl:not(.docutils) tt.descname,.rst-content dl:not(.docutils) tt.descname,.rst-content dl:not(.docutils) code.descname{font-weight:bold}.rst-content dl:not(.docutils) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:bold}.rst-content dl:not(.docutils) .property{display:inline-block;padding-right:8px}.rst-content .viewcode-link,.rst-content .viewcode-back{display:inline-block;color:#27AE60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:bold}.rst-content tt.download,.rst-content code.download{background:inherit;padding:inherit;font-weight:normal;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content tt.download span:first-child,.rst-content code.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content tt.download span:first-child:before,.rst-content code.download span:first-child:before{margin-right:4px}.rst-content .guilabel{border:1px solid #7fbbe3;background:#e7f2fa;font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .versionmodified{font-style:italic}@media screen and (max-width: 480px){.rst-content .sidebar{width:100%}}span[id*='MathJax-Span']{color:#404040}.math{text-align:center}@font-face{font-family:"Inconsolata";font-style:normal;font-weight:400;src:local("Inconsolata"),local("Inconsolata-Regular"),url(../fonts/Inconsolata-Regular.ttf) format("truetype")}@font-face{font-family:"Inconsolata";font-style:normal;font-weight:700;src:local("Inconsolata Bold"),local("Inconsolata-Bold"),url(../fonts/Inconsolata-Bold.ttf) format("truetype")}@font-face{font-family:"Lato";font-style:normal;font-weight:400;src:local("Lato Regular"),local("Lato-Regular"),url(../fonts/Lato-Regular.ttf) format("truetype")}@font-face{font-family:"Lato";font-style:normal;font-weight:700;src:local("Lato Bold"),local("Lato-Bold"),url(../fonts/Lato-Bold.ttf) format("truetype")}@font-face{font-family:"Lato";font-style:italic;font-weight:400;src:local("Lato Italic"),local("Lato-Italic"),url(../fonts/Lato-Italic.ttf) format("truetype")}@font-face{font-family:"Lato";font-style:italic;font-weight:700;src:local("Lato Bold Italic"),local("Lato-BoldItalic"),url(../fonts/Lato-BoldItalic.ttf) format("truetype")}@font-face{font-family:"Roboto Slab";font-style:normal;font-weight:400;src:local("Roboto Slab Regular"),local("RobotoSlab-Regular"),url(../fonts/RobotoSlab-Regular.ttf) format("truetype")}@font-face{font-family:"Roboto Slab";font-style:normal;font-weight:700;src:local("Roboto Slab Bold"),local("RobotoSlab-Bold"),url(../fonts/RobotoSlab-Bold.ttf) format("truetype")} + */@font-face{font-family:'FontAwesome';src:url("../fonts/fontawesome-webfont.eot?v=4.7.0");src:url("../fonts/fontawesome-webfont.eot?#iefix&v=4.7.0") format("embedded-opentype"),url("../fonts/fontawesome-webfont.woff2?v=4.7.0") format("woff2"),url("../fonts/fontawesome-webfont.woff?v=4.7.0") format("woff"),url("../fonts/fontawesome-webfont.ttf?v=4.7.0") format("truetype"),url("../fonts/fontawesome-webfont.svg?v=4.7.0#fontawesomeregular") format("svg");font-weight:normal;font-style:normal}.fa,.wy-menu-vertical li span.toctree-expand,.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li.current>a span.toctree-expand,.rst-content .admonition-title,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content dl dt .headerlink,.rst-content p.caption .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.rst-content code.download span:first-child,.icon{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.3333333333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.2857142857em;text-align:center}.fa-ul{padding-left:0;margin-left:2.1428571429em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.1428571429em;width:2.1428571429em;top:.1428571429em;text-align:center}.fa-li.fa-lg{left:-1.8571428571em}.fa-border{padding:.2em .25em .15em;border:solid 0.08em #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa.fa-pull-left,.wy-menu-vertical li span.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a span.fa-pull-left.toctree-expand,.wy-menu-vertical li.current>a span.fa-pull-left.toctree-expand,.rst-content .fa-pull-left.admonition-title,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content dl dt .fa-pull-left.headerlink,.rst-content p.caption .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.rst-content code.download span.fa-pull-left:first-child,.fa-pull-left.icon{margin-right:.3em}.fa.fa-pull-right,.wy-menu-vertical li span.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a span.fa-pull-right.toctree-expand,.wy-menu-vertical li.current>a span.fa-pull-right.toctree-expand,.rst-content .fa-pull-right.admonition-title,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content dl dt .fa-pull-right.headerlink,.rst-content p.caption .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.rst-content code.download span.fa-pull-right:first-child,.fa-pull-right.icon{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.wy-menu-vertical li span.pull-left.toctree-expand,.wy-menu-vertical li.on a span.pull-left.toctree-expand,.wy-menu-vertical li.current>a span.pull-left.toctree-expand,.rst-content .pull-left.admonition-title,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content dl dt .pull-left.headerlink,.rst-content p.caption .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.rst-content code.download span.pull-left:first-child,.pull-left.icon{margin-right:.3em}.fa.pull-right,.wy-menu-vertical li span.pull-right.toctree-expand,.wy-menu-vertical li.on a span.pull-right.toctree-expand,.wy-menu-vertical li.current>a span.pull-right.toctree-expand,.rst-content .pull-right.admonition-title,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content dl dt .pull-right.headerlink,.rst-content p.caption .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.rst-content code.download span.pull-right:first-child,.pull-right.icon{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s infinite linear;animation:fa-spin 2s infinite linear}.fa-pulse{-webkit-animation:fa-spin 1s infinite steps(8);animation:fa-spin 1s infinite steps(8)}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scale(-1, 1);-ms-transform:scale(-1, 1);transform:scale(-1, 1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scale(1, -1);-ms-transform:scale(1, -1);transform:scale(1, -1)}:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270,:root .fa-flip-horizontal,:root .fa-flip-vertical{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-remove:before,.fa-close:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-gear:before,.fa-cog:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content tt.download span:first-child:before,.rst-content code.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-rotate-right:before,.fa-repeat:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-photo:before,.fa-image:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.rst-content .admonition-title:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-warning:before,.fa-exclamation-triangle:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-gears:before,.fa-cogs:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-save:before,.fa-floppy-o:before{content:""}.fa-square:before{content:""}.fa-navicon:before,.fa-reorder:before,.fa-bars:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.wy-dropdown .caret:before,.icon-caret-down:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-unsorted:before,.fa-sort:before{content:""}.fa-sort-down:before,.fa-sort-desc:before{content:""}.fa-sort-up:before,.fa-sort-asc:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-legal:before,.fa-gavel:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-flash:before,.fa-bolt:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-paste:before,.fa-clipboard:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-unlink:before,.fa-chain-broken:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.on a span.toctree-expand:before,.wy-menu-vertical li.current>a span.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-toggle-down:before,.fa-caret-square-o-down:before{content:""}.fa-toggle-up:before,.fa-caret-square-o-up:before{content:""}.fa-toggle-right:before,.fa-caret-square-o-right:before{content:""}.fa-euro:before,.fa-eur:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-rupee:before,.fa-inr:before{content:""}.fa-cny:before,.fa-rmb:before,.fa-yen:before,.fa-jpy:before{content:""}.fa-ruble:before,.fa-rouble:before,.fa-rub:before{content:""}.fa-won:before,.fa-krw:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-toggle-left:before,.fa-caret-square-o-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-turkish-lira:before,.fa-try:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li span.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-institution:before,.fa-bank:before,.fa-university:before{content:""}.fa-mortar-board:before,.fa-graduation-cap:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-photo-o:before,.fa-file-picture-o:before,.fa-file-image-o:before{content:""}.fa-file-zip-o:before,.fa-file-archive-o:before{content:""}.fa-file-sound-o:before,.fa-file-audio-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-saver:before,.fa-support:before,.fa-life-ring:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-resistance:before,.fa-rebel:before{content:""}.fa-ge:before,.fa-empire:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-y-combinator-square:before,.fa-yc-square:before,.fa-hacker-news:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-send:before,.fa-paper-plane:before{content:""}.fa-send-o:before,.fa-paper-plane-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-soccer-ball-o:before,.fa-futbol-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-shekel:before,.fa-sheqel:before,.fa-ils:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-hotel:before,.fa-bed:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-yc:before,.fa-y-combinator:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery:before,.fa-battery-full:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-stop-o:before,.fa-hand-paper-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-tv:before,.fa-television:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-asl-interpreting:before,.fa-american-sign-language-interpreting:before{content:""}.fa-deafness:before,.fa-hard-of-hearing:before,.fa-deaf:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-signing:before,.fa-sign-language:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-vcard:before,.fa-address-card:before{content:""}.fa-vcard-o:before,.fa-address-card-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer:before,.fa-thermometer-full:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bathtub:before,.fa-s15:before,.fa-bath:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0, 0, 0, 0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.wy-menu-vertical li span.toctree-expand,.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li.current>a span.toctree-expand,.rst-content .admonition-title,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content dl dt .headerlink,.rst-content p.caption .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.rst-content code.download span:first-child,.icon,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context{font-family:inherit}.fa:before,.wy-menu-vertical li span.toctree-expand:before,.wy-menu-vertical li.on a span.toctree-expand:before,.wy-menu-vertical li.current>a span.toctree-expand:before,.rst-content .admonition-title:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content dl dt .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.rst-content code.download span:first-child:before,.icon:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before{font-family:"FontAwesome";display:inline-block;font-style:normal;font-weight:normal;line-height:1;text-decoration:inherit}a .fa,a .wy-menu-vertical li span.toctree-expand,.wy-menu-vertical li a span.toctree-expand,.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li.current>a span.toctree-expand,a .rst-content .admonition-title,.rst-content a .admonition-title,a .rst-content h1 .headerlink,.rst-content h1 a .headerlink,a .rst-content h2 .headerlink,.rst-content h2 a .headerlink,a .rst-content h3 .headerlink,.rst-content h3 a .headerlink,a .rst-content h4 .headerlink,.rst-content h4 a .headerlink,a .rst-content h5 .headerlink,.rst-content h5 a .headerlink,a .rst-content h6 .headerlink,.rst-content h6 a .headerlink,a .rst-content dl dt .headerlink,.rst-content dl dt a .headerlink,a .rst-content p.caption .headerlink,.rst-content p.caption a .headerlink,a .rst-content table>caption .headerlink,.rst-content table>caption a .headerlink,a .rst-content tt.download span:first-child,.rst-content tt.download a span:first-child,a .rst-content code.download span:first-child,.rst-content code.download a span:first-child,a .icon{display:inline-block;text-decoration:inherit}.btn .fa,.btn .wy-menu-vertical li span.toctree-expand,.wy-menu-vertical li .btn span.toctree-expand,.btn .wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li.on a .btn span.toctree-expand,.btn .wy-menu-vertical li.current>a span.toctree-expand,.wy-menu-vertical li.current>a .btn span.toctree-expand,.btn .rst-content .admonition-title,.rst-content .btn .admonition-title,.btn .rst-content h1 .headerlink,.rst-content h1 .btn .headerlink,.btn .rst-content h2 .headerlink,.rst-content h2 .btn .headerlink,.btn .rst-content h3 .headerlink,.rst-content h3 .btn .headerlink,.btn .rst-content h4 .headerlink,.rst-content h4 .btn .headerlink,.btn .rst-content h5 .headerlink,.rst-content h5 .btn .headerlink,.btn .rst-content h6 .headerlink,.rst-content h6 .btn .headerlink,.btn .rst-content dl dt .headerlink,.rst-content dl dt .btn .headerlink,.btn .rst-content p.caption .headerlink,.rst-content p.caption .btn .headerlink,.btn .rst-content table>caption .headerlink,.rst-content table>caption .btn .headerlink,.btn .rst-content tt.download span:first-child,.rst-content tt.download .btn span:first-child,.btn .rst-content code.download span:first-child,.rst-content code.download .btn span:first-child,.btn .icon,.nav .fa,.nav .wy-menu-vertical li span.toctree-expand,.wy-menu-vertical li .nav span.toctree-expand,.nav .wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li.on a .nav span.toctree-expand,.nav .wy-menu-vertical li.current>a span.toctree-expand,.wy-menu-vertical li.current>a .nav span.toctree-expand,.nav .rst-content .admonition-title,.rst-content .nav .admonition-title,.nav .rst-content h1 .headerlink,.rst-content h1 .nav .headerlink,.nav .rst-content h2 .headerlink,.rst-content h2 .nav .headerlink,.nav .rst-content h3 .headerlink,.rst-content h3 .nav .headerlink,.nav .rst-content h4 .headerlink,.rst-content h4 .nav .headerlink,.nav .rst-content h5 .headerlink,.rst-content h5 .nav .headerlink,.nav .rst-content h6 .headerlink,.rst-content h6 .nav .headerlink,.nav .rst-content dl dt .headerlink,.rst-content dl dt .nav .headerlink,.nav .rst-content p.caption .headerlink,.rst-content p.caption .nav .headerlink,.nav .rst-content table>caption .headerlink,.rst-content table>caption .nav .headerlink,.nav .rst-content tt.download span:first-child,.rst-content tt.download .nav span:first-child,.nav .rst-content code.download span:first-child,.rst-content code.download .nav span:first-child,.nav .icon{display:inline}.btn .fa.fa-large,.btn .wy-menu-vertical li span.fa-large.toctree-expand,.wy-menu-vertical li .btn span.fa-large.toctree-expand,.btn .rst-content .fa-large.admonition-title,.rst-content .btn .fa-large.admonition-title,.btn .rst-content h1 .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.btn .rst-content dl dt .fa-large.headerlink,.rst-content dl dt .btn .fa-large.headerlink,.btn .rst-content p.caption .fa-large.headerlink,.rst-content p.caption .btn .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.rst-content tt.download .btn span.fa-large:first-child,.btn .rst-content code.download span.fa-large:first-child,.rst-content code.download .btn span.fa-large:first-child,.btn .fa-large.icon,.nav .fa.fa-large,.nav .wy-menu-vertical li span.fa-large.toctree-expand,.wy-menu-vertical li .nav span.fa-large.toctree-expand,.nav .rst-content .fa-large.admonition-title,.rst-content .nav .fa-large.admonition-title,.nav .rst-content h1 .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.nav .rst-content dl dt .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.nav .rst-content p.caption .fa-large.headerlink,.rst-content p.caption .nav .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.nav .rst-content code.download span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.nav .fa-large.icon{line-height:.9em}.btn .fa.fa-spin,.btn .wy-menu-vertical li span.fa-spin.toctree-expand,.wy-menu-vertical li .btn span.fa-spin.toctree-expand,.btn .rst-content .fa-spin.admonition-title,.rst-content .btn .fa-spin.admonition-title,.btn .rst-content h1 .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.btn .rst-content dl dt .fa-spin.headerlink,.rst-content dl dt .btn .fa-spin.headerlink,.btn .rst-content p.caption .fa-spin.headerlink,.rst-content p.caption .btn .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.rst-content tt.download .btn span.fa-spin:first-child,.btn .rst-content code.download span.fa-spin:first-child,.rst-content code.download .btn span.fa-spin:first-child,.btn .fa-spin.icon,.nav .fa.fa-spin,.nav .wy-menu-vertical li span.fa-spin.toctree-expand,.wy-menu-vertical li .nav span.fa-spin.toctree-expand,.nav .rst-content .fa-spin.admonition-title,.rst-content .nav .fa-spin.admonition-title,.nav .rst-content h1 .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.nav .rst-content dl dt .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.nav .rst-content p.caption .fa-spin.headerlink,.rst-content p.caption .nav .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.nav .rst-content code.download span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.nav .fa-spin.icon{display:inline-block}.btn.fa:before,.wy-menu-vertical li span.btn.toctree-expand:before,.rst-content .btn.admonition-title:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content dl dt .btn.headerlink:before,.rst-content p.caption .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.rst-content code.download span.btn:first-child:before,.btn.icon:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.wy-menu-vertical li span.btn.toctree-expand:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content p.caption .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.rst-content code.download span.btn:first-child:hover:before,.btn.icon:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .wy-menu-vertical li span.toctree-expand:before,.wy-menu-vertical li .btn-mini span.toctree-expand:before,.btn-mini .rst-content .admonition-title:before,.rst-content .btn-mini .admonition-title:before,.btn-mini .rst-content h1 .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.btn-mini .rst-content dl dt .headerlink:before,.rst-content dl dt .btn-mini .headerlink:before,.btn-mini .rst-content p.caption .headerlink:before,.rst-content p.caption .btn-mini .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.rst-content tt.download .btn-mini span:first-child:before,.btn-mini .rst-content code.download span:first-child:before,.rst-content code.download .btn-mini span:first-child:before,.btn-mini .icon:before{font-size:14px;vertical-align:-15%}.wy-alert,.rst-content .note,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .warning,.rst-content .seealso,.rst-content .admonition-todo,.rst-content .admonition{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.wy-alert-title,.rst-content .admonition-title{color:#fff;font-weight:bold;display:block;color:#fff;background:#6ab0de;margin:-12px;padding:6px 12px;margin-bottom:12px}.wy-alert.wy-alert-danger,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.admonition{background:#fdf3f2}.wy-alert.wy-alert-danger .wy-alert-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .danger .wy-alert-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .danger .admonition-title,.rst-content .error .admonition-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition .admonition-title{background:#f29f97}.wy-alert.wy-alert-warning,.rst-content .wy-alert-warning.note,.rst-content .attention,.rst-content .caution,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.tip,.rst-content .warning,.rst-content .wy-alert-warning.seealso,.rst-content .admonition-todo,.rst-content .wy-alert-warning.admonition{background:#ffedcc}.wy-alert.wy-alert-warning .wy-alert-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .attention .wy-alert-title,.rst-content .caution .wy-alert-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .attention .admonition-title,.rst-content .caution .admonition-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .warning .admonition-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .admonition-todo .admonition-title,.rst-content .wy-alert-warning.admonition .admonition-title{background:#f0b37e}.wy-alert.wy-alert-info,.rst-content .note,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.rst-content .seealso,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.admonition{background:#e7f2fa}.wy-alert.wy-alert-info .wy-alert-title,.rst-content .note .wy-alert-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.rst-content .note .admonition-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .seealso .admonition-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition .admonition-title{background:#6ab0de}.wy-alert.wy-alert-success,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.warning,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.admonition{background:#dbfaf4}.wy-alert.wy-alert-success .wy-alert-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .hint .wy-alert-title,.rst-content .important .wy-alert-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .hint .admonition-title,.rst-content .important .admonition-title,.rst-content .tip .admonition-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition .admonition-title{background:#1abc9c}.wy-alert.wy-alert-neutral,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.admonition{background:#f3f6f6}.wy-alert.wy-alert-neutral .wy-alert-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition .admonition-title{color:#404040;background:#e1e4e5}.wy-alert.wy-alert-neutral a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a{color:#2980B9}.wy-alert p:last-child,.rst-content .note p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.rst-content .seealso p:last-child,.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0px;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,0.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27AE60}.wy-tray-container li.wy-tray-item-info{background:#2980B9}.wy-tray-container li.wy-tray-item-warning{background:#E67E22}.wy-tray-container li.wy-tray-item-danger{background:#E74C3C}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width: 768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px 12px;color:#fff;border:1px solid rgba(0,0,0,0.1);background-color:#27AE60;text-decoration:none;font-weight:normal;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;box-shadow:0px 1px 2px -1px rgba(255,255,255,0.5) inset,0px -2px 0px 0px rgba(0,0,0,0.1) inset;outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:0px -1px 0px 0px rgba(0,0,0,0.05) inset,0px 2px 0px 0px rgba(0,0,0,0.1) inset;padding:8px 12px 6px 12px}.btn:visited{color:#fff}.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn-disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn-disabled:hover,.btn-disabled:focus,.btn-disabled:active{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980B9 !important}.btn-info:hover{background-color:#2e8ece !important}.btn-neutral{background-color:#f3f6f6 !important;color:#404040 !important}.btn-neutral:hover{background-color:#e5ebeb !important;color:#404040}.btn-neutral:visited{color:#404040 !important}.btn-success{background-color:#27AE60 !important}.btn-success:hover{background-color:#295 !important}.btn-danger{background-color:#E74C3C !important}.btn-danger:hover{background-color:#ea6153 !important}.btn-warning{background-color:#E67E22 !important}.btn-warning:hover{background-color:#e98b39 !important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f !important}.btn-link{background-color:transparent !important;color:#2980B9;box-shadow:none;border-color:transparent !important}.btn-link:hover{background-color:transparent !important;color:#409ad5 !important;box-shadow:none}.btn-link:active{background-color:transparent !important;color:#409ad5 !important;box-shadow:none}.btn-link:visited{color:#9B59B6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:before,.wy-btn-group:after{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:solid 1px #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,0.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980B9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:solid 1px #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type="search"]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980B9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned input,.wy-form-aligned textarea,.wy-form-aligned select,.wy-form-aligned .wy-help-inline,.wy-form-aligned label{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{border:0;margin:0;padding:0}legend{display:block;width:100%;border:0;padding:0;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label{display:block;margin:0 0 .3125em 0;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;*zoom:1;max-width:68em;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:before,.wy-control-group:after{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group:before,.wy-control-group:after{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#E74C3C}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full input[type="text"],.wy-control-group .wy-form-full input[type="password"],.wy-control-group .wy-form-full input[type="email"],.wy-control-group .wy-form-full input[type="url"],.wy-control-group .wy-form-full input[type="date"],.wy-control-group .wy-form-full input[type="month"],.wy-control-group .wy-form-full input[type="time"],.wy-control-group .wy-form-full input[type="datetime"],.wy-control-group .wy-form-full input[type="datetime-local"],.wy-control-group .wy-form-full input[type="week"],.wy-control-group .wy-form-full input[type="number"],.wy-control-group .wy-form-full input[type="search"],.wy-control-group .wy-form-full input[type="tel"],.wy-control-group .wy-form-full input[type="color"],.wy-control-group .wy-form-halves input[type="text"],.wy-control-group .wy-form-halves input[type="password"],.wy-control-group .wy-form-halves input[type="email"],.wy-control-group .wy-form-halves input[type="url"],.wy-control-group .wy-form-halves input[type="date"],.wy-control-group .wy-form-halves input[type="month"],.wy-control-group .wy-form-halves input[type="time"],.wy-control-group .wy-form-halves input[type="datetime"],.wy-control-group .wy-form-halves input[type="datetime-local"],.wy-control-group .wy-form-halves input[type="week"],.wy-control-group .wy-form-halves input[type="number"],.wy-control-group .wy-form-halves input[type="search"],.wy-control-group .wy-form-halves input[type="tel"],.wy-control-group .wy-form-halves input[type="color"],.wy-control-group .wy-form-thirds input[type="text"],.wy-control-group .wy-form-thirds input[type="password"],.wy-control-group .wy-form-thirds input[type="email"],.wy-control-group .wy-form-thirds input[type="url"],.wy-control-group .wy-form-thirds input[type="date"],.wy-control-group .wy-form-thirds input[type="month"],.wy-control-group .wy-form-thirds input[type="time"],.wy-control-group .wy-form-thirds input[type="datetime"],.wy-control-group .wy-form-thirds input[type="datetime-local"],.wy-control-group .wy-form-thirds input[type="week"],.wy-control-group .wy-form-thirds input[type="number"],.wy-control-group .wy-form-thirds input[type="search"],.wy-control-group .wy-form-thirds input[type="tel"],.wy-control-group .wy-form-thirds input[type="color"]{width:100%}.wy-control-group .wy-form-full{float:left;display:block;margin-right:2.3576515979%;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.3576515979%;width:48.821174201%}.wy-control-group .wy-form-halves:last-child{margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(2n+1){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.3576515979%;width:31.7615656014%}.wy-control-group .wy-form-thirds:last-child{margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control{margin:6px 0 0 0;font-size:90%}.wy-control-no-input{display:inline-block;margin:6px 0 0 0;font-size:90%}.wy-control-group.fluid-input input[type="text"],.wy-control-group.fluid-input input[type="password"],.wy-control-group.fluid-input input[type="email"],.wy-control-group.fluid-input input[type="url"],.wy-control-group.fluid-input input[type="date"],.wy-control-group.fluid-input input[type="month"],.wy-control-group.fluid-input input[type="time"],.wy-control-group.fluid-input input[type="datetime"],.wy-control-group.fluid-input input[type="datetime-local"],.wy-control-group.fluid-input input[type="week"],.wy-control-group.fluid-input input[type="number"],.wy-control-group.fluid-input input[type="search"],.wy-control-group.fluid-input input[type="tel"],.wy-control-group.fluid-input input[type="color"]{width:100%}.wy-form-message-inline{display:inline-block;padding-left:.3em;color:#666;vertical-align:middle;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;*overflow:visible}input[type="text"],input[type="password"],input[type="email"],input[type="url"],input[type="date"],input[type="month"],input[type="time"],input[type="datetime"],input[type="datetime-local"],input[type="week"],input[type="number"],input[type="search"],input[type="tel"],input[type="color"]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type="datetime-local"]{padding:.34375em .625em}input[disabled]{cursor:default}input[type="checkbox"],input[type="radio"]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box;padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type="search"]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none}input[type="text"]:focus,input[type="password"]:focus,input[type="email"]:focus,input[type="url"]:focus,input[type="date"]:focus,input[type="month"]:focus,input[type="time"]:focus,input[type="datetime"]:focus,input[type="datetime-local"]:focus,input[type="week"]:focus,input[type="number"]:focus,input[type="search"]:focus,input[type="tel"]:focus,input[type="color"]:focus{outline:0;outline:thin dotted \9;border-color:#333}input.no-focus:focus{border-color:#ccc !important}input[type="file"]:focus,input[type="radio"]:focus,input[type="checkbox"]:focus{outline:thin dotted #333;outline:1px auto #129FEA}input[type="text"][disabled],input[type="password"][disabled],input[type="email"][disabled],input[type="url"][disabled],input[type="date"][disabled],input[type="month"][disabled],input[type="time"][disabled],input[type="datetime"][disabled],input[type="datetime-local"][disabled],input[type="week"][disabled],input[type="number"][disabled],input[type="search"][disabled],input[type="tel"][disabled],input[type="color"][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,textarea:focus:invalid,select:focus:invalid{color:#E74C3C;border:1px solid #E74C3C}input:focus:invalid:focus,textarea:focus:invalid:focus,select:focus:invalid:focus{border-color:#E74C3C}input[type="file"]:focus:invalid:focus,input[type="radio"]:focus:invalid:focus,input[type="checkbox"]:focus:invalid:focus{outline-color:#E74C3C}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}select[disabled],textarea[disabled],input[readonly],select[readonly],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type="radio"][disabled],input[type="checkbox"][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:solid 1px #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{position:absolute;content:"";display:block;left:0;top:0;width:36px;height:12px;border-radius:4px;background:#ccc;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{position:absolute;content:"";display:block;width:18px;height:18px;border-radius:4px;background:#999;left:-3px;top:-3px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27AE60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#E74C3C}.wy-control-group.wy-control-group-error input[type="text"],.wy-control-group.wy-control-group-error input[type="password"],.wy-control-group.wy-control-group-error input[type="email"],.wy-control-group.wy-control-group-error input[type="url"],.wy-control-group.wy-control-group-error input[type="date"],.wy-control-group.wy-control-group-error input[type="month"],.wy-control-group.wy-control-group-error input[type="time"],.wy-control-group.wy-control-group-error input[type="datetime"],.wy-control-group.wy-control-group-error input[type="datetime-local"],.wy-control-group.wy-control-group-error input[type="week"],.wy-control-group.wy-control-group-error input[type="number"],.wy-control-group.wy-control-group-error input[type="search"],.wy-control-group.wy-control-group-error input[type="tel"],.wy-control-group.wy-control-group-error input[type="color"]{border:solid 1px #E74C3C}.wy-control-group.wy-control-group-error textarea{border:solid 1px #E74C3C}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27AE60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#E74C3C}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#E67E22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980B9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width: 480px){.wy-form button[type="submit"]{margin:.7em 0 0}.wy-form input[type="text"],.wy-form input[type="password"],.wy-form input[type="email"],.wy-form input[type="url"],.wy-form input[type="date"],.wy-form input[type="month"],.wy-form input[type="time"],.wy-form input[type="datetime"],.wy-form input[type="datetime-local"],.wy-form input[type="week"],.wy-form input[type="number"],.wy-form input[type="search"],.wy-form input[type="tel"],.wy-form input[type="color"]{margin-bottom:.3em;display:block}.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type="password"],.wy-form input[type="email"],.wy-form input[type="url"],.wy-form input[type="date"],.wy-form input[type="month"],.wy-form input[type="time"],.wy-form input[type="datetime"],.wy-form input[type="datetime-local"],.wy-form input[type="week"],.wy-form input[type="number"],.wy-form input[type="search"],.wy-form input[type="tel"],.wy-form input[type="color"]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0 0}.wy-form .wy-help-inline,.wy-form-message-inline,.wy-form-message{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width: 768px){.tablet-hide{display:none}}@media screen and (max-width: 480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.wy-table,.rst-content table.docutils,.rst-content table.field-list{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.wy-table caption,.rst-content table.docutils caption,.rst-content table.field-list caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.wy-table td,.rst-content table.docutils td,.rst-content table.field-list td,.wy-table th,.rst-content table.docutils th,.rst-content table.field-list th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.wy-table td:first-child,.rst-content table.docutils td:first-child,.rst-content table.field-list td:first-child,.wy-table th:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list th:first-child{border-left-width:0}.wy-table thead,.rst-content table.docutils thead,.rst-content table.field-list thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.wy-table thead th,.rst-content table.docutils thead th,.rst-content table.field-list thead th{font-weight:bold;border-bottom:solid 2px #e1e4e5}.wy-table td,.rst-content table.docutils td,.rst-content table.field-list td{background-color:transparent;vertical-align:middle}.wy-table td p,.rst-content table.docutils td p,.rst-content table.field-list td p{line-height:18px}.wy-table td p:last-child,.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child{margin-bottom:0}.wy-table .wy-table-cell-min,.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min{width:1%;padding-right:0}.wy-table .wy-table-cell-min input[type=checkbox],.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox],.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:gray;font-size:90%}.wy-table-tertiary{color:gray;font-size:80%}.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td,.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td{background-color:#f3f6f6}.wy-table-backed{background-color:#f3f6f6}.wy-table-bordered-all,.rst-content table.docutils{border:1px solid #e1e4e5}.wy-table-bordered-all td,.rst-content table.docutils td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.wy-table-bordered-all tbody>tr:last-child td,.rst-content table.docutils tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px 0;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0 !important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980B9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9B59B6}html{height:100%;overflow-x:hidden}body{font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;font-weight:normal;color:#404040;min-height:100%;overflow-x:hidden;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#E67E22 !important}a.wy-text-warning:hover{color:#eb9950 !important}.wy-text-info{color:#2980B9 !important}a.wy-text-info:hover{color:#409ad5 !important}.wy-text-success{color:#27AE60 !important}a.wy-text-success:hover{color:#36d278 !important}.wy-text-danger{color:#E74C3C !important}a.wy-text-danger:hover{color:#ed7669 !important}.wy-text-neutral{color:#404040 !important}a.wy-text-neutral:hover{color:#595959 !important}h1,h2,.rst-content .toctree-wrapper p.caption,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:"Roboto Slab","ff-tisa-web-pro","Georgia",Arial,sans-serif}p{line-height:24px;margin:0;font-size:16px;margin-bottom:24px}h1{font-size:175%}h2,.rst-content .toctree-wrapper p.caption{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}code,.rst-content tt,.rst-content code{white-space:nowrap;max-width:100%;background:#fff;border:solid 1px #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace;color:#E74C3C;overflow-x:auto}code.code-large,.rst-content tt.code-large{font-size:90%}.wy-plain-list-disc,.rst-content .section ul,.rst-content .toctree-wrapper ul,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.wy-plain-list-disc li,.rst-content .section ul li,.rst-content .toctree-wrapper ul li,article ul li{list-style:disc;margin-left:24px}.wy-plain-list-disc li p:last-child,.rst-content .section ul li p:last-child,.rst-content .toctree-wrapper ul li p:last-child,article ul li p:last-child{margin-bottom:0}.wy-plain-list-disc li ul,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li ul,article ul li ul{margin-bottom:0}.wy-plain-list-disc li li,.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,article ul li li{list-style:circle}.wy-plain-list-disc li li li,.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,article ul li li li{list-style:square}.wy-plain-list-disc li ol li,.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,article ul li ol li{list-style:decimal}.wy-plain-list-decimal,.rst-content .section ol,.rst-content ol.arabic,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.wy-plain-list-decimal li,.rst-content .section ol li,.rst-content ol.arabic li,article ol li{list-style:decimal;margin-left:24px}.wy-plain-list-decimal li p:last-child,.rst-content .section ol li p:last-child,.rst-content ol.arabic li p:last-child,article ol li p:last-child{margin-bottom:0}.wy-plain-list-decimal li ul,.rst-content .section ol li ul,.rst-content ol.arabic li ul,article ol li ul{margin-bottom:0}.wy-plain-list-decimal li ul li,.rst-content .section ol li ul li,.rst-content ol.arabic li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:before,.wy-breadcrumbs:after{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs li{display:inline-block}.wy-breadcrumbs li.wy-breadcrumbs-aside{float:right}.wy-breadcrumbs li a{display:inline-block;padding:5px}.wy-breadcrumbs li a:first-child{padding-left:0}.wy-breadcrumbs li code,.wy-breadcrumbs li .rst-content tt,.rst-content .wy-breadcrumbs li tt{padding:5px;border:none;background:none}.wy-breadcrumbs li code.literal,.wy-breadcrumbs li .rst-content tt.literal,.rst-content .wy-breadcrumbs li tt.literal{color:#404040}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width: 480px){.wy-breadcrumbs-extra{display:none}.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:before,.wy-menu-horiz:after{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz ul,.wy-menu-horiz li{display:inline-block}.wy-menu-horiz li:hover{background:rgba(255,255,255,0.1)}.wy-menu-horiz li.divide-left{border-left:solid 1px #404040}.wy-menu-horiz li.divide-right{border-right:solid 1px #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{height:32px;display:inline-block;line-height:32px;padding:0 1.618em;margin-bottom:0;display:block;font-weight:bold;text-transform:uppercase;font-size:80%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:solid 1px #404040}.wy-menu-vertical li.divide-bottom{border-bottom:solid 1px #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:gray;border-right:solid 1px #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.wy-menu-vertical li code,.wy-menu-vertical li .rst-content tt,.rst-content .wy-menu-vertical li tt{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li span.toctree-expand{display:block;float:left;margin-left:-1.2em;font-size:.8em;line-height:1.6em;color:#4d4d4d}.wy-menu-vertical li.on a,.wy-menu-vertical li.current>a{color:#404040;padding:.4045em 1.618em;font-weight:bold;position:relative;background:#fcfcfc;border:none;padding-left:1.618em -4px}.wy-menu-vertical li.on a:hover,.wy-menu-vertical li.current>a:hover{background:#fcfcfc}.wy-menu-vertical li.on a:hover span.toctree-expand,.wy-menu-vertical li.current>a:hover span.toctree-expand{color:gray}.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li.current>a span.toctree-expand{display:block;font-size:.8em;line-height:1.6em;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:solid 1px #c9c9c9;border-top:solid 1px #c9c9c9}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a{color:#404040}.wy-menu-vertical li.toctree-l1.current li.toctree-l2>ul,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>ul{display:none}.wy-menu-vertical li.toctree-l1.current li.toctree-l2.current>ul,.wy-menu-vertical li.toctree-l2.current li.toctree-l3.current>ul{display:block}.wy-menu-vertical li.toctree-l2.current>a{background:#c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{display:block;background:#c9c9c9;padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l2 a:hover span.toctree-expand{color:gray}.wy-menu-vertical li.toctree-l2 span.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3{font-size:.9em}.wy-menu-vertical li.toctree-l3.current>a{background:#bdbdbd;padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{display:block;background:#bdbdbd;padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l3 a:hover span.toctree-expand{color:gray}.wy-menu-vertical li.toctree-l3 span.toctree-expand{color:#969696}.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:normal}.wy-menu-vertical a{display:inline-block;line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover span.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980B9;cursor:pointer;color:#fff}.wy-menu-vertical a:active span.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980B9;text-align:center;padding:.809em;display:block;color:#fcfcfc;margin-bottom:.809em}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em auto;height:45px;width:45px;background-color:#2980B9;padding:5px;border-radius:100%}.wy-side-nav-search>a,.wy-side-nav-search .wy-dropdown>a{color:#fcfcfc;font-size:100%;font-weight:bold;display:inline-block;padding:4px 6px;margin-bottom:.809em}.wy-side-nav-search>a:hover,.wy-side-nav-search .wy-dropdown>a:hover{background:rgba(255,255,255,0.1)}.wy-side-nav-search>a img.logo,.wy-side-nav-search .wy-dropdown>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search>a.icon img.logo,.wy-side-nav-search .wy-dropdown>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:normal;color:rgba(255,255,255,0.3)}.wy-nav .wy-menu-vertical header{color:#2980B9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980B9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980B9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:before,.wy-nav-top:after{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:bold}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980B9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,0.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:gray}footer p{margin-bottom:12px}footer span.commit code,footer span.commit .rst-content tt,.rst-content footer span.commit tt{padding:0px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace;font-size:1em;background:none;border:none;color:gray}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:before,.rst-footer-buttons:after{width:100%}.rst-footer-buttons:before,.rst-footer-buttons:after{display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:before,.rst-breadcrumbs-buttons:after{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:solid 1px #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:solid 1px #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:gray;font-size:90%}@media screen and (max-width: 768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-side-scroll{width:auto}.wy-side-nav-search{width:auto}.wy-menu.wy-menu-vertical{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width: 1100px){.wy-nav-content-wrap{background:rgba(0,0,0,0.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,footer,.wy-nav-side{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;z-index:400}.rst-versions a{color:#2980B9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27AE60;*zoom:1}.rst-versions .rst-current-version:before,.rst-versions .rst-current-version:after{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .wy-menu-vertical li span.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version span.toctree-expand,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content p.caption .headerlink,.rst-content p.caption .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .icon{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#E74C3C;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#F1C40F;color:#000}.rst-versions.shift-up{height:auto;max-height:100%}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:gray;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:solid 1px #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px}.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge .rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width: 768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content img{max-width:100%;height:auto}.rst-content div.figure{margin-bottom:24px}.rst-content div.figure p.caption{font-style:italic}.rst-content div.figure p:last-child.caption{margin-bottom:0px}.rst-content div.figure.align-center{text-align:center}.rst-content .section>img,.rst-content .section>a>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px 12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace;display:block;overflow:auto}.rst-content pre.literal-block,.rst-content div[class^='highlight']{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px 0}.rst-content pre.literal-block div[class^='highlight'],.rst-content div[class^='highlight'] div[class^='highlight']{padding:0px;border:none;margin:0}.rst-content div[class^='highlight'] td.code{width:100%}.rst-content .linenodiv pre{border-right:solid 1px #e6e9ea;margin:0;padding:12px 12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^='highlight'] pre{white-space:pre;margin:0;padding:12px 12px;display:block;overflow:auto}.rst-content div[class^='highlight'] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content pre.literal-block,.rst-content div[class^='highlight'] pre,.rst-content .linenodiv pre{font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace;font-size:12px;line-height:1.4}@media print{.rst-content .codeblock,.rst-content div[class^='highlight'],.rst-content div[class^='highlight'] pre{white-space:pre-wrap}}.rst-content .note .last,.rst-content .attention .last,.rst-content .caution .last,.rst-content .danger .last,.rst-content .error .last,.rst-content .hint .last,.rst-content .important .last,.rst-content .tip .last,.rst-content .warning .last,.rst-content .seealso .last,.rst-content .admonition-todo .last,.rst-content .admonition .last{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,0.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent !important;border-color:rgba(0,0,0,0.1) !important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha li{list-style:upper-alpha}.rst-content .section ol p,.rst-content .section ul p{margin-bottom:12px}.rst-content .section ol p:last-child,.rst-content .section ul p:last-child{margin-bottom:24px}.rst-content .line-block{margin-left:0px;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0px}.rst-content .topic-title{font-weight:bold;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0px 0px 24px 24px}.rst-content .align-left{float:left;margin:0px 24px 24px 0px}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content .toctree-wrapper p.caption .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content dl dt .headerlink,.rst-content p.caption .headerlink,.rst-content table>caption .headerlink{visibility:hidden;font-size:14px}.rst-content h1 .headerlink:after,.rst-content h2 .headerlink:after,.rst-content .toctree-wrapper p.caption .headerlink:after,.rst-content h3 .headerlink:after,.rst-content h4 .headerlink:after,.rst-content h5 .headerlink:after,.rst-content h6 .headerlink:after,.rst-content dl dt .headerlink:after,.rst-content p.caption .headerlink:after,.rst-content table>caption .headerlink:after{content:"";font-family:FontAwesome}.rst-content h1:hover .headerlink:after,.rst-content h2:hover .headerlink:after,.rst-content .toctree-wrapper p.caption:hover .headerlink:after,.rst-content h3:hover .headerlink:after,.rst-content h4:hover .headerlink:after,.rst-content h5:hover .headerlink:after,.rst-content h6:hover .headerlink:after,.rst-content dl dt:hover .headerlink:after,.rst-content p.caption:hover .headerlink:after,.rst-content table>caption:hover .headerlink:after{visibility:visible}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:solid 1px #e1e4e5}.rst-content .sidebar p,.rst-content .sidebar ul,.rst-content .sidebar dl{font-size:90%}.rst-content .sidebar .last{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:"Roboto Slab","ff-tisa-web-pro","Georgia",Arial,sans-serif;font-weight:bold;background:#e1e4e5;padding:6px 12px;margin:-24px;margin-bottom:24px;font-size:100%}.rst-content .highlighted{background:#F1C40F;display:inline-block;font-weight:bold;padding:0 6px}.rst-content .footnote-reference,.rst-content .citation-reference{vertical-align:baseline;position:relative;top:-0.4em;line-height:0;font-size:90%}.rst-content table.docutils.citation,.rst-content table.docutils.footnote{background:none;border:none;color:gray}.rst-content table.docutils.citation td,.rst-content table.docutils.citation tr,.rst-content table.docutils.footnote td,.rst-content table.docutils.footnote tr{border:none;background-color:transparent !important;white-space:normal}.rst-content table.docutils.citation td.label,.rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}.rst-content table.docutils.citation tt,.rst-content table.docutils.citation code,.rst-content table.docutils.footnote tt,.rst-content table.docutils.footnote code{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}.rst-content table.docutils td .last,.rst-content table.docutils td .last :last-child{margin-bottom:0}.rst-content table.field-list{border:none}.rst-content table.field-list td{border:none}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content tt,.rst-content tt,.rst-content code{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace;padding:2px 5px}.rst-content tt big,.rst-content tt em,.rst-content tt big,.rst-content code big,.rst-content tt em,.rst-content code em{font-size:100% !important;line-height:normal}.rst-content tt.literal,.rst-content tt.literal,.rst-content code.literal{color:#E74C3C}.rst-content tt.xref,a .rst-content tt,.rst-content tt.xref,.rst-content code.xref,a .rst-content tt,a .rst-content code{font-weight:bold;color:#404040}.rst-content pre,.rst-content kbd,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace}.rst-content a tt,.rst-content a tt,.rst-content a code{color:#2980B9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:bold;margin-bottom:12px}.rst-content dl p,.rst-content dl table,.rst-content dl ul,.rst-content dl ol{margin-bottom:12px !important}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl:not(.docutils){margin-bottom:24px}.rst-content dl:not(.docutils) dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980B9;border-top:solid 3px #6ab0de;padding:6px;position:relative}.rst-content dl:not(.docutils) dt:before{color:#6ab0de}.rst-content dl:not(.docutils) dt .headerlink{color:#404040;font-size:100% !important}.rst-content dl:not(.docutils) dl dt{margin-bottom:6px;border:none;border-left:solid 3px #ccc;background:#f0f0f0;color:#555}.rst-content dl:not(.docutils) dl dt .headerlink{color:#404040;font-size:100% !important}.rst-content dl:not(.docutils) dt:first-child{margin-top:0}.rst-content dl:not(.docutils) tt,.rst-content dl:not(.docutils) tt,.rst-content dl:not(.docutils) code{font-weight:bold}.rst-content dl:not(.docutils) tt.descname,.rst-content dl:not(.docutils) tt.descclassname,.rst-content dl:not(.docutils) tt.descname,.rst-content dl:not(.docutils) code.descname,.rst-content dl:not(.docutils) tt.descclassname,.rst-content dl:not(.docutils) code.descclassname{background-color:transparent;border:none;padding:0;font-size:100% !important}.rst-content dl:not(.docutils) tt.descname,.rst-content dl:not(.docutils) tt.descname,.rst-content dl:not(.docutils) code.descname{font-weight:bold}.rst-content dl:not(.docutils) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:bold}.rst-content dl:not(.docutils) .property{display:inline-block;padding-right:8px}.rst-content .viewcode-link,.rst-content .viewcode-back{display:inline-block;color:#27AE60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:bold}.rst-content tt.download,.rst-content code.download{background:inherit;padding:inherit;font-weight:normal;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content tt.download span:first-child,.rst-content code.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content tt.download span:first-child:before,.rst-content code.download span:first-child:before{margin-right:4px}.rst-content .guilabel{border:1px solid #7fbbe3;background:#e7f2fa;font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .versionmodified{font-style:italic}@media screen and (max-width: 480px){.rst-content .sidebar{width:100%}}span[id*='MathJax-Span']{color:#404040}.math{text-align:center}@font-face{font-family:"Lato";src:url("../fonts/Lato/lato-regular.eot");src:url("../fonts/Lato/lato-regular.eot?#iefix") format("embedded-opentype"),url("../fonts/Lato/lato-regular.woff2") format("woff2"),url("../fonts/Lato/lato-regular.woff") format("woff"),url("../fonts/Lato/lato-regular.ttf") format("truetype");font-weight:400;font-style:normal}@font-face{font-family:"Lato";src:url("../fonts/Lato/lato-bold.eot");src:url("../fonts/Lato/lato-bold.eot?#iefix") format("embedded-opentype"),url("../fonts/Lato/lato-bold.woff2") format("woff2"),url("../fonts/Lato/lato-bold.woff") format("woff"),url("../fonts/Lato/lato-bold.ttf") format("truetype");font-weight:700;font-style:normal}@font-face{font-family:"Lato";src:url("../fonts/Lato/lato-bolditalic.eot");src:url("../fonts/Lato/lato-bolditalic.eot?#iefix") format("embedded-opentype"),url("../fonts/Lato/lato-bolditalic.woff2") format("woff2"),url("../fonts/Lato/lato-bolditalic.woff") format("woff"),url("../fonts/Lato/lato-bolditalic.ttf") format("truetype");font-weight:700;font-style:italic}@font-face{font-family:"Lato";src:url("../fonts/Lato/lato-italic.eot");src:url("../fonts/Lato/lato-italic.eot?#iefix") format("embedded-opentype"),url("../fonts/Lato/lato-italic.woff2") format("woff2"),url("../fonts/Lato/lato-italic.woff") format("woff"),url("../fonts/Lato/lato-italic.ttf") format("truetype");font-weight:400;font-style:italic}@font-face{font-family:"Roboto Slab";font-style:normal;font-weight:400;src:url("../fonts/RobotoSlab/roboto-slab.eot");src:url("../fonts/RobotoSlab/roboto-slab-v7-regular.eot?#iefix") format("embedded-opentype"),url("../fonts/RobotoSlab/roboto-slab-v7-regular.woff2") format("woff2"),url("../fonts/RobotoSlab/roboto-slab-v7-regular.woff") format("woff"),url("../fonts/RobotoSlab/roboto-slab-v7-regular.ttf") format("truetype")}@font-face{font-family:"Roboto Slab";font-style:normal;font-weight:700;src:url("../fonts/RobotoSlab/roboto-slab-v7-bold.eot");src:url("../fonts/RobotoSlab/roboto-slab-v7-bold.eot?#iefix") format("embedded-opentype"),url("../fonts/RobotoSlab/roboto-slab-v7-bold.woff2") format("woff2"),url("../fonts/RobotoSlab/roboto-slab-v7-bold.woff") format("woff"),url("../fonts/RobotoSlab/roboto-slab-v7-bold.ttf") format("truetype")} diff --git a/nsx/nsx_policy/_static/doctools.js b/nsx/nsx_policy/_static/doctools.js index d8928926..ffadbec1 100644 --- a/nsx/nsx_policy/_static/doctools.js +++ b/nsx/nsx_policy/_static/doctools.js @@ -150,7 +150,9 @@ var Documentation = { this.fixFirefoxAnchorBug(); this.highlightSearchWords(); this.initIndexTable(); - + if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) { + this.initOnKeyListeners(); + } }, /** @@ -310,4 +312,4 @@ _ = Documentation.gettext; $(document).ready(function() { Documentation.init(); -}); \ No newline at end of file +}); diff --git a/nsx/nsx_policy/_static/documentation_options.js b/nsx/nsx_policy/_static/documentation_options.js index 8ba230f5..1d8839f6 100644 --- a/nsx/nsx_policy/_static/documentation_options.js +++ b/nsx/nsx_policy/_static/documentation_options.js @@ -1,9 +1,296 @@ var DOCUMENTATION_OPTIONS = { - URL_ROOT: '', - VERSION: '2.2.0.0.0', + URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), + VERSION: '2.3.0.0.1', LANGUAGE: 'en', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true, - SOURCELINK_SUFFIX: '.txt' -}; \ No newline at end of file + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false, + SEARCH_LANGUAGE_STOP_WORDS: ["a","and","are","as","at","be","but","by","for","if","in","into","is","it","near","no","not","of","on","or","such","that","the","their","then","there","these","they","this","to","was","will","with"] +}; + + + +/* Non-minified version JS is _stemmer.js if file is provided */ +/** + * Porter Stemmer + */ +var Stemmer = function() { + + var step2list = { + ational: 'ate', + tional: 'tion', + enci: 'ence', + anci: 'ance', + izer: 'ize', + bli: 'ble', + alli: 'al', + entli: 'ent', + eli: 'e', + ousli: 'ous', + ization: 'ize', + ation: 'ate', + ator: 'ate', + alism: 'al', + iveness: 'ive', + fulness: 'ful', + ousness: 'ous', + aliti: 'al', + iviti: 'ive', + biliti: 'ble', + logi: 'log' + }; + + var step3list = { + icate: 'ic', + ative: '', + alize: 'al', + iciti: 'ic', + ical: 'ic', + ful: '', + ness: '' + }; + + var c = "[^aeiou]"; // consonant + var v = "[aeiouy]"; // vowel + var C = c + "[^aeiouy]*"; // consonant sequence + var V = v + "[aeiou]*"; // vowel sequence + + var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0 + var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 + var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 + var s_v = "^(" + C + ")?" + v; // vowel in stem + + this.stemWord = function (w) { + var stem; + var suffix; + var firstch; + var origword = w; + + if (w.length < 3) + return w; + + var re; + var re2; + var re3; + var re4; + + firstch = w.substr(0,1); + if (firstch == "y") + w = firstch.toUpperCase() + w.substr(1); + + // Step 1a + re = /^(.+?)(ss|i)es$/; + re2 = /^(.+?)([^s])s$/; + + if (re.test(w)) + w = w.replace(re,"$1$2"); + else if (re2.test(w)) + w = w.replace(re2,"$1$2"); + + // Step 1b + re = /^(.+?)eed$/; + re2 = /^(.+?)(ed|ing)$/; + if (re.test(w)) { + var fp = re.exec(w); + re = new RegExp(mgr0); + if (re.test(fp[1])) { + re = /.$/; + w = w.replace(re,""); + } + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1]; + re2 = new RegExp(s_v); + if (re2.test(stem)) { + w = stem; + re2 = /(at|bl|iz)$/; + re3 = new RegExp("([^aeiouylsz])\\1$"); + re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re2.test(w)) + w = w + "e"; + else if (re3.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + else if (re4.test(w)) + w = w + "e"; + } + } + + // Step 1c + re = /^(.+?)y$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(s_v); + if (re.test(stem)) + w = stem + "i"; + } + + // Step 2 + re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step2list[suffix]; + } + + // Step 3 + re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step3list[suffix]; + } + + // Step 4 + re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; + re2 = /^(.+?)(s|t)(ion)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + if (re.test(stem)) + w = stem; + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1] + fp[2]; + re2 = new RegExp(mgr1); + if (re2.test(stem)) + w = stem; + } + + // Step 5 + re = /^(.+?)e$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + re2 = new RegExp(meq1); + re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) + w = stem; + } + re = /ll$/; + re2 = new RegExp(mgr1); + if (re.test(w) && re2.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + + // and turn initial Y back to y + if (firstch == "y") + w = firstch.toLowerCase() + w.substr(1); + return w; + } +} + + + + + +var splitChars = (function() { + var result = {}; + var singles = [96, 180, 187, 191, 215, 247, 749, 885, 903, 907, 909, 930, 1014, 1648, + 1748, 1809, 2416, 2473, 2481, 2526, 2601, 2609, 2612, 2615, 2653, 2702, + 2706, 2729, 2737, 2740, 2857, 2865, 2868, 2910, 2928, 2948, 2961, 2971, + 2973, 3085, 3089, 3113, 3124, 3213, 3217, 3241, 3252, 3295, 3341, 3345, + 3369, 3506, 3516, 3633, 3715, 3721, 3736, 3744, 3748, 3750, 3756, 3761, + 3781, 3912, 4239, 4347, 4681, 4695, 4697, 4745, 4785, 4799, 4801, 4823, + 4881, 5760, 5901, 5997, 6313, 7405, 8024, 8026, 8028, 8030, 8117, 8125, + 8133, 8181, 8468, 8485, 8487, 8489, 8494, 8527, 11311, 11359, 11687, 11695, + 11703, 11711, 11719, 11727, 11735, 12448, 12539, 43010, 43014, 43019, 43587, + 43696, 43713, 64286, 64297, 64311, 64317, 64319, 64322, 64325, 65141]; + var i, j, start, end; + for (i = 0; i < singles.length; i++) { + result[singles[i]] = true; + } + var ranges = [[0, 47], [58, 64], [91, 94], [123, 169], [171, 177], [182, 184], [706, 709], + [722, 735], [741, 747], [751, 879], [888, 889], [894, 901], [1154, 1161], + [1318, 1328], [1367, 1368], [1370, 1376], [1416, 1487], [1515, 1519], [1523, 1568], + [1611, 1631], [1642, 1645], [1750, 1764], [1767, 1773], [1789, 1790], [1792, 1807], + [1840, 1868], [1958, 1968], [1970, 1983], [2027, 2035], [2038, 2041], [2043, 2047], + [2070, 2073], [2075, 2083], [2085, 2087], [2089, 2307], [2362, 2364], [2366, 2383], + [2385, 2391], [2402, 2405], [2419, 2424], [2432, 2436], [2445, 2446], [2449, 2450], + [2483, 2485], [2490, 2492], [2494, 2509], [2511, 2523], [2530, 2533], [2546, 2547], + [2554, 2564], [2571, 2574], [2577, 2578], [2618, 2648], [2655, 2661], [2672, 2673], + [2677, 2692], [2746, 2748], [2750, 2767], [2769, 2783], [2786, 2789], [2800, 2820], + [2829, 2830], [2833, 2834], [2874, 2876], [2878, 2907], [2914, 2917], [2930, 2946], + [2955, 2957], [2966, 2968], [2976, 2978], [2981, 2983], [2987, 2989], [3002, 3023], + [3025, 3045], [3059, 3076], [3130, 3132], [3134, 3159], [3162, 3167], [3170, 3173], + [3184, 3191], [3199, 3204], [3258, 3260], [3262, 3293], [3298, 3301], [3312, 3332], + [3386, 3388], [3390, 3423], [3426, 3429], [3446, 3449], [3456, 3460], [3479, 3481], + [3518, 3519], [3527, 3584], [3636, 3647], [3655, 3663], [3674, 3712], [3717, 3718], + [3723, 3724], [3726, 3731], [3752, 3753], [3764, 3772], [3774, 3775], [3783, 3791], + [3802, 3803], [3806, 3839], [3841, 3871], [3892, 3903], [3949, 3975], [3980, 4095], + [4139, 4158], [4170, 4175], [4182, 4185], [4190, 4192], [4194, 4196], [4199, 4205], + [4209, 4212], [4226, 4237], [4250, 4255], [4294, 4303], [4349, 4351], [4686, 4687], + [4702, 4703], [4750, 4751], [4790, 4791], [4806, 4807], [4886, 4887], [4955, 4968], + [4989, 4991], [5008, 5023], [5109, 5120], [5741, 5742], [5787, 5791], [5867, 5869], + [5873, 5887], [5906, 5919], [5938, 5951], [5970, 5983], [6001, 6015], [6068, 6102], + [6104, 6107], [6109, 6111], [6122, 6127], [6138, 6159], [6170, 6175], [6264, 6271], + [6315, 6319], [6390, 6399], [6429, 6469], [6510, 6511], [6517, 6527], [6572, 6592], + [6600, 6607], [6619, 6655], [6679, 6687], [6741, 6783], [6794, 6799], [6810, 6822], + [6824, 6916], [6964, 6980], [6988, 6991], [7002, 7042], [7073, 7085], [7098, 7167], + [7204, 7231], [7242, 7244], [7294, 7400], [7410, 7423], [7616, 7679], [7958, 7959], + [7966, 7967], [8006, 8007], [8014, 8015], [8062, 8063], [8127, 8129], [8141, 8143], + [8148, 8149], [8156, 8159], [8173, 8177], [8189, 8303], [8306, 8307], [8314, 8318], + [8330, 8335], [8341, 8449], [8451, 8454], [8456, 8457], [8470, 8472], [8478, 8483], + [8506, 8507], [8512, 8516], [8522, 8525], [8586, 9311], [9372, 9449], [9472, 10101], + [10132, 11263], [11493, 11498], [11503, 11516], [11518, 11519], [11558, 11567], + [11622, 11630], [11632, 11647], [11671, 11679], [11743, 11822], [11824, 12292], + [12296, 12320], [12330, 12336], [12342, 12343], [12349, 12352], [12439, 12444], + [12544, 12548], [12590, 12592], [12687, 12689], [12694, 12703], [12728, 12783], + [12800, 12831], [12842, 12880], [12896, 12927], [12938, 12976], [12992, 13311], + [19894, 19967], [40908, 40959], [42125, 42191], [42238, 42239], [42509, 42511], + [42540, 42559], [42592, 42593], [42607, 42622], [42648, 42655], [42736, 42774], + [42784, 42785], [42889, 42890], [42893, 43002], [43043, 43055], [43062, 43071], + [43124, 43137], [43188, 43215], [43226, 43249], [43256, 43258], [43260, 43263], + [43302, 43311], [43335, 43359], [43389, 43395], [43443, 43470], [43482, 43519], + [43561, 43583], [43596, 43599], [43610, 43615], [43639, 43641], [43643, 43647], + [43698, 43700], [43703, 43704], [43710, 43711], [43715, 43738], [43742, 43967], + [44003, 44015], [44026, 44031], [55204, 55215], [55239, 55242], [55292, 55295], + [57344, 63743], [64046, 64047], [64110, 64111], [64218, 64255], [64263, 64274], + [64280, 64284], [64434, 64466], [64830, 64847], [64912, 64913], [64968, 65007], + [65020, 65135], [65277, 65295], [65306, 65312], [65339, 65344], [65371, 65381], + [65471, 65473], [65480, 65481], [65488, 65489], [65496, 65497]]; + for (i = 0; i < ranges.length; i++) { + start = ranges[i][0]; + end = ranges[i][1]; + for (j = start; j <= end; j++) { + result[j] = true; + } + } + return result; +})(); + +function splitQuery(query) { + var result = []; + var start = -1; + for (var i = 0; i < query.length; i++) { + if (splitChars[query.charCodeAt(i)]) { + if (start !== -1) { + result.push(query.slice(start, i)); + start = -1; + } + } else if (start === -1) { + start = i; + } + } + if (start !== -1) { + result.push(query.slice(start)); + } + return result; +} + + diff --git a/nsx/nsx_policy/_static/fonts/Inconsolata-Bold.ttf b/nsx/nsx_policy/_static/fonts/Inconsolata-Bold.ttf index 9addc892..809c1f58 100644 Binary files a/nsx/nsx_policy/_static/fonts/Inconsolata-Bold.ttf and b/nsx/nsx_policy/_static/fonts/Inconsolata-Bold.ttf differ diff --git a/nsx/nsx_policy/_static/fonts/Inconsolata-Regular.ttf b/nsx/nsx_policy/_static/fonts/Inconsolata-Regular.ttf index 592ccd20..fc981ce7 100644 Binary files a/nsx/nsx_policy/_static/fonts/Inconsolata-Regular.ttf and b/nsx/nsx_policy/_static/fonts/Inconsolata-Regular.ttf differ diff --git a/nsx/nsx_policy/_static/fonts/Inconsolata.ttf b/nsx/nsx_policy/_static/fonts/Inconsolata.ttf new file mode 100644 index 00000000..4b8a36d2 Binary files /dev/null and b/nsx/nsx_policy/_static/fonts/Inconsolata.ttf differ diff --git a/nsx/nsx_policy/_static/fonts/Lato-BoldItalic.ttf b/nsx/nsx_policy/_static/fonts/Lato-BoldItalic.ttf deleted file mode 100644 index a3b8e332..00000000 Binary files a/nsx/nsx_policy/_static/fonts/Lato-BoldItalic.ttf and /dev/null differ diff --git a/nsx/nsx_policy/_static/fonts/Lato-Italic.ttf b/nsx/nsx_policy/_static/fonts/Lato-Italic.ttf deleted file mode 100644 index 70a870f4..00000000 Binary files a/nsx/nsx_policy/_static/fonts/Lato-Italic.ttf and /dev/null differ diff --git a/nsx/nsx_policy/_static/fonts/Lato/lato-bold.eot b/nsx/nsx_policy/_static/fonts/Lato/lato-bold.eot new file mode 100644 index 00000000..3361183a Binary files /dev/null and b/nsx/nsx_policy/_static/fonts/Lato/lato-bold.eot differ diff --git a/nsx/nsx_policy/_static/fonts/Lato/lato-bold.ttf b/nsx/nsx_policy/_static/fonts/Lato/lato-bold.ttf new file mode 100644 index 00000000..29f691d5 Binary files /dev/null and b/nsx/nsx_policy/_static/fonts/Lato/lato-bold.ttf differ diff --git a/nsx/nsx_policy/_static/fonts/Lato/lato-bold.woff b/nsx/nsx_policy/_static/fonts/Lato/lato-bold.woff new file mode 100644 index 00000000..c6dff51f Binary files /dev/null and b/nsx/nsx_policy/_static/fonts/Lato/lato-bold.woff differ diff --git a/nsx/nsx_policy/_static/fonts/Lato/lato-bold.woff2 b/nsx/nsx_policy/_static/fonts/Lato/lato-bold.woff2 new file mode 100644 index 00000000..bb195043 Binary files /dev/null and b/nsx/nsx_policy/_static/fonts/Lato/lato-bold.woff2 differ diff --git a/nsx/nsx_policy/_static/fonts/Lato/lato-bolditalic.eot b/nsx/nsx_policy/_static/fonts/Lato/lato-bolditalic.eot new file mode 100644 index 00000000..3d415493 Binary files /dev/null and b/nsx/nsx_policy/_static/fonts/Lato/lato-bolditalic.eot differ diff --git a/nsx/nsx_policy/_static/fonts/Lato/lato-bolditalic.ttf b/nsx/nsx_policy/_static/fonts/Lato/lato-bolditalic.ttf new file mode 100644 index 00000000..f402040b Binary files /dev/null and b/nsx/nsx_policy/_static/fonts/Lato/lato-bolditalic.ttf differ diff --git a/nsx/nsx_policy/_static/fonts/Lato/lato-bolditalic.woff b/nsx/nsx_policy/_static/fonts/Lato/lato-bolditalic.woff new file mode 100644 index 00000000..88ad05b9 Binary files /dev/null and b/nsx/nsx_policy/_static/fonts/Lato/lato-bolditalic.woff differ diff --git a/nsx/nsx_policy/_static/fonts/Lato/lato-bolditalic.woff2 b/nsx/nsx_policy/_static/fonts/Lato/lato-bolditalic.woff2 new file mode 100644 index 00000000..c4e3d804 Binary files /dev/null and b/nsx/nsx_policy/_static/fonts/Lato/lato-bolditalic.woff2 differ diff --git a/nsx/nsx_policy/_static/fonts/Lato/lato-italic.eot b/nsx/nsx_policy/_static/fonts/Lato/lato-italic.eot new file mode 100644 index 00000000..3f826421 Binary files /dev/null and b/nsx/nsx_policy/_static/fonts/Lato/lato-italic.eot differ diff --git a/nsx/nsx_policy/_static/fonts/Lato/lato-italic.ttf b/nsx/nsx_policy/_static/fonts/Lato/lato-italic.ttf new file mode 100644 index 00000000..b4bfc9b2 Binary files /dev/null and b/nsx/nsx_policy/_static/fonts/Lato/lato-italic.ttf differ diff --git a/nsx/nsx_policy/_static/fonts/Lato/lato-italic.woff b/nsx/nsx_policy/_static/fonts/Lato/lato-italic.woff new file mode 100644 index 00000000..76114bc0 Binary files /dev/null and b/nsx/nsx_policy/_static/fonts/Lato/lato-italic.woff differ diff --git a/nsx/nsx_policy/_static/fonts/Lato/lato-italic.woff2 b/nsx/nsx_policy/_static/fonts/Lato/lato-italic.woff2 new file mode 100644 index 00000000..3404f37e Binary files /dev/null and b/nsx/nsx_policy/_static/fonts/Lato/lato-italic.woff2 differ diff --git a/nsx/nsx_policy/_static/fonts/Lato/lato-regular.eot b/nsx/nsx_policy/_static/fonts/Lato/lato-regular.eot new file mode 100644 index 00000000..11e3f2a5 Binary files /dev/null and b/nsx/nsx_policy/_static/fonts/Lato/lato-regular.eot differ diff --git a/nsx/nsx_policy/_static/fonts/Lato/lato-regular.ttf b/nsx/nsx_policy/_static/fonts/Lato/lato-regular.ttf new file mode 100644 index 00000000..74decd9e Binary files /dev/null and b/nsx/nsx_policy/_static/fonts/Lato/lato-regular.ttf differ diff --git a/nsx/nsx_policy/_static/fonts/Lato/lato-regular.woff b/nsx/nsx_policy/_static/fonts/Lato/lato-regular.woff new file mode 100644 index 00000000..ae1307ff Binary files /dev/null and b/nsx/nsx_policy/_static/fonts/Lato/lato-regular.woff differ diff --git a/nsx/nsx_policy/_static/fonts/Lato/lato-regular.woff2 b/nsx/nsx_policy/_static/fonts/Lato/lato-regular.woff2 new file mode 100644 index 00000000..3bf98433 Binary files /dev/null and b/nsx/nsx_policy/_static/fonts/Lato/lato-regular.woff2 differ diff --git a/nsx/nsx_policy/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot b/nsx/nsx_policy/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot new file mode 100644 index 00000000..79dc8efe Binary files /dev/null and b/nsx/nsx_policy/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot differ diff --git a/nsx/nsx_policy/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf b/nsx/nsx_policy/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf new file mode 100644 index 00000000..df5d1df2 Binary files /dev/null and b/nsx/nsx_policy/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf differ diff --git a/nsx/nsx_policy/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff b/nsx/nsx_policy/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff new file mode 100644 index 00000000..6cb60000 Binary files /dev/null and b/nsx/nsx_policy/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff differ diff --git a/nsx/nsx_policy/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 b/nsx/nsx_policy/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 new file mode 100644 index 00000000..7059e231 Binary files /dev/null and b/nsx/nsx_policy/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 differ diff --git a/nsx/nsx_policy/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot b/nsx/nsx_policy/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot new file mode 100644 index 00000000..2f7ca78a Binary files /dev/null and b/nsx/nsx_policy/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot differ diff --git a/nsx/nsx_policy/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf b/nsx/nsx_policy/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf new file mode 100644 index 00000000..eb52a790 Binary files /dev/null and b/nsx/nsx_policy/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf differ diff --git a/nsx/nsx_policy/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff b/nsx/nsx_policy/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff new file mode 100644 index 00000000..f815f63f Binary files /dev/null and b/nsx/nsx_policy/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff differ diff --git a/nsx/nsx_policy/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 b/nsx/nsx_policy/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 new file mode 100644 index 00000000..f2c76e5b Binary files /dev/null and b/nsx/nsx_policy/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 differ diff --git a/nsx/nsx_policy/_static/js/theme.js b/nsx/nsx_policy/_static/js/theme.js index dc76fa63..96672c62 100644 --- a/nsx/nsx_policy/_static/js/theme.js +++ b/nsx/nsx_policy/_static/js/theme.js @@ -1 +1,3 @@ -require=function r(s,a,l){function c(i,n){if(!a[i]){if(!s[i]){var e="function"==typeof require&&require;if(!n&&e)return e(i,!0);if(u)return u(i,!0);var t=new Error("Cannot find module '"+i+"'");throw t.code="MODULE_NOT_FOUND",t}var o=a[i]={exports:{}};s[i][0].call(o.exports,function(n){var e=s[i][1][n];return c(e||n)},o,o.exports,r,s,a,l)}return a[i].exports}for(var u="function"==typeof require&&require,n=0;n"),i("table.docutils.footnote").wrap("
"),i("table.docutils.citation").wrap("
"),i(".wy-menu-vertical ul").not(".simple").siblings("a").each(function(){var e=i(this);expand=i(''),expand.on("click",function(n){return t.toggleCurrent(e),n.stopPropagation(),!1}),e.prepend(expand)})},reset:function(){var n=encodeURI(window.location.hash)||"#";try{var e=$(".wy-menu-vertical"),i=e.find('[href="'+n+'"]');if(0===i.length){var t=$('.document [id="'+n.substring(1)+'"]').closest("div.section");0===(i=e.find('[href="#'+t.attr("id")+'"]')).length&&(i=e.find('[href="#"]'))}0this.docHeight||(this.navBar.scrollTop(i),this.winPosition=n)},onResize:function(){this.winResize=!1,this.winHeight=this.win.height(),this.docHeight=$(document).height()},hashChange:function(){this.linkScroll=!0,this.win.one("hashchange",function(){this.linkScroll=!1})},toggleCurrent:function(n){var e=n.closest("li");e.siblings("li.current").removeClass("current"),e.siblings().find("li.current").removeClass("current"),e.find("> ul li.current").removeClass("current"),e.toggleClass("current")}},"undefined"!=typeof window&&(window.SphinxRtdTheme={Navigation:e.exports.ThemeNav}),function(){for(var r=0,n=["ms","moz","webkit","o"],e=0;e"),i("table.docutils.footnote").wrap("
"),i("table.docutils.citation").wrap("
"),i(".wy-menu-vertical ul").not(".simple").siblings("a").each(function(){var e=i(this);expand=i(''),expand.on("click",function(n){return t.toggleCurrent(e),n.stopPropagation(),!1}),e.prepend(expand)})},reset:function(){var n=encodeURI(window.location.hash)||"#";try{var e=$(".wy-menu-vertical"),i=e.find('[href="'+n+'"]');if(0===i.length){var t=$('.document [id="'+n.substring(1)+'"]').closest("div.section");0===(i=e.find('[href="#'+t.attr("id")+'"]')).length&&(i=e.find('[href="#"]'))}0this.docHeight||(this.navBar.scrollTop(i),this.winPosition=n)},onResize:function(){this.winResize=!1,this.winHeight=this.win.height(),this.docHeight=$(document).height()},hashChange:function(){this.linkScroll=!0,this.win.one("hashchange",function(){this.linkScroll=!1})},toggleCurrent:function(n){var e=n.closest("li");e.siblings("li.current").removeClass("current"),e.siblings().find("li.current").removeClass("current"),e.find("> ul li.current").removeClass("current"),e.toggleClass("current")}},"undefined"!=typeof window&&(window.SphinxRtdTheme={Navigation:e.exports.ThemeNav,StickyNav:e.exports.ThemeNav}),function(){for(var r=0,n=["ms","moz","webkit","o"],e=0;e0 - var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 - var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 - var s_v = "^(" + C + ")?" + v; // vowel in stem - - this.stemWord = function (w) { - var stem; - var suffix; - var firstch; - var origword = w; - - if (w.length < 3) - return w; - - var re; - var re2; - var re3; - var re4; - - firstch = w.substr(0,1); - if (firstch == "y") - w = firstch.toUpperCase() + w.substr(1); - - // Step 1a - re = /^(.+?)(ss|i)es$/; - re2 = /^(.+?)([^s])s$/; - - if (re.test(w)) - w = w.replace(re,"$1$2"); - else if (re2.test(w)) - w = w.replace(re2,"$1$2"); - - // Step 1b - re = /^(.+?)eed$/; - re2 = /^(.+?)(ed|ing)$/; - if (re.test(w)) { - var fp = re.exec(w); - re = new RegExp(mgr0); - if (re.test(fp[1])) { - re = /.$/; - w = w.replace(re,""); - } - } - else if (re2.test(w)) { - var fp = re2.exec(w); - stem = fp[1]; - re2 = new RegExp(s_v); - if (re2.test(stem)) { - w = stem; - re2 = /(at|bl|iz)$/; - re3 = new RegExp("([^aeiouylsz])\\1$"); - re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); - if (re2.test(w)) - w = w + "e"; - else if (re3.test(w)) { - re = /.$/; - w = w.replace(re,""); - } - else if (re4.test(w)) - w = w + "e"; - } - } - - // Step 1c - re = /^(.+?)y$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - re = new RegExp(s_v); - if (re.test(stem)) - w = stem + "i"; - } - - // Step 2 - re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - suffix = fp[2]; - re = new RegExp(mgr0); - if (re.test(stem)) - w = stem + step2list[suffix]; - } - - // Step 3 - re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - suffix = fp[2]; - re = new RegExp(mgr0); - if (re.test(stem)) - w = stem + step3list[suffix]; - } - - // Step 4 - re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; - re2 = /^(.+?)(s|t)(ion)$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - re = new RegExp(mgr1); - if (re.test(stem)) - w = stem; - } - else if (re2.test(w)) { - var fp = re2.exec(w); - stem = fp[1] + fp[2]; - re2 = new RegExp(mgr1); - if (re2.test(stem)) - w = stem; - } - - // Step 5 - re = /^(.+?)e$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - re = new RegExp(mgr1); - re2 = new RegExp(meq1); - re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); - if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) - w = stem; - } - re = /ll$/; - re2 = new RegExp(mgr1); - if (re.test(w) && re2.test(w)) { - re = /.$/; - w = w.replace(re,""); - } - - // and turn initial Y back to y - if (firstch == "y") - w = firstch.toLowerCase() + w.substr(1); - return w; +if (!splitQuery) { + function splitQuery(query) { + return query.split(/\s+/); } } - - -/** - * Simple result scoring code. - */ -var Scorer = { - // Implement the following function to further tweak the score for each result - // The function takes a result array [filename, title, anchor, descr, score] - // and returns the new score. - /* - score: function(result) { - return result[4]; - }, - */ - - // query matches the full name of an object - objNameMatch: 11, - // or matches in the last dotted part of the object name - objPartialMatch: 6, - // Additive scores depending on the priority of the object - objPrio: {0: 15, // used to be importantResults - 1: 5, // used to be objectResults - 2: -5}, // used to be unimportantResults - // Used when the priority is not in the mapping. - objPrioDefault: 0, - - // query found in title - title: 15, - // query found in terms - term: 5 -}; - - - - - -var splitChars = (function() { - var result = {}; - var singles = [96, 180, 187, 191, 215, 247, 749, 885, 903, 907, 909, 930, 1014, 1648, - 1748, 1809, 2416, 2473, 2481, 2526, 2601, 2609, 2612, 2615, 2653, 2702, - 2706, 2729, 2737, 2740, 2857, 2865, 2868, 2910, 2928, 2948, 2961, 2971, - 2973, 3085, 3089, 3113, 3124, 3213, 3217, 3241, 3252, 3295, 3341, 3345, - 3369, 3506, 3516, 3633, 3715, 3721, 3736, 3744, 3748, 3750, 3756, 3761, - 3781, 3912, 4239, 4347, 4681, 4695, 4697, 4745, 4785, 4799, 4801, 4823, - 4881, 5760, 5901, 5997, 6313, 7405, 8024, 8026, 8028, 8030, 8117, 8125, - 8133, 8181, 8468, 8485, 8487, 8489, 8494, 8527, 11311, 11359, 11687, 11695, - 11703, 11711, 11719, 11727, 11735, 12448, 12539, 43010, 43014, 43019, 43587, - 43696, 43713, 64286, 64297, 64311, 64317, 64319, 64322, 64325, 65141]; - var i, j, start, end; - for (i = 0; i < singles.length; i++) { - result[singles[i]] = true; - } - var ranges = [[0, 47], [58, 64], [91, 94], [123, 169], [171, 177], [182, 184], [706, 709], - [722, 735], [741, 747], [751, 879], [888, 889], [894, 901], [1154, 1161], - [1318, 1328], [1367, 1368], [1370, 1376], [1416, 1487], [1515, 1519], [1523, 1568], - [1611, 1631], [1642, 1645], [1750, 1764], [1767, 1773], [1789, 1790], [1792, 1807], - [1840, 1868], [1958, 1968], [1970, 1983], [2027, 2035], [2038, 2041], [2043, 2047], - [2070, 2073], [2075, 2083], [2085, 2087], [2089, 2307], [2362, 2364], [2366, 2383], - [2385, 2391], [2402, 2405], [2419, 2424], [2432, 2436], [2445, 2446], [2449, 2450], - [2483, 2485], [2490, 2492], [2494, 2509], [2511, 2523], [2530, 2533], [2546, 2547], - [2554, 2564], [2571, 2574], [2577, 2578], [2618, 2648], [2655, 2661], [2672, 2673], - [2677, 2692], [2746, 2748], [2750, 2767], [2769, 2783], [2786, 2789], [2800, 2820], - [2829, 2830], [2833, 2834], [2874, 2876], [2878, 2907], [2914, 2917], [2930, 2946], - [2955, 2957], [2966, 2968], [2976, 2978], [2981, 2983], [2987, 2989], [3002, 3023], - [3025, 3045], [3059, 3076], [3130, 3132], [3134, 3159], [3162, 3167], [3170, 3173], - [3184, 3191], [3199, 3204], [3258, 3260], [3262, 3293], [3298, 3301], [3312, 3332], - [3386, 3388], [3390, 3423], [3426, 3429], [3446, 3449], [3456, 3460], [3479, 3481], - [3518, 3519], [3527, 3584], [3636, 3647], [3655, 3663], [3674, 3712], [3717, 3718], - [3723, 3724], [3726, 3731], [3752, 3753], [3764, 3772], [3774, 3775], [3783, 3791], - [3802, 3803], [3806, 3839], [3841, 3871], [3892, 3903], [3949, 3975], [3980, 4095], - [4139, 4158], [4170, 4175], [4182, 4185], [4190, 4192], [4194, 4196], [4199, 4205], - [4209, 4212], [4226, 4237], [4250, 4255], [4294, 4303], [4349, 4351], [4686, 4687], - [4702, 4703], [4750, 4751], [4790, 4791], [4806, 4807], [4886, 4887], [4955, 4968], - [4989, 4991], [5008, 5023], [5109, 5120], [5741, 5742], [5787, 5791], [5867, 5869], - [5873, 5887], [5906, 5919], [5938, 5951], [5970, 5983], [6001, 6015], [6068, 6102], - [6104, 6107], [6109, 6111], [6122, 6127], [6138, 6159], [6170, 6175], [6264, 6271], - [6315, 6319], [6390, 6399], [6429, 6469], [6510, 6511], [6517, 6527], [6572, 6592], - [6600, 6607], [6619, 6655], [6679, 6687], [6741, 6783], [6794, 6799], [6810, 6822], - [6824, 6916], [6964, 6980], [6988, 6991], [7002, 7042], [7073, 7085], [7098, 7167], - [7204, 7231], [7242, 7244], [7294, 7400], [7410, 7423], [7616, 7679], [7958, 7959], - [7966, 7967], [8006, 8007], [8014, 8015], [8062, 8063], [8127, 8129], [8141, 8143], - [8148, 8149], [8156, 8159], [8173, 8177], [8189, 8303], [8306, 8307], [8314, 8318], - [8330, 8335], [8341, 8449], [8451, 8454], [8456, 8457], [8470, 8472], [8478, 8483], - [8506, 8507], [8512, 8516], [8522, 8525], [8586, 9311], [9372, 9449], [9472, 10101], - [10132, 11263], [11493, 11498], [11503, 11516], [11518, 11519], [11558, 11567], - [11622, 11630], [11632, 11647], [11671, 11679], [11743, 11822], [11824, 12292], - [12296, 12320], [12330, 12336], [12342, 12343], [12349, 12352], [12439, 12444], - [12544, 12548], [12590, 12592], [12687, 12689], [12694, 12703], [12728, 12783], - [12800, 12831], [12842, 12880], [12896, 12927], [12938, 12976], [12992, 13311], - [19894, 19967], [40908, 40959], [42125, 42191], [42238, 42239], [42509, 42511], - [42540, 42559], [42592, 42593], [42607, 42622], [42648, 42655], [42736, 42774], - [42784, 42785], [42889, 42890], [42893, 43002], [43043, 43055], [43062, 43071], - [43124, 43137], [43188, 43215], [43226, 43249], [43256, 43258], [43260, 43263], - [43302, 43311], [43335, 43359], [43389, 43395], [43443, 43470], [43482, 43519], - [43561, 43583], [43596, 43599], [43610, 43615], [43639, 43641], [43643, 43647], - [43698, 43700], [43703, 43704], [43710, 43711], [43715, 43738], [43742, 43967], - [44003, 44015], [44026, 44031], [55204, 55215], [55239, 55242], [55292, 55295], - [57344, 63743], [64046, 64047], [64110, 64111], [64218, 64255], [64263, 64274], - [64280, 64284], [64434, 64466], [64830, 64847], [64912, 64913], [64968, 65007], - [65020, 65135], [65277, 65295], [65306, 65312], [65339, 65344], [65371, 65381], - [65471, 65473], [65480, 65481], [65488, 65489], [65496, 65497]]; - for (i = 0; i < ranges.length; i++) { - start = ranges[i][0]; - end = ranges[i][1]; - for (j = start; j <= end; j++) { - result[j] = true; - } - } - return result; -})(); - -function splitQuery(query) { - var result = []; - var start = -1; - for (var i = 0; i < query.length; i++) { - if (splitChars[query.charCodeAt(i)]) { - if (start !== -1) { - result.push(query.slice(start, i)); - start = -1; - } - } else if (start === -1) { - start = i; - } - } - if (start !== -1) { - result.push(query.slice(start)); - } - return result; -} - - - - /** * Search Module */ @@ -417,7 +138,7 @@ var Search = { */ query : function(query) { var i; - var stopwords = ["a","and","are","as","at","be","but","by","for","if","in","into","is","it","near","no","not","of","on","or","such","that","the","their","then","there","these","they","this","to","was","will","with"]; + var stopwords = DOCUMENTATION_OPTIONS.SEARCH_LANGUAGE_STOP_WORDS; // stem the searchterms and add them to the correct list var stemmer = new Stemmer(); @@ -758,4 +479,4 @@ var Search = { $(document).ready(function() { Search.init(); -}); \ No newline at end of file +}); diff --git a/nsx/nsx_policy/com.html b/nsx/nsx_policy/com.html index 9e1e6db0..a64a1dc2 100644 --- a/nsx/nsx_policy/com.html +++ b/nsx/nsx_policy/com.html @@ -8,7 +8,7 @@ - com package — NSX-T Policy SDK 2.2.0.0.0 documentation + com package — NSX-T Policy SDK 2.3.0.0.1 documentation @@ -24,8 +24,7 @@ - - + @@ -59,7 +58,7 @@
- 2.2.0.0.0 + 2.3.0.0.1
@@ -184,6 +183,7 @@
  • Subpackages -
    • -
  • com.vmware.nsx_policy.infra.networks package -
    • -
  • com.vmware.nsx_policy.infra.providers package
  • com.vmware.nsx_policy.infra.realized_state package
    • +
  • com.vmware.nsx_policy.infra.tier_0s package +
    • +
  • com.vmware.nsx_policy.infra.tier_1s package +
  • Submodules
  • com.vmware.nsx_policy.infra.deployment_zones_client module
  • com.vmware.nsx_policy.infra.domains_client module
    • -
  • com.vmware.nsx_policy.infra.networks_client module
  • com.vmware.nsx_policy.infra.partner_services_client module
    • -
  • com.vmware.nsx_policy.infra.providers_client module
  • com.vmware.nsx_policy.infra.realized_state_client module
  • com.vmware.nsx_policy.infra.services_client module
    • +
  • com.vmware.nsx_policy.infra.tier_0s_client module
    • +
  • com.vmware.nsx_policy.infra.tier_1s_client module
    • @@ -267,6 +276,7 @@
  • com.vmware.nsx_policy.licenses_client module
  • com.vmware.nsx_policy.model_client module
  • com.vmware.nsx_policy.tasks_client module
    • +
  • com.vmware.nsx_policy.telemetry_client module
  • com.vmware.nsx_policy.trust_management_client module
  • com.vmware.nsx_policy.upgrade_client module
    • @@ -275,6 +285,7 @@
  • Submodules
  • com.vmware.nsx_policy_client module
    • +
  • com.vmware.nsx_policy_client_for_vmc module
    • @@ -302,7 +313,7 @@

    - © Copyright 2018, VMware, Inc.. + © Copyright 2018, VMware, Inc.

    @@ -321,33 +332,22 @@ - - - - + + + + + + + + - - - - + diff --git a/nsx/nsx_policy/com.vmware.html b/nsx/nsx_policy/com.vmware.html index e1a75dca..bde3bda8 100644 --- a/nsx/nsx_policy/com.vmware.html +++ b/nsx/nsx_policy/com.vmware.html @@ -8,7 +8,7 @@ - com.vmware package — NSX-T Policy SDK 2.2.0.0.0 documentation + com.vmware package — NSX-T Policy SDK 2.3.0.0.1 documentation @@ -24,8 +24,7 @@ - - + @@ -59,7 +58,7 @@
    - 2.2.0.0.0 + 2.3.0.0.1
    @@ -91,6 +90,7 @@
  • Subpackages
  • Submodules
  • com.vmware.nsx_policy_client module
    • +
  • com.vmware.nsx_policy_client_for_vmc module
    • @@ -189,6 +189,7 @@
  • Subpackages -
    • -
  • com.vmware.nsx_policy.infra.networks package -
    • -
  • com.vmware.nsx_policy.infra.providers package
  • com.vmware.nsx_policy.infra.realized_state package
    • +
  • com.vmware.nsx_policy.infra.tier_0s package +
    • +
  • com.vmware.nsx_policy.infra.tier_1s package +
  • Submodules
  • com.vmware.nsx_policy.infra.deployment_zones_client module
  • com.vmware.nsx_policy.infra.domains_client module
    • -
  • com.vmware.nsx_policy.infra.networks_client module
  • com.vmware.nsx_policy.infra.partner_services_client module
    • -
  • com.vmware.nsx_policy.infra.providers_client module
  • com.vmware.nsx_policy.infra.realized_state_client module
  • com.vmware.nsx_policy.infra.services_client module
    • +
  • com.vmware.nsx_policy.infra.tier_0s_client module
    • +
  • com.vmware.nsx_policy.infra.tier_1s_client module
    • @@ -272,6 +282,7 @@
  • com.vmware.nsx_policy.licenses_client module
  • com.vmware.nsx_policy.model_client module
  • com.vmware.nsx_policy.tasks_client module
    • +
  • com.vmware.nsx_policy.telemetry_client module
  • com.vmware.nsx_policy.trust_management_client module
  • com.vmware.nsx_policy.upgrade_client module
    • @@ -288,6 +299,14 @@
    class com.vmware.nsx_policy_client.Batch(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    create(batch_request, atomic=None)
    @@ -347,6 +366,14 @@ Not Found

    class com.vmware.nsx_policy_client.Cluster(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    backuptoremote()
    @@ -439,45 +466,20 @@ Not Found
    -
    -
    -update(cluster_config)
    -

    Modifies the NSX cluster configuration.

    - --- - - - - - - - - - - - - - - - - - -
    Parameters:cluster_config (com.vmware.nsx_policy.model_client.ClusterConfig) – (required)
    Return type:com.vmware.nsx_policy.model_client.ClusterConfig
    Returns:com.vmware.nsx_policy.model.ClusterConfig
    Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable
    Raise:com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed
    Raise:com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error
    Raise:com.vmware.vapi.std.errors_client.Unauthorized -Forbidden
    Raise:com.vmware.vapi.std.errors_client.NotFound -Not Found
    -
    -
    class com.vmware.nsx_policy_client.ErrorResolver(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    get(error_id)
    @@ -580,6 +582,14 @@ Not Found
    class com.vmware.nsx_policy_client.Infra(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    get(filter=None)
    @@ -682,6 +692,14 @@ Not Found
    class com.vmware.nsx_policy_client.Licenses(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    create(license)
    @@ -913,12 +931,29 @@ Not Found
    class com.vmware.nsx_policy_client.StubFactory(stub_config)

    Bases: vmware.vapi.bindings.stub.StubFactoryBase

    +

    Initialize StubFactoryBase

    + +++ + + + +
    Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
    class com.vmware.nsx_policy_client.Tasks(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    get(task_id)
    @@ -1011,6 +1046,14 @@ Not Found

    class com.vmware.nsx_policy_client.Templates(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    delete(template_id)
    @@ -1209,6 +1252,14 @@ Not Found

    class com.vmware.nsx_policy_client.TrustManagement(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    get()
    @@ -1242,6 +1293,144 @@ Not Found
    + +
    +

    com.vmware.nsx_policy_client_for_vmc module

    +

    Convenience methods to get API clients for NSX APIs in VMC

    +
    +
    +class com.vmware.nsx_policy_client_for_vmc.CSPSecurityContextFilter(session, refresh_token, refresh_url)
    +

    Bases: vmware.vapi.security.client.security_context_filter.SecurityContextFilter

    +

    CSP Security Context filter in API Provider chain adds the security +context based on a refresh token to the execution context passed in.

    +

    Initialize SecurityContextFilter

    + +++ + + + +
    Parameters:
      +
    • session (requests.Session) – Requests Session object to use for making HTTP calls
      • +
    • refresh_token (str) – Refresh token to use for obtaining an access +token
      • +
    • refresh_url (str) – URL that allows exchanging a refresh token for an +access token
      • +
    +
    +
    +
    +get_max_retries()
    +

    Get the max number of retries

    + +++ + + + + + +
    Return type:int
    Returns:Number of retries
    +
    + +
    +
    +get_security_context(on_error)
    +

    Retrieve security context. If this method is called after an error +occured, then a new access token is obtained using the refresh +token and a new security context is created.

    + +++ + + + + + + + +
    Parameters:on_error (bool) – Whether this method is called after getting an error
    Return type:vmware.vapi.core.SecurityContext
    Returns:Security context
    +
    + +
    +
    +should_retry(error_value)
    +

    Returns whether the request should be retried or not based on the error +specified.

    + +++ + + + + + + + +
    Parameters:error_value (vmware.vapi.data.value.ErrorValue) – Method error
    Return type:bool
    Returns:Returns True if request should be retried in case the error is +either Unauthenticated or Unauthorized else False
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy_client_for_vmc.VmcNsxClient(stub_factory_class, session, refresh_token, vmc_url, csp_url, org_id, sddc_id)
    +

    Bases: vmware.vapi.bindings.stub.ApiClient

    +

    Client class that providess access to stubs for all the services in the +VMC NSX API

    +

    Initialize VmcClient by creating a stub factory instance using a CSP +Security context filter added to the filter chain of the connector

    + +++ + + + +
    Parameters:
      +
    • stub_factory_class (type) – Which stub factory class to use
      • +
    • session (requests.Session) – Requests HTTP session instance
      • +
    • refresh_token (str) – Refresh token obtained from CSP
      • +
    • vmc_url (str) – URL of the VMC service
      • +
    • csp_url (str) – URL of the CSP service
      • +
    • org_id (str) – ID of the VMC organization
      • +
    • sddc_id (str) – ID of the VMC Software-Defined Data Center (SDDC)
      • +
    +
    +
    + +
    +
    +com.vmware.nsx_policy_client_for_vmc.create_nsx_policy_client_for_vmc(refresh_token, org_id, sddc_id, session=None)
    +

    Helper method to create an instance of the VMC NSX Policy API client

    + +++ + + + + + + + +
    Parameters:
      +
    • refresh_token (str) – Refresh token obtained from CSP
      • +
    • org_id (str) – ID of the VMC organization
      • +
    • sddc_id (str) – ID of the VMC Software-Defined Data Center (SDDC)
      • +
    • session (requests.Session or None) – Requests HTTP session instance. If not specified, then one +is automatically created and used
      • +
    +
    Return type:

    vmware.vapi.vmc.client.VmcNsxClient

    +
    Returns:

    VMC NSX Client instance

    +
    +
    +
    @@ -1265,7 +1454,7 @@ Not Found

    - © Copyright 2018, VMware, Inc.. + © Copyright 2018, VMware, Inc.

    @@ -1284,33 +1473,22 @@ Not Found - - - - + + + + + + + + - - - - + diff --git a/nsx/nsx_policy/com.vmware.nsx_policy.aaa.html b/nsx/nsx_policy/com.vmware.nsx_policy.aaa.html index 3a89559c..ac4519b3 100644 --- a/nsx/nsx_policy/com.vmware.nsx_policy.aaa.html +++ b/nsx/nsx_policy/com.vmware.nsx_policy.aaa.html @@ -8,7 +8,7 @@ - com.vmware.nsx_policy.aaa package — NSX-T Policy SDK 2.2.0.0.0 documentation + com.vmware.nsx_policy.aaa package — NSX-T Policy SDK 2.3.0.0.1 documentation @@ -24,8 +24,7 @@ - - + @@ -59,7 +58,7 @@
    - 2.2.0.0.0 + 2.3.0.0.1
    @@ -91,6 +90,7 @@
  • Subpackages
  • Submodules
  • com.vmware.nsx_policy_client module
    • +
  • com.vmware.nsx_policy_client_for_vmc module
    • @@ -178,6 +178,14 @@
    class com.vmware.nsx_policy.aaa.vidm_client.Groups(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    list(search_string, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    @@ -237,6 +245,14 @@ Not Found

    class com.vmware.nsx_policy.aaa.vidm_client.Search(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    create(search_string, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    @@ -297,12 +313,29 @@ Not Found

    class com.vmware.nsx_policy.aaa.vidm_client.StubFactory(stub_config)

    Bases: vmware.vapi.bindings.stub.StubFactoryBase

    +

    Initialize StubFactoryBase

    + +++ + + + +
    Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
    class com.vmware.nsx_policy.aaa.vidm_client.Users(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    list(search_string, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    @@ -382,7 +415,7 @@ Not Found

    - © Copyright 2018, VMware, Inc.. + © Copyright 2018, VMware, Inc.

    @@ -401,33 +434,22 @@ Not Found

    - - - - + + + + + + + + - - - - + diff --git a/nsx/nsx_policy/com.vmware.nsx_policy.cluster.html b/nsx/nsx_policy/com.vmware.nsx_policy.cluster.html index 15b7c6cb..81dd1f54 100644 --- a/nsx/nsx_policy/com.vmware.nsx_policy.cluster.html +++ b/nsx/nsx_policy/com.vmware.nsx_policy.cluster.html @@ -8,7 +8,7 @@ - com.vmware.nsx_policy.cluster package — NSX-T Policy SDK 2.2.0.0.0 documentation + com.vmware.nsx_policy.cluster package — NSX-T Policy SDK 2.3.0.0.1 documentation @@ -24,8 +24,7 @@ - - + @@ -59,7 +58,7 @@
    - 2.2.0.0.0 + 2.3.0.0.1
    @@ -91,6 +90,7 @@
  • Subpackages
  • Submodules
  • com.vmware.nsx_policy_client module
    • +
  • com.vmware.nsx_policy_client_for_vmc module
    • @@ -178,6 +178,14 @@
    class com.vmware.nsx_policy.cluster.backups_client.Config(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    get()
    @@ -250,6 +258,14 @@ Not Found
    class com.vmware.nsx_policy.cluster.backups_client.History(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    get()
    @@ -287,6 +303,14 @@ Not Found
    class com.vmware.nsx_policy.cluster.backups_client.Status(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    get()
    @@ -324,6 +348,15 @@ Not Found
    class com.vmware.nsx_policy.cluster.backups_client.StubFactory(stub_config)

    Bases: vmware.vapi.bindings.stub.StubFactoryBase

    +

    Initialize StubFactoryBase

    + +++ + + + +
    Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
    @@ -333,6 +366,14 @@ Not Found
    class com.vmware.nsx_policy.cluster.nodes_client.Status(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    GET_SOURCE_CACHED = 'cached'
    @@ -426,6 +467,15 @@ Not Found
    class com.vmware.nsx_policy.cluster.nodes_client.StubFactory(stub_config)

    Bases: vmware.vapi.bindings.stub.StubFactoryBase

    +

    Initialize StubFactoryBase

    + +++ + + + +
    Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
    @@ -435,6 +485,14 @@ Not Found
    class com.vmware.nsx_policy.cluster.restore_client.Backuptimestamps(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    get(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    @@ -492,6 +550,14 @@ Not Found

    class com.vmware.nsx_policy.cluster.restore_client.Config(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    get()
    @@ -565,6 +631,14 @@ Not Found
    class com.vmware.nsx_policy.cluster.restore_client.InstructionResources(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    get(instruction_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    @@ -625,6 +699,15 @@ Not Found

    class com.vmware.nsx_policy.cluster.restore_client.StubFactory(stub_config)

    Bases: vmware.vapi.bindings.stub.StubFactoryBase

    +

    Initialize StubFactoryBase

    + +++ + + + +
    Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
    @@ -650,7 +733,7 @@ Not Found

    - © Copyright 2018, VMware, Inc.. + © Copyright 2018, VMware, Inc.

    @@ -669,33 +752,22 @@ Not Found

    - - - - + + + + + + + + - - - - + diff --git a/nsx/nsx_policy/com.vmware.nsx_policy.html b/nsx/nsx_policy/com.vmware.nsx_policy.html index 4108b77f..f8a4fa02 100644 --- a/nsx/nsx_policy/com.vmware.nsx_policy.html +++ b/nsx/nsx_policy/com.vmware.nsx_policy.html @@ -8,7 +8,7 @@ - com.vmware.nsx_policy package — NSX-T Policy SDK 2.2.0.0.0 documentation + com.vmware.nsx_policy package — NSX-T Policy SDK 2.3.0.0.1 documentation @@ -24,8 +24,7 @@ - - + @@ -59,7 +58,7 @@
    - 2.2.0.0.0 + 2.3.0.0.1
    @@ -91,6 +90,7 @@
  • Subpackages
  • Submodules
  • com.vmware.nsx_policy_client module
    • +
  • com.vmware.nsx_policy_client_for_vmc module
    • @@ -189,6 +189,7 @@
  • Subpackages -
    • -
  • com.vmware.nsx_policy.infra.networks package -
    • -
  • com.vmware.nsx_policy.infra.providers package
  • com.vmware.nsx_policy.infra.realized_state package
    • +
  • com.vmware.nsx_policy.infra.tier_0s package +
    • +
  • com.vmware.nsx_policy.infra.tier_1s package +
  • Submodules
  • com.vmware.nsx_policy.infra.deployment_zones_client module
  • com.vmware.nsx_policy.infra.domains_client module
    • -
  • com.vmware.nsx_policy.infra.networks_client module
  • com.vmware.nsx_policy.infra.partner_services_client module
    • -
  • com.vmware.nsx_policy.infra.providers_client module
  • com.vmware.nsx_policy.infra.realized_state_client module
  • com.vmware.nsx_policy.infra.services_client module
    • +
  • com.vmware.nsx_policy.infra.tier_0s_client module
    • +
  • com.vmware.nsx_policy.infra.tier_1s_client module
    • @@ -272,6 +282,14 @@
    class com.vmware.nsx_policy.aaa_client.RegistrationToken(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    create()
    @@ -372,6 +390,14 @@ Not Found
    class com.vmware.nsx_policy.aaa_client.RoleBindings(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    LIST_TYPE_LOCAL_USER = 'local_user'
    @@ -458,6 +484,33 @@ Not Found
    +
    +
    +deletestalebindings()
    +

    Delete all stale role assignments

    + +++ + + + + + + + + + + + +
    Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
    Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
    Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
    Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
    Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
    +
    +
    get(binding_id)
    @@ -593,6 +646,14 @@ Not Found

    class com.vmware.nsx_policy.aaa_client.Roles(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    get(role)
    @@ -663,12 +724,29 @@ Not Found
    class com.vmware.nsx_policy.aaa_client.StubFactory(stub_config)

    Bases: vmware.vapi.bindings.stub.StubFactoryBase

    +

    Initialize StubFactoryBase

    + +++ + + + +
    Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
    class com.vmware.nsx_policy.aaa_client.UserInfo(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    get()
    @@ -710,6 +788,14 @@ Not Found
    class com.vmware.nsx_policy.cluster_client.Backups(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    retrievesshfingerprint(remote_server_fingerprint_request)
    @@ -750,6 +836,14 @@ Not Found
    class com.vmware.nsx_policy.cluster_client.Nodes(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    CREATE_ACTION_NODE = 'add_cluster_node'
    @@ -759,9 +853,7 @@ Not Found
    create(add_cluster_node_spec, action)
    -

    Adds a new management node or controller node to the NSX cluster. A -single node can perform one role, either management or control, not -both.

    +

    Adds a new controller node to the NSX cluster.

    @@ -805,10 +897,9 @@ Not Found

    delete(node_id)
    -

    Removes the specified manager or control node from the NSX cluster. -Before you can remove a node from the cluster, you must shut down the -manager or controller service with the "stop service manager" -or the "stop service controller" command.

    +

    Removes the specified controller node from the NSX cluster. Before you +can remove a controller node from the cluster, you must shut down the +controller service with the "stop service controller" command.

    @@ -917,41 +1008,20 @@ Not Found

    -
    -
    -revokemissingnodes(revoke_node_request)
    -

    Revoke Missing Nodes from the Cluster

    - --- - - - - - - - - - - - - - -
    Parameters:revoke_node_request (com.vmware.nsx_policy.model_client.RevokeNodeRequest) – (required)
    Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable
    Raise:com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed
    Raise:com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error
    Raise:com.vmware.vapi.std.errors_client.Unauthorized -Forbidden
    Raise:com.vmware.vapi.std.errors_client.NotFound -Not Found
    -
    -
    class com.vmware.nsx_policy.cluster_client.Restore(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    advance(advance_cluster_restore_request)
    @@ -1154,6 +1224,14 @@ Not Found
    class com.vmware.nsx_policy.cluster_client.Status(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    GET_SOURCE_CACHED = 'cached'
    @@ -1206,6 +1284,15 @@ Not Found
    class com.vmware.nsx_policy.cluster_client.StubFactory(stub_config)

    Bases: vmware.vapi.bindings.stub.StubFactoryBase

    +

    Initialize StubFactoryBase

    + +++ + + + +
    Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
    @@ -1215,6 +1302,14 @@ Not Found
    class com.vmware.nsx_policy.configs_client.Management(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    get()
    @@ -1285,6 +1380,15 @@ Not Found
    class com.vmware.nsx_policy.configs_client.StubFactory(stub_config)

    Bases: vmware.vapi.bindings.stub.StubFactoryBase

    +

    Initialize StubFactoryBase

    + +++ + + + +
    Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
    @@ -1294,9 +1398,17 @@ Not Found
    class com.vmware.nsx_policy.enforcement_points_client.ServiceDefinitions(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    -create(enforcement_point_id, service_definition_id, service_definition)
    +create(enforcement_point_id, service_definition)

    Create a Service Definition on given enforcement point.

    @@ -1304,7 +1416,6 @@ Not Found @@ -1339,6 +1450,44 @@ Not Found

    Parameters:
    +
    +
    +delete(enforcement_point_id, service_definition_id)
    +

    Delete an existing Service Definition on the given enforcement point.

    + +++ + + + + + + + + + + + + + +
    Parameters:
      +
    • enforcement_point_id (str) – Enforcement point id (required)
      • +
    • service_definition_id (str) – Id of service definition (required)
      • +
    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    +
    get(enforcement_point_id, service_definition_id)
    @@ -1467,6 +1616,15 @@ Not Found

    class com.vmware.nsx_policy.enforcement_points_client.StubFactory(stub_config)

    Bases: vmware.vapi.bindings.stub.StubFactoryBase

    +

    Initialize StubFactoryBase

    + +++ + + + +
    Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
    @@ -1476,6 +1634,14 @@ Not Found

    class com.vmware.nsx_policy.eula_client.Accept(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    create()
    @@ -1509,6 +1675,14 @@ Not Found
    class com.vmware.nsx_policy.eula_client.Acceptance(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    get()
    @@ -1546,6 +1720,14 @@ Not Found
    class com.vmware.nsx_policy.eula_client.Content(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    get(cursor=None, format=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    @@ -1604,15 +1786,285 @@ Not Found

    class com.vmware.nsx_policy.eula_client.StubFactory(stub_config)

    Bases: vmware.vapi.bindings.stub.StubFactoryBase

    +

    Initialize StubFactoryBase

    + +++ + + + +
    Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

    com.vmware.nsx_policy.infra_client module

    +
    +
    +class com.vmware.nsx_policy.infra_client.Certificates(config)
    +

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    +
    +
    +LIST_TYPE_CERTIFICATE = 'cluster_api_certificate'
    +

    Possible value for type of method Certificates.list().

    +
    + +
    +
    +delete(certificate_id)
    +

    Removes the specified certificate. The private key associated with the +certificate is also deleted.

    + +++ + + + + + + + + + + + + + +
    Parameters:certificate_id (str) – ID of certificate to delete (required)
    Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
    Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
    Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
    Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
    Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
    +
    + +
    +
    +get(certificate_id, details=None)
    +

    Returns information for the specified certificate ID, including the +certificate’s id; resource_type (for example, certificate_self_signed, +certificate_ca, or certificate_signed); pem_encoded data; and history +of the certificate (who created or modified it and when). For +additional information, include the ?details=true modifier at the end +of the request URI.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:
      +
    • certificate_id (str) – ID of certificate to read (required)
      • +
    • details (bool or None) – whether to expand the pem data and show all its details (optional, +default to false)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.TlsCertificate

    +
    Returns:

    com.vmware.nsx_policy.model.TlsCertificate

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +list(cursor=None, details=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, type=None)
    +

    Returns all certificate information viewable by the user, including +each certificate’s id; resource_type (for example, +certificate_self_signed, certificate_ca, or certificate_signed); +pem_encoded data; and history of the certificate (who created or +modified it and when). For additional information, include the +?details=true modifier at the end of the request URI.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:
      +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
      • +
    • details (bool or None) – whether to expand the pem data and show all its details (optional, +default to false)
      • +
    • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
      • +
    • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
      • +
    • sort_ascending (bool or None) – (optional)
      • +
    • sort_by (str or None) – Field by which records are sorted (optional)
      • +
    • type (str or None) – Type of certificate to return (optional)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.TlsCertificateList

    +
    Returns:

    com.vmware.nsx_policy.model.TlsCertificateList

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +patch(certificate_id, tls_trust_data)
    +

    Adds a new private-public certificate and, optionally, a private key +that can be applied to one of the user-facing components (appliance +management or edge). The certificate and the key should be stored in +PEM format. If no private key is provided, the certificate is used as a +client certificate in the trust store. A certificate chain will not be +expanded into separate certificate instances for reference, but would +be pushed to the enforcement point as a single certificate. This patch +method does not modify an existing certificate.

    + +++ + + + + + + + + + + + + + +
    Parameters: +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +update(certificate_id, tls_trust_data)
    +

    Adds a new private-public certificate and, optionally, a private key +that can be applied to one of the user-facing components (appliance +management or edge). The certificate and the key should be stored in +PEM format. If no private key is provided, the certificate is used as a +client certificate in the trust store. A certificate chain will not be +expanded into separate certificate instances for reference, but would +be pushed to the enforcement point as a single certificate.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters: +
    Return type:

    com.vmware.nsx_policy.model_client.TlsCertificate

    +
    Returns:

    com.vmware.nsx_policy.model.TlsCertificate

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    class com.vmware.nsx_policy.infra_client.Constraints(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    delete(constraint_id)
    @@ -1815,6 +2267,14 @@ Not Found

    class com.vmware.nsx_policy.infra_client.DeploymentZones(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    get(deployment_zone_id)
    @@ -1904,6 +2364,14 @@ Not Found

    class com.vmware.nsx_policy.infra_client.DnsForwarderZones(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    delete(dns_forwarder_zone_id)
    @@ -2104,6 +2572,14 @@ Not Found

    class com.vmware.nsx_policy.infra_client.Domains(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    delete(domain_id)
    @@ -2309,6 +2785,14 @@ Not Found

    class com.vmware.nsx_policy.infra_client.IpfixCollectorProfiles(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    delete(ipfix_collector_profile_id)
    @@ -2512,10 +2996,445 @@ Not Found

    +
    +
    +class com.vmware.nsx_policy.infra_client.IpfixDfwCollectorProfiles(config)
    +

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    +
    +
    +delete(ipfix_dfw_collector_profile_id)
    +

    API deletes IPFIX dfw collector profile. Flow forwarding to collector +will be stopped.

    + +++ + + + + + + + + + + + + + +
    Parameters:ipfix_dfw_collector_profile_id (str) – IPFIX dfw collector Profile id (required)
    Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
    Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
    Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
    Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
    Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
    +
    + +
    +
    +get(ipfix_dfw_collector_profile_id)
    +

    API will return details of IPFIX dfw collector profile. If profile does +not exist, it will return 404.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:ipfix_dfw_collector_profile_id (str) – IPFIX dfw collector profile id (required)
    Return type:com.vmware.nsx_policy.model_client.IPFIXDFWCollectorProfile
    Returns:com.vmware.nsx_policy.model.IPFIXDFWCollectorProfile
    Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
    Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
    Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
    Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
    Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
    +
    + +
    +
    +list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    +

    API will provide list of all IPFIX dfw collector profiles and their +details.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:
      +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
      • +
    • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
      • +
    • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
      • +
    • sort_ascending (bool or None) – (optional)
      • +
    • sort_by (str or None) – Field by which records are sorted (optional)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.IPFIXDFWCollectorProfileListResult

    +
    Returns:

    com.vmware.nsx_policy.model.IPFIXDFWCollectorProfileListResult

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +patch(ipfix_dfw_collector_profile_id, i_pfixdfw_collector_profile)
    +

    Create a new IPFIX dfw collector profile if the IPFIX dfw collector +profile with given id does not already exist. If the IPFIX dfw +collector profile with the given id already exists, patch with the +existing IPFIX dfw collector profile.

    + +++ + + + + + + + + + + + + + +
    Parameters: +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +update(ipfix_dfw_collector_profile_id, i_pfixdfw_collector_profile)
    +

    Create or Replace IPFIX dfw collector profile. IPFIX data will be sent +to IPFIX collector port.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters: +
    Return type:

    com.vmware.nsx_policy.model_client.IPFIXDFWCollectorProfile

    +
    Returns:

    com.vmware.nsx_policy.model.IPFIXDFWCollectorProfile

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.infra_client.IpfixDfwProfiles(config)
    +

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    +
    +
    +delete(ipfix_dfw_profile_id)
    +

    API deletes IPFIX DFW Profile. Selected IPFIX Collectors will stop +receiving flows.

    + +++ + + + + + + + + + + + + + +
    Parameters:ipfix_dfw_profile_id (str) – IPFIX DFW Profile ID (required)
    Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
    Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
    Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
    Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
    Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
    +
    + +
    +
    +get(ipfix_dfw_profile_id)
    +

    API will return details of IPFIX DFW profile.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:ipfix_dfw_profile_id (str) – IPFIX DFW collection id (required)
    Return type:com.vmware.nsx_policy.model_client.IPFIXDFWProfile
    Returns:com.vmware.nsx_policy.model.IPFIXDFWProfile
    Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
    Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
    Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
    Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
    Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
    +
    + +
    +
    +list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    +

    API provides list IPFIX DFW profiles available on selected logical DFW.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:
      +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
      • +
    • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
      • +
    • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
      • +
    • sort_ascending (bool or None) – (optional)
      • +
    • sort_by (str or None) – Field by which records are sorted (optional)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.IPFIXDFWProfileListResult

    +
    Returns:

    com.vmware.nsx_policy.model.IPFIXDFWProfileListResult

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +patch(ipfix_dfw_profile_id, i_pfixdfw_profile)
    +

    Create a new IPFIX DFW profile if the IPFIX DFW profile with given id +does not already exist. If the IPFIX DFW profile with the given id +already exists, patch with the existing IPFIX DFW profile.

    + +++ + + + + + + + + + + + + + +
    Parameters: +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +update(ipfix_dfw_profile_id, i_pfixdfw_profile)
    +

    Create or replace IPFIX DFW profile. Config will start forwarding data +to provided IPFIX DFW collector.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters: +
    Return type:

    com.vmware.nsx_policy.model_client.IPFIXDFWProfile

    +
    Returns:

    com.vmware.nsx_policy.model.IPFIXDFWProfile

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    class com.vmware.nsx_policy.infra_client.Labels(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    delete(label_id)
    @@ -2721,18 +3640,72 @@ Not Found

    -
    -class com.vmware.nsx_policy.infra_client.Networks(config)
    +
    +class com.vmware.nsx_policy.infra_client.LbAppProfiles(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    -
    -
    -delete(network_id)
    -

    Delete network configuration

    - + + + +
    Parameters:network_id (str) – Network ID (required)
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    +
    +
    +delete(lb_app_profile_id, force=None)
    +

    Delete the LBAppProfile along with all the entities contained by this +LBAppProfile.

    + +++ + + + + + + + + + + + + + +
    Parameters:
      +
    • lb_app_profile_id (str) – LBAppProfile ID (required)
      • +
    • force (bool or None) – Force delete the resource even if it is being used somewhere +(optional, default to false)
      • +
    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +get(lb_app_profile_id)
    +

    Read a LBAppProfile.

    + +++ + + + + + @@ -2754,42 +3727,9 @@ Not Found
    -
    -get(network_id)
    -

    Read network configuration

    -
    Parameters:lb_app_profile_id (str) – LBAppProfile ID (required)
    Return type:vmware.vapi.struct.VapiStruct
    Returns:com.vmware.nsx_policy.model.LBAppProfile +The return value will contain all the attributes defined in +com.vmware.nsx_policy.model_client.LBAppProfile.
    Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
    --- - - - - - - - - - - - - - - - - - -
    Parameters:network_id (str) – Network ID (required)
    Return type:com.vmware.nsx_policy.model_client.Network
    Returns:com.vmware.nsx_policy.model.Network
    Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable
    Raise:com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed
    Raise:com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error
    Raise:com.vmware.vapi.std.errors_client.Unauthorized -Forbidden
    Raise:com.vmware.vapi.std.errors_client.NotFound -Not Found
    -
    - -
    -
    -list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    -

    Paginated list of all network instances

    +
    +list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    +

    Paginated list of all LBAppProfiles

    @@ -2806,10 +3746,10 @@ fewer) (optional, default to 1000) - -

    The arguments are used to initialize data attributes with the same names.

    +
    Return type:

    com.vmware.nsx_policy.model_client.NetworkListResult

    +
    Return type:

    com.vmware.nsx_policy.model_client.LBAppProfileListResult
    Returns:

    com.vmware.nsx_policy.model.NetworkListResult

    +
    Returns:

    com.vmware.nsx_policy.model.LBAppProfileListResult
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable @@ -2837,27 +3777,23 @@ Not Found

    -
    -patch(network_id, network)
    -

    If network with the network-id is not already present, create a new -networkig instance. If it already exists, update the network instance -with specified attributes.

    +
    +patch(lb_app_profile_id, lb_app_profile)
    +

    If a LBAppProfile with the lb-app-profile-id is not already present, +create a new LBAppProfile. If it already exists, update the +LBAppProfile. This is a full replace

    - - - - @@ -2883,25 +3819,1351 @@ Not Found

    -
    -update(network_id, network)
    -

    If network with the network-id is not already present, create a new -networkig instance. If it already exists, replace the network instance -with this object.

    +
    +update(lb_app_profile_id, lb_app_profile)
    +

    If a LBAppProfile with the lb-app-profile-id is not already present, +create a new LBAppProfile. If it already exists, update the +LBAppProfile. This is a full replace

    Parameters:
    Return type:

    com.vmware.nsx_policy.model_client.Network

    -
    Returns:

    com.vmware.nsx_policy.model.Network

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
    - - + + + + + + + + + + + + +
    Parameters:
    Return type:

    com.vmware.nsx_policy.model_client.Network

    +
    Return type:

    vmware.vapi.struct.VapiStruct
    Returns:

    com.vmware.nsx_policy.model.Network

    +
    Returns:

    com.vmware.nsx_policy.model.LBAppProfile +The return value will contain all the attributes defined in +com.vmware.nsx_policy.model_client.LBAppProfile.

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + + + +
    +
    +class com.vmware.nsx_policy.infra_client.LbClientSslProfiles(config)
    +

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    +
    +
    +get(lb_client_ssl_profile_id)
    +

    Read a LBClientSslProfile.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:lb_client_ssl_profile_id (str) – LBClientSslProfile ID (required)
    Return type:com.vmware.nsx_policy.model_client.LBClientSslProfile
    Returns:com.vmware.nsx_policy.model.LBClientSslProfile
    Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
    Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
    Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
    Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
    Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
    +
    + +
    +
    +list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    +

    Paginated list of all LBClientSslProfiles

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:
      +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
      • +
    • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
      • +
    • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
      • +
    • sort_ascending (bool or None) – (optional)
      • +
    • sort_by (str or None) – Field by which records are sorted (optional)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.LBClientSslProfileListResult

    +
    Returns:

    com.vmware.nsx_policy.model.LBClientSslProfileListResult

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.infra_client.LbMonitorProfiles(config)
    +

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    +
    +
    +delete(lb_monitor_profile_id, force=None)
    +

    Delete the LBMonitorProfile along with all the entities contained by +this LBMonitorProfile.

    + +++ + + + + + + + + + + + + + +
    Parameters:
      +
    • lb_monitor_profile_id (str) – LBMonitorProfile ID (required)
      • +
    • force (bool or None) – Force delete the resource even if it is being used somewhere +(optional, default to false)
      • +
    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +get(lb_monitor_profile_id)
    +

    Read a LBMonitorProfile.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:lb_monitor_profile_id (str) – LBMonitorProfile ID (required)
    Return type:vmware.vapi.struct.VapiStruct
    Returns:com.vmware.nsx_policy.model.LBMonitorProfile +The return value will contain all the attributes defined in +com.vmware.nsx_policy.model_client.LBMonitorProfile.
    Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
    Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
    Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
    Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
    Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
    +
    + +
    +
    +list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    +

    Paginated list of all LBMonitorProfiles for infra.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:
      +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
      • +
    • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
      • +
    • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
      • +
    • sort_ascending (bool or None) – (optional)
      • +
    • sort_by (str or None) – Field by which records are sorted (optional)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.LBMonitorProfileListResult

    +
    Returns:

    com.vmware.nsx_policy.model.LBMonitorProfileListResult

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +patch(lb_monitor_profile_id, lb_monitor_profile)
    +

    If a LBMonitorProfile with the lb-monitor-profile-id is not already +present, create a new LBMonitorProfile. If it already exists, update +the LBMonitorProfile. This is a full replace

    + +++ + + + + + + + + + + + + + +
    Parameters: +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +update(lb_monitor_profile_id, lb_monitor_profile)
    +

    If a LBMonitorProfile with the lb-monitor-profile-id is not already +present, create a new LBMonitorProfile. If it already exists, update +the LBMonitorProfile. This is a full replace

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters: +
    Return type:

    vmware.vapi.struct.VapiStruct

    +
    Returns:

    com.vmware.nsx_policy.model.LBMonitorProfile +The return value will contain all the attributes defined in +com.vmware.nsx_policy.model_client.LBMonitorProfile.

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.infra_client.LbPersistenceProfiles(config)
    +

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    +
    +
    +delete(lb_persistence_profile_id, force=None)
    +

    Delete the LBPersistenceProfile along with all the entities contained +by this LBPersistenceProfile.

    + +++ + + + + + + + + + + + + + +
    Parameters:
      +
    • lb_persistence_profile_id (str) – LBPersistenceProfile ID (required)
      • +
    • force (bool or None) – Force delete the resource even if it is being used somewhere +(optional, default to false)
      • +
    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +get(lb_persistence_profile_id)
    +

    Read a LBPersistenceProfile.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:lb_persistence_profile_id (str) – LBPersistenceProfile ID (required)
    Return type:vmware.vapi.struct.VapiStruct
    Returns:com.vmware.nsx_policy.model.LBPersistenceProfile +The return value will contain all the attributes defined in +com.vmware.nsx_policy.model_client.LBPersistenceProfile.
    Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
    Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
    Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
    Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
    Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
    +
    + +
    +
    +list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    +

    Paginated list of all LBPersistenceProfiles for infra.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:
      +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
      • +
    • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
      • +
    • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
      • +
    • sort_ascending (bool or None) – (optional)
      • +
    • sort_by (str or None) – Field by which records are sorted (optional)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.LBPersistenceProfileListResult

    +
    Returns:

    com.vmware.nsx_policy.model.LBPersistenceProfileListResult

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +patch(lb_persistence_profile_id, lb_persistence_profile)
    +

    If a LBPersistenceProfile with the lb-persistence-profile-id is not +already present, create a new LBPersistenceProfile. If it already +exists, update the LBPersistenceProfile. This is a full replace

    + +++ + + + + + + + + + + + + + +
    Parameters: +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +update(lb_persistence_profile_id, lb_persistence_profile)
    +

    If a LBPersistenceProfile with the lb-persistence-profile-id is not +already present, create a new LBPersistenceProfile. If it already +exists, update the LBPersistenceProfile. This is a full replace

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters: +
    Return type:

    vmware.vapi.struct.VapiStruct

    +
    Returns:

    com.vmware.nsx_policy.model.LBPersistenceProfile +The return value will contain all the attributes defined in +com.vmware.nsx_policy.model_client.LBPersistenceProfile.

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.infra_client.LbPools(config)
    +

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    +
    +
    +delete(lb_pool_id, force=None)
    +

    Delete the LBPool along with all the entities contained by this LBPool.

    + +++ + + + + + + + + + + + + + +
    Parameters:
      +
    • lb_pool_id (str) – LBPool ID (required)
      • +
    • force (bool or None) – Force delete the resource even if it is being used somewhere +(optional, default to false)
      • +
    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +get(lb_pool_id)
    +

    Read a LBPool.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:lb_pool_id (str) – LBPool ID (required)
    Return type:com.vmware.nsx_policy.model_client.LBPool
    Returns:com.vmware.nsx_policy.model.LBPool
    Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
    Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
    Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
    Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
    Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
    +
    + +
    +
    +list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    +

    Paginated list of all LBPooles

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:
      +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
      • +
    • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
      • +
    • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
      • +
    • sort_ascending (bool or None) – (optional)
      • +
    • sort_by (str or None) – Field by which records are sorted (optional)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.LBPoolListResult

    +
    Returns:

    com.vmware.nsx_policy.model.LBPoolListResult

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +patch(lb_pool_id, lb_pool)
    +

    If a LBPool with the lb-pool-id is not already present, create a new +LBPool. If it already exists, update the LBPool. This is a full replace

    + +++ + + + + + + + + + + + + + +
    Parameters: +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +update(lb_pool_id, lb_pool)
    +

    If a LBPool with the lb-pool-id is not already present, create a new +LBPool. If it already exists, update the LBPool. This is a full replace

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters: +
    Return type:

    com.vmware.nsx_policy.model_client.LBPool

    +
    Returns:

    com.vmware.nsx_policy.model.LBPool

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.infra_client.LbServerSslProfiles(config)
    +

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    +
    +
    +get(lb_server_ssl_profile_id)
    +

    Read a LBServerSslProfile.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:lb_server_ssl_profile_id (str) – LBServerSslProfile ID (required)
    Return type:com.vmware.nsx_policy.model_client.LBServerSslProfile
    Returns:com.vmware.nsx_policy.model.LBServerSslProfile
    Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
    Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
    Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
    Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
    Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
    +
    + +
    +
    +list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    +

    Paginated list of all LBServerSslProfiles

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:
      +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
      • +
    • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
      • +
    • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
      • +
    • sort_ascending (bool or None) – (optional)
      • +
    • sort_by (str or None) – Field by which records are sorted (optional)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.LBServerSslProfileListResult

    +
    Returns:

    com.vmware.nsx_policy.model.LBServerSslProfileListResult

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.infra_client.LbServices(config)
    +

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    +
    +
    +delete(lb_service_id, force=None)
    +

    Delete the LBService along with all the entities contained by this +LBService.

    + +++ + + + + + + + + + + + + + +
    Parameters:
      +
    • lb_service_id (str) – LBService ID (required)
      • +
    • force (bool or None) – Force delete the resource even if it is being used somewhere +(optional, default to false)
      • +
    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +get(lb_service_id)
    +

    Read a LBService.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:lb_service_id (str) – LBService ID (required)
    Return type:com.vmware.nsx_policy.model_client.LBService
    Returns:com.vmware.nsx_policy.model.LBService
    Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
    Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
    Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
    Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
    Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
    +
    + +
    +
    +list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    +

    Paginated list of all LBService

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:
      +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
      • +
    • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
      • +
    • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
      • +
    • sort_ascending (bool or None) – (optional)
      • +
    • sort_by (str or None) – Field by which records are sorted (optional)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.LBServiceListResult

    +
    Returns:

    com.vmware.nsx_policy.model.LBServiceListResult

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +patch(lb_service_id, lb_service)
    +

    If a LBService with the lb-service-id is not already present, create a +new LBService. If it already exists, update the LBService. This is a +full replace

    + +++ + + + + + + + + + + + + + +
    Parameters: +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +update(lb_service_id, lb_service)
    +

    If a LBService with the lb-service-id is not already present, create a +new LBService. If it already exists, update the LBService. This is a +full replace

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters: +
    Return type:

    com.vmware.nsx_policy.model_client.LBService

    +
    Returns:

    com.vmware.nsx_policy.model.LBService

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.infra_client.LbVirtualServers(config)
    +

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    +
    +
    +delete(lb_virtual_server_id, force=None)
    +

    Delete the LBVirtualServer along with all the entities contained by +this LBVirtualServer.

    + +++ + + + + + + + + + + + + + +
    Parameters:
      +
    • lb_virtual_server_id (str) – LBVirtualServer ID (required)
      • +
    • force (bool or None) – Force delete the resource even if it is being used somewhere +(optional, default to false)
      • +
    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +get(lb_virtual_server_id)
    +

    Read a LBVirtualServer.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:lb_virtual_server_id (str) – LBVirtualServer ID (required)
    Return type:com.vmware.nsx_policy.model_client.LBVirtualServer
    Returns:com.vmware.nsx_policy.model.LBVirtualServer
    Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
    Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
    Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
    Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
    Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
    +
    + +
    +
    +list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    +

    Paginated list of all LBVirtualServers

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:
      +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
      • +
    • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
      • +
    • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
      • +
    • sort_ascending (bool or None) – (optional)
      • +
    • sort_by (str or None) – Field by which records are sorted (optional)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.LBVirtualServerListResult

    +
    Returns:

    com.vmware.nsx_policy.model.LBVirtualServerListResult

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +patch(lb_virtual_server_id, lb_virtual_server)
    +

    If a LBVirtualServer with the lb-virtual-server-id is not already +present, create a new LBVirtualServer. If it already exists, update the +LBVirtualServer. This is a full replace

    + +++ + + + + + + + + + + + + + +
    Parameters: +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +update(lb_virtual_server_id, lb_virtual_server)
    +

    If a LBVirtualServer with the lb-virtual-server-id is not already +present, create a new LBVirtualServer. If it already exists, update the +LBVirtualServer. This is a full replace

    + +++ + + + + +
    class com.vmware.nsx_policy.licenses_client.StubFactory(stub_config)

    Bases: vmware.vapi.bindings.stub.StubFactoryBase

    +

    Initialize StubFactoryBase

    +
    Parameters: +
    Return type:

    com.vmware.nsx_policy.model_client.LBVirtualServer

    +
    Returns:

    com.vmware.nsx_policy.model.LBVirtualServer
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable @@ -2934,6 +5196,14 @@ Not Found

    class com.vmware.nsx_policy.infra_client.PartnerServices(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    get(service_name)
    @@ -3019,220 +5289,18 @@ Not Found

    -
    -
    -class com.vmware.nsx_policy.infra_client.Providers(config)
    -

    Bases: vmware.vapi.bindings.stub.VapiInterface

    -
    -
    -delete(provider_id)
    -

    Delete provider

    - --- - - - - - - - - - - - - - -
    Parameters:provider_id (str) – Provider ID (required)
    Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable
    Raise:com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed
    Raise:com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error
    Raise:com.vmware.vapi.std.errors_client.Unauthorized -Forbidden
    Raise:com.vmware.vapi.std.errors_client.NotFound -Not Found
    -
    - -
    -
    -get(provider_id)
    -

    Read provider

    - --- - - - - - - - - - - - - - - - - - -
    Parameters:provider_id (str) – Provider ID (required)
    Return type:com.vmware.nsx_policy.model_client.Provider
    Returns:com.vmware.nsx_policy.model.Provider
    Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable
    Raise:com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed
    Raise:com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error
    Raise:com.vmware.vapi.std.errors_client.Unauthorized -Forbidden
    Raise:com.vmware.vapi.std.errors_client.NotFound -Not Found
    -
    - -
    -
    -list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    -

    Paginated list of all Providers

    - --- - - - - - - - - - - - - - - - - - -
    Parameters:
      -
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied -by current result page) (optional)
      • -
    • included_fields (str or None) – Comma separated list of fields that should be included in query -result (optional)
      • -
    • page_size (long or None) – Maximum number of results to return in this page (server may return -fewer) (optional, default to 1000)
      • -
    • sort_ascending (bool or None) – (optional)
      • -
    • sort_by (str or None) – Field by which records are sorted (optional)
      • -
    -
    Return type:

    com.vmware.nsx_policy.model_client.ProviderListResult

    -
    Returns:

    com.vmware.nsx_policy.model.ProviderListResult

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -patch(provider_id, provider)
    -

    If a provider with the provider-id is not already present, create a new -provider. If it already exists, update the provider for specified -attributes.

    - --- - - - - - - - - - - - - - - - - - -
    Parameters: -
    Return type:

    com.vmware.nsx_policy.model_client.Provider

    -
    Returns:

    com.vmware.nsx_policy.model.Provider

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -update(provider_id, provider)
    -

    If a provider with the provider-id is not already present, create a new -provider. If it already exists, replace the provider instance with the -new object.

    - --- - - - - - - - - - - - - - - - - - -
    Parameters: -
    Return type:

    com.vmware.nsx_policy.model_client.Provider

    -
    Returns:

    com.vmware.nsx_policy.model.Provider

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    class com.vmware.nsx_policy.infra_client.Services(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    delete(service_id)
    @@ -3439,6 +5507,439 @@ Not Found

    class com.vmware.nsx_policy.infra_client.StubFactory(stub_config)

    Bases: vmware.vapi.bindings.stub.StubFactoryBase

    +

    Initialize StubFactoryBase

    + +++ + + + +
    Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
    +
    + +
    +
    +class com.vmware.nsx_policy.infra_client.Tier0s(config)
    +

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    +
    +
    +delete(tier0_id)
    +

    Delete tier-0

    + +++ + + + + + + + + + + + + + +
    Parameters:tier0_id (str) – Tier-0 ID (required)
    Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
    Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
    Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
    Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
    Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
    +
    + +
    +
    +get(tier0_id)
    +

    Read tier-0

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:tier0_id (str) – Tier-0 ID (required)
    Return type:com.vmware.nsx_policy.model_client.Tier0
    Returns:com.vmware.nsx_policy.model.Tier0
    Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
    Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
    Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
    Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
    Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
    +
    + +
    +
    +list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    +

    Paginated list of all Tier-0s

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:
      +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
      • +
    • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
      • +
    • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
      • +
    • sort_ascending (bool or None) – (optional)
      • +
    • sort_by (str or None) – Field by which records are sorted (optional)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.Tier0ListResult

    +
    Returns:

    com.vmware.nsx_policy.model.Tier0ListResult

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +patch(tier0_id, tier0)
    +

    If a tier-0 with the tier-0-id is not already present, create a new +tier-0. If it already exists, update the tier-0 for specified +attributes.

    + +++ + + + + + + + + + + + + + +
    Parameters: +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +update(tier0_id, tier0)
    +

    If a tier-0 with the tier-0-id is not already present, create a new +tier-0. If it already exists, replace the tier-0 instance with the new +object.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters: +
    Return type:

    com.vmware.nsx_policy.model_client.Tier0

    +
    Returns:

    com.vmware.nsx_policy.model.Tier0

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.infra_client.Tier1s(config)
    +

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    +
    +
    +delete(tier1_id)
    +

    Delete tier-1 configuration

    + +++ + + + + + + + + + + + + + +
    Parameters:tier1_id (str) – Tier-1 ID (required)
    Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
    Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
    Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
    Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
    Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
    +
    + +
    +
    +get(tier1_id)
    +

    Read tier-1 configuration

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:tier1_id (str) – Tier-1 ID (required)
    Return type:com.vmware.nsx_policy.model_client.Tier1
    Returns:com.vmware.nsx_policy.model.Tier1
    Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
    Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
    Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
    Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
    Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
    +
    + +
    +
    +list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    +

    Paginated list of all tier-1 instances

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:
      +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
      • +
    • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
      • +
    • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
      • +
    • sort_ascending (bool or None) – (optional)
      • +
    • sort_by (str or None) – Field by which records are sorted (optional)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.Tier1ListResult

    +
    Returns:

    com.vmware.nsx_policy.model.Tier1ListResult

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +patch(tier1_id, tier1)
    +

    If tier-1 with the tier-1-id is not already present, create a new +tier-1 instance. If it already exists, update the tier-1 instance with +specified attributes.

    + +++ + + + + + + + + + + + + + +
    Parameters: +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +update(tier1_id, tier1)
    +

    If tier-1 with the tier-1-id is not already present, create a new +tier-1 instance. If it already exists, replace the tier-1 instance with +this object.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters: +
    Return type:

    com.vmware.nsx_policy.model_client.Tier1

    +
    Returns:

    com.vmware.nsx_policy.model.Tier1

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    +
    @@ -3448,6 +5949,14 @@ Not Found

    class com.vmware.nsx_policy.licenses_client.LicensesUsage(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    get()
    @@ -3485,6 +5994,15 @@ Not Found
    +++ + + + +
    Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
    @@ -3500,6 +6018,46 @@ Not Found
    +++ + + + +
    Parameters: +
    ALG_FTP = 'FTP'
    @@ -3557,6 +6115,104 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • alg (str) –

      Possible values are:

      + +
      • +
    • destination_ports (list of str or None) – The destination_port cannot be empty and must be a single value. +format: port-or-range
      • +
    • source_ports (list of str or None) –
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    ALG_FTP = 'FTP'
    @@ -3614,11 +6270,108 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • connectivity_strategy (str or None) –

      Possible values are:

      + +

      This field indicates the default connectivity policy for the infra +or tenant space WHITELIST - Adds a default drop rule. Administrator +can then use "allow" rules (aka whitelist) to allow traffic +between groups BLACKLIST - Adds a default allow rule. Admin can +then use "drop" rules (aka blacklist) to block traffic +between groups WHITELIST_ENABLE_LOGGING - Whitelising with logging +enabled BLACKLIST_ENABLE_LOGGING - Blacklisting with logging +enabled NONE - No default rules are added. This is the default +setting

      +
      • +
    +
    CONNECTIVITY_STRATEGY_BLACKLIST = 'BLACKLIST'
    +
    +
    +CONNECTIVITY_STRATEGY_BLACKLIST_ENABLE_LOGGING = 'BLACKLIST_ENABLE_LOGGING'
    +
    +
    CONNECTIVITY_STRATEGY_NONE = 'NONE'
    @@ -3629,6 +6382,11 @@ names.

    CONNECTIVITY_STRATEGY_WHITELIST = 'WHITELIST'
    +
    +
    +CONNECTIVITY_STRATEGY_WHITELIST_ENABLE_LOGGING = 'WHITELIST_ENABLE_LOGGING'
    +
    +
    @@ -3640,6 +6398,72 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • acceptable_versions (list of str) – List of component versions
      • +
    • component_type (str) –

      Possible values are:

      + +
      +
      Node type
      +
      • +
    +
    COMPONENT_TYPE_CCP = 'CCP'
    @@ -3671,6 +6495,14 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:results (list of AcceptableComponentVersion) – Acceptable version whitelist for different components
    @@ -3683,6 +6515,62 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • ip_address (str or None) – A resource reference on which actions can be performed format: ip
      • +
    +
    @@ -3694,6 +6582,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of ActionableResource) – List results
      • +
    +
    @@ -3705,6 +6626,20 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • controller_role_config (AddControllerNodeSpec or None) –
      • +
    • display_name (str or None) – Display name for the node
      • +
    • external_id (str or None) – External identifier of the node
      • +
    • mgr_role_config (AddManagementNodeSpec or None) –
      • +
    +
    @@ -3716,6 +6651,33 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • clustering_params (ClusteringInfo or None) – The details of the controller node required for cluster +initialization or joining to an existing cluster. If this property +is set, the node will be added to an existing cluster or used to +create a new cluster. Otherwise no clustering operation/s will be +performed.
      • +
    • control_plane_server_certificate (str or None) – Deprecated. Do not supply a value for this property.
      • +
    • host_msg_client_info (MsgClientInfo) –
      • +
    • mpa_msg_client_info (MsgClientInfo) –
      • +
    • node_id (str or None) – Only use this if an id for the node already exists with MP. If not +specified, then the node_id will be set to a random id.
      • +
    • type (str) –

      Possible values are:

      + +
      +
      must be set to AddControllerNodeSpec
      +
      • +
    +
    TYPE_ADDCONTROLLERNODESPEC = 'AddControllerNodeSpec'
    @@ -3732,6 +6694,29 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • cert_thumbprint (str or None) – The certificate thumbprint of the remote node.
      • +
    • mpa_msg_client_info (MsgClientInfo or None) –
      • +
    • password (str or None) – The password to be used to authenticate with the remote node.
      • +
    • remote_address (str) – The host address of the remote node to which to send this join +request. format: ip
      • +
    • type (str) –

      Possible values are:

      + +
      +
      must be set to AddManagementNodeSpec
      +
      • +
    • user_name (str) – The username to be used to authenticate with the remote node.
      • +
    +
    TYPE_ADDMANAGEMENTNODESPEC = 'AddManagementNodeSpec'
    @@ -3748,6 +6733,21 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • id (str or None) – Unique id of an instruction (as returned by the GET /restore/status +call) for which input is to be provided +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resources (list of SelectableResourceReference) – List of resources for which the instruction is applicable.
      • +
    +
    @@ -3759,6 +6759,14 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:data (list of AdvanceClusterRestoreInput) – List of instructions and their associated data
    @@ -3770,6 +6778,28 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • action (str or None) –

      Possible values are:

      + +

      ALLOW action enables the advertisment and DENY action disables the +advertisement of a filtered routes to the connected TIER0 router.

      +
      • +
    • description (str or None) – Description
      • +
    • display_name (str or None) – Display name
      • +
    • networks (list of str) – network(CIDR) to be routed format: ipv4-cidr-block
      • +
    • rule_filter (AdvertisementRuleFilter or None) – Rule filter for the advertise rule
      • +
    +
    ACTION_ALLOW = 'ALLOW'
    @@ -3791,6 +6821,65 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • logical_router_id (str or None) – Logical router id +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • rules (list of AdvertiseRule or None) – List of advertisement rules
      • +
    +
    @@ -3802,6 +6891,26 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • advertised_route_type (str or None) – Advertise network route type on TIER0 LR +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • is_advertised (bool or None) – Flag to denote advertisement status of network to TIER0 LR. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • network (str or None) – Advertised network address. format: ipv4 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource (ResourceReference or None) – Resource which has registered network.
      • +
    +
    @@ -3813,6 +6922,41 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of AdvertisedNetwork or None) – List of networks which advertised to TIER0 from TIER1 LR +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -3824,6 +6968,70 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • advertise_lb_snat_ip (bool or None) – Flag to advertise all lb SNAT ips
      • +
    • advertise_lb_vip (bool or None) – Flag to advertise lb vip
      • +
    • advertise_nat_routes (bool or None) – Flag to advertise all routes of nat
      • +
    • advertise_nsx_connected_routes (bool or None) – Flag to advertise all connected routes
      • +
    • advertise_static_routes (bool or None) – Flag to advertise all static routes
      • +
    • enabled (bool or None) – Flag to enable this configuration
      • +
    • logical_router_id (str or None) – Logical router id +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -3837,6 +7045,38 @@ be based on the type of route and the prefix operator configured.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    MATCH_ROUTE_TYPES_ANY = 'ANY'
    @@ -3890,6 +7130,39 @@ the related objects

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of AggregateResponse) – Array containing the primary and the related object details
      • +
    +
    @@ -3902,6 +7175,26 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • l2vpn_path (str) – Policy path referencing the L2Vpn.
      • +
    • l2vpn_peer_config_per_enforcement_point (list of vmware.vapi.struct.VapiStruct or None) – List of L2Vpn peer config per Enforcement Point. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +L2VpnPeerConfigPerEnforcementPoint. When methods return a +value of this class as a return value, the attribute will contain +all the attributes defined in +L2VpnPeerConfigPerEnforcementPoint. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -3914,6 +7207,26 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • intent_path (str) – Intent path of object, forward slashes must be escaped using %2F.
      • +
    • l2vpn_statistics_per_enforcement_point (list of vmware.vapi.struct.VapiStruct or None) – List of L2Vpn Statistics per Enforcement Point. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +L2VpnStatisticsPerEnforcementPoint. When methods return a +value of this class as a return value, the attribute will contain +all the attributes defined in +L2VpnStatisticsPerEnforcementPoint. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -3926,6 +7239,26 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • intent_path (str) – Intent path of object, forward slashes must be escaped using %2F.
      • +
    • l3vpn_statistics_per_enforcement_point (list of vmware.vapi.struct.VapiStruct or None) – List of L3Vpn Statistics per Enforcement Point. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +L3VpnStatisticsPerEnforcementPoint. When methods return a +value of this class as a return value, the attribute will contain +all the attributes defined in +L3VpnStatisticsPerEnforcementPoint. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -3938,6 +7271,21 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • included_fields (str or None) – Comma separated list of fields that should be included in query +result
      • +
    • alias (str or None) – Alias for the response
      • +
    • filters (list of FilterRequest or None) – An array of filter conditions
      • +
    • resource_type (str) – Resource type name
      • +
    +
    @@ -3950,6 +7298,18 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • primary (vmware.vapi.struct.VapiStruct) – Requested properties of the primary object
      • +
    • related (list of RelatedData) – Requested properties of the related objects
      • +
    +
    @@ -3962,6 +7322,22 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • cluster_id (str or None) – UUID of the cluster +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • groups (list of ClusterGroupStatus or None) – Array of groups and their statuses +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -3976,6 +7352,64 @@ in this release.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • allocation_id (str or None) – Address that is allocated from pool format: ip +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -3987,18 +7421,67 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of AllocationIpAddress) – Pool allocation list results
      • +
    +
    class com.vmware.nsx_policy.model_client.ApiError(details=None, error_code=None, error_data=None, error_message=None, module_name=None, related_errors=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Detailed information about an API error

    +

    Detailed information about an API Error

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • details (str or None) – Further details about the error
      • +
    • error_code (long or None) – A numeric error code format: int64
      • +
    • error_data (vmware.vapi.struct.VapiStruct or None) – Additional data about the error
      • +
    • error_message (str or None) – A description of the error
      • +
    • module_name (str or None) – The module name where the error occurred
      • +
    • related_errors (list of RelatedApiError or None) – Other errors related to this error
      • +
    +
    @@ -4011,6 +7494,19 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    @@ -4024,6 +7520,21 @@ based IP assignment is desired for host switch virtual tunnel endpoints.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:resource_type (str) –

    Possible values are:

    + +
    @@ -4035,6 +7546,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of ResourceReference) – Paged Collection of ResourceReference
      • +
    +
    @@ -4046,6 +7590,27 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    ALLOCATE_ADDRESSES_BOTH = 'Both'
    @@ -4080,6 +7645,30 @@ the partner applicance.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    ATTRIBUTE_TYPE_IP_ADDRESS = 'IP_ADDRESS'
    @@ -4117,6 +7706,35 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • data_type (str or None) –

      Possible values are:

      + +
      +
      Datatype of the property
      +

      This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    • key (str or None) – Attribute key
      • +
    • multivalue (bool or None) – If attribute has a single value or collection of values +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • values (list of str or None) – List of attribute values +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    DATA_TYPE_BOOLEAN = 'BOOLEAN'
    @@ -4148,6 +7766,31 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • administratively_down_count (long or None) – Number of tunnels with administratively down diagnostic message +format: int64
      • +
    • concatenated_path_down_count (long or None) – Number of tunnels with concatenated path down diagnostic message +format: int64
      • +
    • control_detection_time_expired_count (long or None) – Number of tunnels with control detection time expired diagnostic +message format: int64
      • +
    • echo_function_failed_count (long or None) – Number of tunnels with echo function failed diagnostic message +format: int64
      • +
    • forwarding_plane_reset_count (long or None) – Number of tunnels with forwarding plane reset diagnostic message +format: int64
      • +
    • neighbor_signaled_session_down_count (long or None) – Number of tunnels neighbor signaled session down format: int64
      • +
    • no_diagnostic_count (long or None) – Number of tunnels with no diagnostic format: int64
      • +
    • path_down_count (long or None) – Number of tunnels with path down diagnostic message format: int64
      • +
    • reverse_concatenated_path_down_count (long or None) – Number of tunnels with reverse concatenated path down diagnostic +message format: int64
      • +
    +
    @@ -4160,6 +7803,57 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • active (bool or None) – True if tunnel is active in a gateway HA setup +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • diagnostic (str or None) – A short message indicating what the BFD session thinks is wrong in +case of a problem +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • forwarding (bool or None) – True if the BFD session believes this interface may be used to +forward traffic +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • remote_diagnostic (str or None) – A short message indicating what the remote interface’s BFD session +thinks is wrong in case of a problem +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • remote_state (str or None) –

      Possible values are:

      + +
      +
      State of the remote interface’s BFD session
      +

      This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    • state (str or None) –

      Possible values are:

      + +
      +
      State of the BFD session
      +

      This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    +
    REMOTE_STATE_ADMIN_DOWN = 'ADMIN_DOWN'
    @@ -4221,6 +7915,20 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • bfd_admin_down_count (long or None) – Number of tunnels in BFD admin down state format: int32
      • +
    • bfd_down_count (long or None) – Number of tunnels in BFD down state format: int32
      • +
    • bfd_init_count (long or None) – Number of tunnels in BFD init state format: int32
      • +
    • bfd_up_count (long or None) – Number of tunnels in BFD up state format: int32
      • +
    +
    @@ -4232,6 +7940,72 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • communities (list of str) – Array of BGP communities
      • +
    • community_type (str or None) –

      Possible values are:

      + +

      Specifies the BGP community type. Currently, only +NormalBGPCommunity is supported.

      +
      • +
    • logical_router_id (str or None) – Logical router id +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    COMMUNITY_TYPE_NORMALBGPCOMMUNITY = 'NormalBGPCommunity'
    @@ -4248,6 +8022,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of BGPCommunityList or None) – Paginated list of bgp community lists
      • +
    +
    @@ -4260,6 +8067,28 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • backup_enabled (bool or None) – true if automated backup is enabled
      • +
    • backup_schedule (vmware.vapi.struct.VapiStruct or None) – Set when backups should be taken - on a weekly schedule or at +regular intervals. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +BackupSchedule. When methods return a value of this class +as a return value, the attribute will contain all the attributes +defined in BackupSchedule.
      • +
    • inventory_summary_interval (long or None) – The minimum number of seconds between each upload of the inventory +summary to backup server. format: int64
      • +
    • passphrase (str or None) – Passphrase used to encrypt backup files.
      • +
    • remote_file_server (RemoteFileServer) – The server to which backups will be sent.
      • +
    +
    @@ -4272,6 +8101,19 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • cluster_backup_statuses (list of BackupOperationStatus or None) – Statuses of previous cluser backups
      • +
    • inventory_backup_statuses (list of BackupOperationStatus or None) – Statuses of previous inventory backups
      • +
    • node_backup_statuses (list of BackupOperationStatus or None) – Statuses of previous node backups
      • +
    +
    @@ -4284,6 +8126,34 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    ERROR_CODE_AUTHENTICATION_FAILURE = 'BACKUP_AUTHENTICATION_FAILURE'
    @@ -4331,6 +8201,21 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:resource_type (str) –

    Possible values are:

    + +
    +
    Schedule type
    +
    RESOURCE_TYPE_INTERVALBACKUPSCHEDULE = 'IntervalBackupSchedule'
    @@ -4343,6 +8228,161 @@ names.

    +
    +
    +class com.vmware.nsx_policy.model_client.BaseEndpoint(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='BaseEndpoint', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, target_ips=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Represents an endpoint which will be used as subject in redirection rule. +It is a polymorphic type object which can be either of the types - 1. +Virtual 2. Logical We have 2 separate objects representing these 2 types. +VirtualEndPoint for Virtual type and ServiceInstanceEndpoint for Logical.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • target_ips (list of IPInfo) – IPs where either inbound or outbound traffic is to be redirected.
      • +
    +
    +
    +
    +RESOURCE_TYPE_SERVICEINSTANCEENDPOINT = 'ServiceInstanceEndpoint'
    +
    + +
    +
    +RESOURCE_TYPE_VIRTUALENDPOINT = 'VirtualEndpoint'
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.model_client.BaseEndpointListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Collection of all endpoints under a tier-0

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of vmware.vapi.struct.VapiStruct) – All endpoints under a tier-0 +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +BaseEndpoint. When methods return a value of this class as +a return value, the attribute will contain all the attributes +defined in BaseEndpoint.
      • +
    +
    +
    +
    class com.vmware.nsx_policy.model_client.BaseHostSwitchProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='BaseHostSwitchProfile', tags=None, required_capabilities=None)
    @@ -4352,6 +8392,72 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • required_capabilities (list of str or None) –
      • +
    +
    RESOURCE_TYPE_EXTRACONFIGHOSTSWITCHPROFILE = 'ExtraConfigHostSwitchProfile'
    @@ -4383,6 +8489,28 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • node_interface_properties (list of NodeInterfaceProperties or None) – Array of Node interface statistic properties +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • node_interface_statistics (list of NodeInterfaceStatisticsProperties or None) – Array of Node network interface statistic properties +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • node_status (ClusterNodeStatus or None) –
      • +
    • node_status_properties (list of NodeStatusProperties or None) – Time series of the node’s system properties
      • +
    +
    @@ -4395,6 +8523,97 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • deployment_mode (str or None) –

      Possible values are:

      + +

      Deployment mode specifies how the partner appliance will be +deployed i.e. in HA or standalone mode.

      +
      • +
    • partner_service_name (str) – Unique name of Partner Service to be consumed in redirection
      • +
    • transport_type (str or None) –

      Possible values are:

      + +
      +
      Transport to be used while deploying Service-VM.
      +
      • +
    +
    DEPLOYMENT_MODE_ACTIVE_STANDBY = 'ACTIVE_STANDBY'
    @@ -4427,35 +8646,44 @@ names.

    The arguments are used to initialize data attributes with the same names.

    -
    - -
    -
    -class com.vmware.nsx_policy.model_client.BaseProviderInterface(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, subnets=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Provider interface configuration for external connectivity

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    - -
    -
    -class com.vmware.nsx_policy.model_client.BaseProviderInterfaceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Paged collection of all Interfaces

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of BasePolicyServiceInstance) – All service instance list results
      • +
    +
    -class com.vmware.nsx_policy.model_client.BaseServiceInstance(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='BaseServiceInstance', tags=None, deployment_mode=None, on_failure_policy=None, service_id=None, transport_type=None)
    +class com.vmware.nsx_policy.model_client.BaseServiceInstance(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='BaseServiceInstance', tags=None, on_failure_policy=None, service_id=None, transport_type=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    The deployment of a registered service. service instance is instantiation of service.

    @@ -4464,16 +8692,95 @@ of service.

    The arguments are used to initialize data attributes with the same names.

    -
    -
    -DEPLOYMENT_MODE_ACTIVE_STANDBY = 'ACTIVE_STANDBY'
    -
    - -
    -
    -DEPLOYMENT_MODE_STAND_ALONE = 'STAND_ALONE'
    -
    - + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      ServiceInstance is used when NSX handles the lifecyle of appliance. +Deployment and appliance related all the information is necessary. +ByodServiceInstance is a custom instance to be used when NSX is not +handling the lifecycles of appliance/s. User will manage their own +appliance (BYOD) to connect with NSX. VirtualServiceInstance is a a +custom instance to be used when NSX is not handling the lifecycle +of an appliance and when the user is not bringing their own +appliance.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • on_failure_policy (str or None) –

      Possible values are:

      + +

      Failure policy of the service instance - if it has to be different +from the service. By default the service instance inherits the +FailurePolicy of the service it belongs to.

      +
      • +
    • service_id (str or None) – The Service to which the service instance is associated. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • transport_type (str) –

      Possible values are:

      + +

      Transport to be used by this service instance for deploying the +Service-VM.

      +
      • +
    +
    ON_FAILURE_POLICY_ALLOW = 'ALLOW'
    @@ -4494,6 +8801,11 @@ names.

    RESOURCE_TYPE_SERVICEINSTANCE = 'ServiceInstance'
    +
    +
    +RESOURCE_TYPE_VIRTUALSERVICEINSTANCE = 'VirtualServiceInstance'
    +
    +
    TRANSPORT_TYPE_L2_BRIDGE = 'L2_BRIDGE'
    @@ -4515,6 +8827,195 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • required_capabilities (list of str or None) –
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.BaseTier0Interface(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, subnets=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Tier-0 interface configuration for external connectivity.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • subnets (list of InterfaceSubnet) – Specify IP address and network prefix for interface.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.BaseTier0InterfaceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Paged collection of all Interfaces

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of BaseTier0Interface) – List of all Interface results including tier-0 interfaces and +service interfaces.
      • +
    +
    @@ -4527,6 +9028,19 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • continue_on_error (bool or None) – Flag to decide if we will continue processing subsequent requests +in case of current error for atomic = false.
      • +
    • requests (list of BatchRequestItem or None) –
      • +
    +
    @@ -4539,6 +9053,31 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    METHOD_DELETE = 'DELETE'
    @@ -4576,6 +9115,20 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • has_errors (bool or None) – Indicates if any of the APIs failed
      • +
    • results (list of BatchResponseItem) – Bulk list results
      • +
    • rolled_back (bool or None) – Optional flag indicating that all items were rolled back even if +succeeded initially
      • +
    +
    @@ -4588,6 +9141,19 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • body (vmware.vapi.struct.VapiStruct or None) – object returned by api
      • +
    • code (long) – http status code format: int64
      • +
    • headers (vmware.vapi.struct.VapiStruct or None) – The headers returned by the API call
      • +
    +
    @@ -4600,6 +9166,71 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • declare_dead_multiple (long or None) – Number of times a packet is missed before BFD declares the neighbor +down. format: int64
      • +
    • enabled (bool or None) – Flag to enable BFD for this LogicalRouter
      • +
    • logical_router_id (str or None) – Logical router id +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • receive_interval (long or None) – the time interval (in milliseconds) between heartbeat packets for +BFD when receiving heartbeats. format: int64
      • +
    • transmit_interval (long or None) – the time interval (in milliseconds) between heartbeat packets for +BFD when sending heartbeats. format: int64
      • +
    +
    @@ -4612,6 +9243,22 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • declare_dead_multiple (long or None) – Number of times a packet is missed before BFD declares the neighbor +down. format: int64
      • +
    • receive_interval (long or None) – the time interval (in milliseconds) between heartbeat packets for +BFD when receiving heartbeats. format: int64
      • +
    • transmit_interval (long or None) – the time interval (in milliseconds) between heartbeat packets for +BFD when sending heartbeats. format: int64
      • +
    +
    @@ -4624,6 +9271,70 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • enabled (bool) – Whether the heartbeat is enabled. A POST or PUT request with +"enabled" false (with no probe intervals) will set (POST) +or reset (PUT) the probe_interval to their default value.
      • +
    • probe_interval (long or None) – The time interval (in millisec) between probe packets for tunnels +between transport nodes. format: int64
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    +
    @@ -4635,6 +9346,71 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • as_num (str or None) – 4 Byte ASN in ASPLAIN/ASDOT Format
      • +
    • as_number (long or None) – This is a deprecated property, Please use ‘as_num’ instead. format: +int64
      • +
    • ecmp (bool or None) – Flag to enable ECMP
      • +
    • enabled (bool or None) – Flag to enable this configuration
      • +
    • graceful_restart (bool or None) – Flag to enable graceful restart
      • +
    • logical_router_id (str or None) – Logical router id +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • route_aggregation (list of BgpRouteAggregation or None) – List of routes to be aggregated
      • +
    +
    @@ -4646,6 +9422,107 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • address_families (list of BgpNeighborAddressFamily or None) – User can enable the neighbor for the specific address families and +also define filters per address family. When the neighbor is +created, it is default enabled for IPV4_UNICAST address family for +backward compatibility reasons. User can change that if required, +by defining the address family configuration.
      • +
    • bfd_config (BfdConfigParameters or None) – By specifying these paramaters BFD config for this given peer can +be overriden | (the globally configured values will not apply for +this peer)
      • +
    • enable_bfd (bool or None) – Flag to enable BFD for this BGP Neighbor. Enable this if the +neighbor supports BFD as this will lead to faster convergence.
      • +
    • enabled (bool or None) – Flag to enable this BGP Neighbor
      • +
    • filter_in_ipprefixlist_id (str or None) – This is a deprecated property, Please use ‘address_family’ instead.
      • +
    • filter_in_routemap_id (str or None) – This is a deprecated property, Please use ‘address_family’ instead.
      • +
    • filter_out_ipprefixlist_id (str or None) – This is a deprecated property, Please use ‘address_family’ instead.
      • +
    • filter_out_routemap_id (str or None) – This is a deprecated property, Please use ‘address_family’ instead.
      • +
    • hold_down_timer (long or None) – Wait period (seconds) before declaring peer dead format: int64
      • +
    • keep_alive_timer (long or None) – Frequency (seconds) with which keep alive messages are sent to +peers format: int64
      • +
    • logical_router_id (str or None) – Logical router id +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • maximum_hop_limit (long or None) – This value is set on TTL(time to live) of BGP header. When router +receives the BGP packet, it decrements the TTL. The default value +of TTL is one when BPG request is initiated.So in the case of a BGP +peer multiple hops away and and value of TTL is one, then next +router in the path will decrement the TTL to 0, realize it cant +forward the packet and will drop it. If the hop count value to +reach neighbor is equal to or less than the maximum_hop_limit value +then intermediate router decrements the TTL count by one and +forwards the request to BGP neighour. If the hop count value is +greater than the maximum_hop_limit value then intermediate router +discards the request when TTL becomes 0. format: int32
      • +
    • neighbor_address (str) – Neighbor IP Address format: ipv4
      • +
    • password (str or None) – User can create (POST) the neighbor with or without the password. +The view (GET) on the neighbor, would never reveal if the password +is set or not. The password can be set later using edit neighbor +workFlow (PUT) On the edit neighbor (PUT), if the user does not +specify the password property, the older value is retained. Maximum +length of this field is 20 characters.
      • +
    • remote_as (long or None) – This is a deprecated property, Please use ‘remote_as_num’ instead. +format: int64
      • +
    • remote_as_num (str or None) – 4 Byte ASN of the neighbor in ASPLAIN/ASDOT Format
      • +
    • source_address (str or None) – Deprecated - do not provide a value for this field. Use +source_addresses instead. format: ipv4
      • +
    • source_addresses (list of str or None) – BGP neighborship will be formed from all these source addresses to +this neighbour. format: ipv4
      • +
    +
    @@ -4657,6 +9534,29 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • enabled (bool or None) – Enable this address family
      • +
    • in_filter_ipprefixlist_id (str or None) – Id of the IPPrefix List to be used for IN direction filter
      • +
    • in_filter_routemap_id (str or None) – Id of the RouteMap to be used for IN direction filter
      • +
    • out_filter_ipprefixlist_id (str or None) – Id of the IPPrefixList to be used for OUT direction filter
      • +
    • out_filter_routemap_id (str or None) – Id of the RouteMap to be used for OUT direction filter
      • +
    • type (str) –

      Possible values are:

      + +
      +
      Address family type
      +
      • +
    +
    TYPE_IPV4_UNICAST = 'IPV4_UNICAST'
    @@ -4671,14 +9571,96 @@ names.

    -class com.vmware.nsx_policy.model_client.BgpNeighborConfig(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, neighbor_address=None, password=None, remote_as_num=None)
    +class com.vmware.nsx_policy.model_client.BgpNeighborConfig(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, in_route_filters=None, neighbor_address=None, out_route_filters=None, password=None, remote_as_num=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Contains information necessary to configure a BGP neighbor

    +

    Contains information necessary to configure a BGP neighbor.

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • in_route_filters (list of str or None) – Specify paths of prefix-lists to filter routes for IN direction.
      • +
    • neighbor_address (str) – Neighbor IP Address format: ip
      • +
    • out_route_filters (list of str or None) – Specify paths of prefix-lists to filter routes for OUT direction. A +built-in prefix-list named ‘prefixlist-out-default’ is +automatically applied as first entry.
      • +
    • password (str or None) – Specify password for BGP neighbor authentication. Empty string +("") clears existing password.
      • +
    • remote_as_num (str) – 4 Byte ASN of the neighbor in ASPLAIN Format
      • +
    +
    @@ -4691,6 +9673,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of BgpNeighborConfig) – BGP neighbor configs list results
      • +
    +
    @@ -4702,6 +9717,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of BgpNeighbor) – Paginated list of bgp neighbors
      • +
    +
    @@ -4713,6 +9761,94 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • announced_capabilities (list of str or None) – BGP capabilities sent to BGP neighbor. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • connection_drop_count (long or None) – Count of connection drop format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • connection_state (str or None) –

      Possible values are:

      + +
      +
      Current state of the BGP session.
      +

      This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    • established_connection_count (long or None) – Count of connections established format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • graceful_restart (bool or None) – Indicate current state of graceful restart where graceful_restart = +true indicate graceful restart is enabled and graceful_restart = +false indicate graceful restart is disabled. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • hold_time (long or None) – Time in ms to wait for HELLO from BGP peer. If a HELLO packet is +not seen from BGP Peer withing hold_time then BGP neighbor will be +marked as down. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • keep_alive_interval (long or None) – Time in ms to wait for HELLO packet from BGP peer format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • local_port (long or None) – TCP port number of Local BGP connection format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • lr_component_id (str or None) – Logical router component(Service Router/Distributed Router) id +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • messages_received (long or None) – Count of messages received from the neighbor format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • messages_sent (long or None) – Count of messages sent to the neighbor format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • negotiated_capability (list of str or None) – BGP capabilities negotiated with BGP neighbor. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • neighbor_address (str or None) – The IP of the BGP neighbor format: ip +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • neighbor_router_id (str or None) – Router ID of the BGP neighbor. format: ip +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • remote_as_number (str or None) – AS number of the BGP neighbor +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • remote_port (long or None) – TCP port number of remote BGP Connection format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • source_address (str or None) – The Ip address of logical port format: ip +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • time_since_established (long or None) – Time(in milliseconds) since connection was established. format: +int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • total_in_prefix_count (long or None) – Count of in prefixes format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • total_out_prefix_count (long or None) – Count of out prefixes format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • transport_node (ResourceReference or None) – Transport node id and name
      • +
    +
    CONNECTION_STATE_ACTIVE = 'ACTIVE'
    @@ -4759,6 +9895,51 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_update_timestamp (long or None) – Timestamp when the data was last updated, unset if data source has +never updated the data. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • logical_router_id (str or None) – Logical router id +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • logical_router_name (str or None) – Name of the logical router +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of BgpNeighborStatus or None) – Status of BGP neighbors of the logical router +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -4770,18 +9951,108 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • prefix (str) – cidr of the aggregate address format: ipv4-cidr-block
      • +
    • summary_only (bool or None) – Flag to send only summarized route
      • +
    +
    -class com.vmware.nsx_policy.model_client.BgpRoutingConfig(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, local_as_num=None)
    +class com.vmware.nsx_policy.model_client.BgpRoutingConfig(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, local_as_num=None, route_aggregations=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Contains BGP routing configuration

    +

    Contains BGP routing configuration.

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • local_as_num (str) – Specify BGP AS number for Tier-0 to advertize to BGP peers. AS +number can be specified in ASPLAIN (e.g., "65546") or ASDOT +(e.g., "1.10") format. Empty string disables BGP feature.
      • +
    • route_aggregations (list of RouteAggregationEntry or None) – List of routes to be aggregated.
      • +
    +
    @@ -4794,6 +10065,19 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • enabled (bool) – Indicates whether BPDU filter is enabled
      • +
    • white_list (list of str or None) – Pre-defined list of allowed MAC addresses to be excluded from BPDU +filtering
      • +
    +
    @@ -4806,6 +10090,63 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • bridge_nodes (list of BridgeClusterNode) – Nodes used in bridging
      • +
    • cluster_profile_bindings (list of ClusterProfileTypeIdEntry or None) – Bridge cluster profile bindings
      • +
    +
    @@ -4818,6 +10159,41 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of BridgeCluster or None) – BridgeCluster Results +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -4830,11 +10206,25 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • ha_mac (str or None) – MAC address used for HA protocol +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • transport_node_id (str) – UUID of the transport node
      • +
    +
    -class com.vmware.nsx_policy.model_client.BridgeEndpoint(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, bridge_cluster_id=None, bridge_endpoint_profile_id=None, firewall_sections=None, ha_enable=None, vlan=None, vlan_transport_zone_id=None)
    +class com.vmware.nsx_policy.model_client.BridgeEndpoint(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, bridge_cluster_id=None, bridge_endpoint_profile_id=None, ha_enable=None, vlan=None, vlan_transport_zone_id=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    A bridge endpoint can be created on a bridge cluster or on an edge cluster. Few of the properties of this class will not be used depending on the type @@ -4848,6 +10238,70 @@ vlan_transport_zone_id.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • bridge_cluster_id (str or None) – This field will not be used if an edge cluster is being used for +the bridge endpoint
      • +
    • bridge_endpoint_profile_id (str or None) – This field will not be used if a bridge cluster is being used for +the bridge endpoint
      • +
    • ha_enable (bool or None) – This field will not be used if an edge cluster is being used for +the bridge endpoint
      • +
    • vlan (long) – Virtual Local Area Network Identifier format: int64
      • +
    • vlan_transport_zone_id (str or None) – This field will not be used if a bridge cluster is being used for +the bridge endpoint
      • +
    +
    @@ -4860,6 +10314,41 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of BridgeEndpoint or None) – BridgeEndpoint Results +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -4872,6 +10361,78 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • edge_cluster_id (str) – UUID of the edge cluster for this bridge endpoint
      • +
    • edge_cluster_member_indexes (list of long or None) – First index will be used as the preferred member format: int32
      • +
    • failover_mode (str or None) –

      Possible values are:

      + +
      +
      Faileover mode can be preemmptive or non-preemptive
      +
      • +
    • high_availability_mode (str or None) –

      Possible values are:

      + +
      +
      High avaialability mode can be active-active or active-standby
      +
      • +
    +
    FAILOVER_MODE_NON_PREEMPTIVE = 'NON_PREEMPTIVE'
    @@ -4899,6 +10460,41 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of BridgeEndpointProfile or None) – BridgeEndpointProfile Results +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -4911,6 +10507,72 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • bfd_probe_interval (long or None) – the time interval (in millisec) between probe packets for heartbeat +purpose format: int64
      • +
    • enable (bool or None) – whether the heartbeat is enabled
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    +
    @@ -4925,6 +10587,97 @@ your own device.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • deployment_mode (str or None) –

      Possible values are:

      + +

      Deployment mode specifies how the partner appliance will be +deployed i.e. in HA or standalone mode.

      +
      • +
    • partner_service_name (str) – Unique name of Partner Service to be consumed in redirection
      • +
    • transport_type (str or None) –

      Possible values are:

      + +
      +
      Transport to be used while deploying Service-VM.
      +
      • +
    +
    DEPLOYMENT_MODE_ACTIVE_STANDBY = 'ACTIVE_STANDBY'
    @@ -4957,11 +10710,44 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of ByodPolicyServiceInstance) – Byod Service instance list results
      • +
    +
    -class com.vmware.nsx_policy.model_client.ByodServiceInstance(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ByodServiceInstance', tags=None, deployment_mode=None, on_failure_policy=None, service_id=None, transport_type=None)
    +class com.vmware.nsx_policy.model_client.ByodServiceInstance(deployment_mode=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ByodServiceInstance', tags=None, on_failure_policy=None, service_id=None, transport_type=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    ByodServiceInstance is a custom instance to be used when NSX is not handling the lifecycles of appliance/s. User will manage their own @@ -4971,6 +10757,113 @@ appliance (BYOD) to connect with NSX.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • deployment_mode (str) –

      Possible values are:

      + +

      Deployment mode specifies where the partner appliance will be +deployed in HA or non-HA i.e standalone mode.

      +
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      ServiceInstance is used when NSX handles the lifecyle of appliance. +Deployment and appliance related all the information is necessary. +ByodServiceInstance is a custom instance to be used when NSX is not +handling the lifecycles of appliance/s. User will manage their own +appliance (BYOD) to connect with NSX. VirtualServiceInstance is a a +custom instance to be used when NSX is not handling the lifecycle +of an appliance and when the user is not bringing their own +appliance.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • on_failure_policy (str or None) –

      Possible values are:

      + +

      Failure policy of the service instance - if it has to be different +from the service. By default the service instance inherits the +FailurePolicy of the service it belongs to.

      +
      • +
    • service_id (str or None) – The Service to which the service instance is associated. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • transport_type (str) –

      Possible values are:

      + +

      Transport to be used by this service instance for deploying the +Service-VM.

      +
      • +
    +
    +
    +
    +DEPLOYMENT_MODE_ACTIVE_STANDBY = 'ACTIVE_STANDBY'
    +
    + +
    +
    +DEPLOYMENT_MODE_STAND_ALONE = 'STAND_ALONE'
    +
    +
    @@ -4983,6 +10876,30 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • capacity_type (str or None) – type of the capacity field +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • usage_count (long or None) – count of number of items of capacity_type format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -4994,6 +10911,68 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • details (list of X509Certificate or None) – list of X509Certificates +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • pem_encoded (str) – pem encoded certificate data
      • +
    • used_by (list of NodeIdServicesMap or None) – list of node IDs with services, that are using this certificate +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -5006,35 +10985,182 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of Certificate or None) – Certificate list +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    class com.vmware.nsx_policy.model_client.ChildBgpNeighborConfig(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, bgp_routing_config=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Child wrapper object for BgpNeighborConfig, used in hierarchical API

    +

    Child wrapper object for BgpNeighborConfig, used in hierarchical API.

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • bgp_routing_config (BgpNeighborConfig) – Contains the actual BgpNeighborConfig object.
      • +
    +
    class com.vmware.nsx_policy.model_client.ChildBgpRoutingConfig(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, bgp_routing_config=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Child wrapper object for BgpRoutingConfig, used in hierarchical API

    +

    Child wrapper object for BgpRoutingConfig, used in hierarchical API.

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • bgp_routing_config (BgpRoutingConfig) – Contains the actual BgpRoutingConfig object.
      • +
    +
    -class com.vmware.nsx_policy.model_client.ChildByodPolicyServiceInstance(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, policy_service_instance=None)
    +class com.vmware.nsx_policy.model_client.ChildByodPolicyServiceInstance(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, byod_policy_service_instance=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    Child wrapper object for ByodPolicyServiceInstance used in hierarchical API.

    @@ -5043,6 +11169,62 @@ API.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • byod_policy_service_instance (ByodPolicyServiceInstance) – Contains actual ByodPolicyServiceInstance.
      • +
    +
    @@ -5055,6 +11237,62 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • communication_entry (CommunicationEntry) – Contains the actual CommunicationEntry object
      • +
    +
    @@ -5067,6 +11305,62 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • communication_map (CommunicationMap) – Contains the actual CommunicationMap object
      • +
    +
    @@ -5079,6 +11373,62 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • constraint (Constraint) – Contains the actual Constraint object
      • +
    +
    @@ -5091,6 +11441,62 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • deployment_zone (DeploymentZone) – Contains the actual DeploymentZone object
      • +
    +
    @@ -5103,6 +11509,62 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • domain (Domain) – Contains the actual domain object
      • +
    +
    @@ -5115,18 +11577,62 @@ names.

    The arguments are used to initialize data attributes with the same names.

    -
    - -
    -
    -class com.vmware.nsx_policy.model_client.ChildEdgeCommunicationMap(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, communication_map=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Child wrapper object for EdgeCommunicationMap, used in hierarchical API

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • domain_deployment_map (DomainDeploymentMap) – Contains the actual DomainDeploymentMap object
      • +
    +
    @@ -5139,6 +11645,130 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • enforcement_point (EnforcementPoint) – Contains the actual Enforcement point object
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.ChildGatewayPolicy(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, gateway_policy=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Child wrapper object for GatewayPolicy, used in hierarchical API

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • gateway_policy (GatewayPolicy) – Contains the actual GatewayPolicy object
      • +
    +
    @@ -5151,66 +11781,961 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • group (Group) – Contains the actual group objects
      • +
    +
    class com.vmware.nsx_policy.model_client.ChildL2Vpn(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, l2_vpn=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Child wrapper object for L2Vpn, used in hierarchical API

    +

    Child wrapper object for L2Vpn, used in hierarchical API.

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • l2_vpn (L2Vpn) – Contains the actual L2Vpn object.
      • +
    +
    class com.vmware.nsx_policy.model_client.ChildL2VpnContext(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, l2_vpn_context=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Child wrapper object for L2VpnContext, used in hierarchical API

    +

    Child wrapper object for L2VpnContext, used in hierarchical API.

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • l2_vpn_context (L2VpnContext) – Contains the actual L2VpnContext object.
      • +
    +
    class com.vmware.nsx_policy.model_client.ChildL3Vpn(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, l3_vpn=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Child wrapper object for L3Vpn, used in hierarchical API

    +

    Child wrapper object for L3Vpn, used in hierarchical API.

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • l3_vpn (L3Vpn) – Contains the actual L3Vpn object.
      • +
    +
    class com.vmware.nsx_policy.model_client.ChildL3VpnContext(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, l3_vpn_context=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Child wrapper object for L3VpnContext, used in hierarchical API

    +

    Child wrapper object for L3VpnContext, used in hierarchical API.

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • l3_vpn_context (L3VpnContext) – Contains the actual L3VpnContext object.
      • +
    +
    -
    -class com.vmware.nsx_policy.model_client.ChildNetwork(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, network=None)
    +
    +class com.vmware.nsx_policy.model_client.ChildLBAppProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, lb_app_profile=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Child wrapper object for Network, used in hierarchical API

    +

    Child wrapper for LBAppProfile, used in hierarchical API

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • lb_app_profile (vmware.vapi.struct.VapiStruct) – Contains the actual LBAppProfile object +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +LBAppProfile. When methods return a value of this class as +a return value, the attribute will contain all the attributes +defined in LBAppProfile.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.ChildLBClientSslProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, lb_client_ssl_profile=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Child wrapper for LBClientSslProfile, used in hierarchical API

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • lb_client_ssl_profile (LBClientSslProfile) – Contains the actual LBClientSslProfile object
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.ChildLBMonitorProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, lb_monitor_profile=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Child wrapper for LBMonitorProfile, used in hierarchical API

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • lb_monitor_profile (vmware.vapi.struct.VapiStruct) – Contains the actual LBMonitorProfile object +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +LBMonitorProfile. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in LBMonitorProfile.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.ChildLBPersistenceProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, lb_persistence_profile=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Child wrapper for LBPersistenceProfile, used in hierarchical API

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • lb_persistence_profile (vmware.vapi.struct.VapiStruct) – Contains the actual LBPersistenceProfile object +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +LBPersistenceProfile. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in LBPersistenceProfile.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.ChildLBPool(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, lb_pool=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Child wrapper for LBPool, used in hierarchical API

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • lb_pool (LBPool) – Contains the actual LBPool object
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.ChildLBServerSslProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, lb_server_ssl_profile=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Child wrapper for LBServerSslProfile, used in hierarchical API

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • lb_server_ssl_profile (LBServerSslProfile) – Contains the actual LBServerSslProfile object
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.ChildLBService(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, lb_service=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Child wrapper for LBService, used in hierarchical API

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • lb_service (LBService) – Contains the actual LBService object
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.ChildLBVirtualServer(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, lb_virtual_server=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Child wrapper for LBVirtualServer, used in hierarchical API

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • lb_virtual_server (LBVirtualServer) – Contains the actual LBVirtualServer object
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.ChildLocaleServices(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, locale_services=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Child wrapper object for LocaleServices, used in hierarchical API

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • locale_services (LocaleServices) – Contains the actual LocaleServices object
      • +
    +
    @@ -5223,6 +12748,61 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    +
    @@ -5235,6 +12815,62 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • policy_dns_forwarder (PolicyDnsForwarder) – Contains the actual PolicyDnsForwarder object
      • +
    +
    @@ -5247,6 +12883,62 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • policy_dns_forwarder_zone (PolicyDnsForwarderZone) – Contains the actual PolicyDnsForwarderZone object
      • +
    +
    @@ -5259,66 +12951,62 @@ names.

    The arguments are used to initialize data attributes with the same names.

    -
    - -
    -
    -class com.vmware.nsx_policy.model_client.ChildPolicyLbMonitorProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, policy_lb_monitor_profile=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Child wrapper for PolicyLbMonitorProfile, used in hierarchical API

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    - -
    -
    -class com.vmware.nsx_policy.model_client.ChildPolicyLbPersistenceProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, policy_lb_persistence_profile=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Child wrapper for PolicyLbPersistenceProfile, used in hierarchical API

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    - -
    -
    -class com.vmware.nsx_policy.model_client.ChildPolicyLbPoolAccess(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, policy_lb_pool_access=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Child wrapper for PolicyLbPoolAccess, used in hierarchical API

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    - -
    -
    -class com.vmware.nsx_policy.model_client.ChildPolicyLbRule(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, policy_lb_rule=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Child wrapper for PolicyLbRule, used in hierarchical API

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    - -
    -
    -class com.vmware.nsx_policy.model_client.ChildPolicyLbVirtualServer(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, policy_lb_virtual_server=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Child wrapper for PolicyLbVirtualServer, used in hierarchical API

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • policy_label (PolicyLabel) – Contains the actual PolicyLabel object
      • +
    +
    @@ -5331,6 +13019,62 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • policy_nat (PolicyNat) – Contains the actual PolicyNAT object
      • +
    +
    @@ -5343,6 +13087,62 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • policy_nat_rule (PolicyNatRule) – Contains the actual PolicyNatRule object
      • +
    +
    @@ -5355,80 +13155,470 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • policy_service_instance (PolicyServiceInstance) – Contains actual PolicyServiceInstance.
      • +
    +
    -
    -class com.vmware.nsx_policy.model_client.ChildProvider(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, provider=None)
    +
    +class com.vmware.nsx_policy.model_client.ChildPrefixList(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, prefix_list=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Child wrapper object for Provider, used in hierarchical API

    +

    Child wrapper object for PrefixList, used in hierarchical API.

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • prefix_list (PrefixList) – Contains the actual PrefixList object.
      • +
    +
    -
    -class com.vmware.nsx_policy.model_client.ChildProviderDeploymentMap(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, provider_deployment_map=None)
    +
    +class com.vmware.nsx_policy.model_client.ChildRedirectionPolicy(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, redirection_policy=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Child wrapper object for ProviderDeploymentMap, used in hierarchical API

    +

    Child wrapper object for RedirectionPolicy used in Hierarchical API.

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • redirection_policy (RedirectionPolicy) – Contains actual RedirectionPolicy.
      • +
    +
    -
    -class com.vmware.nsx_policy.model_client.ChildProviderInterface(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, provider_interface=None)
    +
    +class com.vmware.nsx_policy.model_client.ChildRedirectionRule(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, redirection_rules=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Child wrapper object for ProviderInterface, used in hierarchical API

    +

    Child wrapper object for ChildRedirectionRule used in Hierarchical API.

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • redirection_rules (RedirectionRule) – Contains actual RedirectionRule.
      • +
    +
    -
    -class com.vmware.nsx_policy.model_client.ChildRedirectionCommunicationEntry(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, redirection_communication_entry=None)
    +
    +class com.vmware.nsx_policy.model_client.ChildRule(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, rule=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Child wrapper object for ChildRedirectionCommunicationEntry used in -Hierarchical API.

    +

    Child wrapper object for Rule, used in hierarchical API

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • rule (Rule) – Contains the actual Rule object
      • +
    +
    -
    -class com.vmware.nsx_policy.model_client.ChildRedirectionCommunicationMap(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, redirection_communication_map=None)
    +
    +class com.vmware.nsx_policy.model_client.ChildSecurityPolicy(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, security_policy=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Child wrapper object for RedirectionCommunicationMap used in Hierarchical -API.

    +

    Child wrapper object for SecurityPolicy, used in hierarchical API

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • security_policy (SecurityPolicy) – Contains the actual SecurityPolicy object
      • +
    +
    class com.vmware.nsx_policy.model_client.ChildSegment(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, segment=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Child wrapper object for Segment, used in hierarchical API

    +

    Child wrapper object for Segment, used in hierarchical API.

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • segment (Segment) – Contains the actual Segment object.
      • +
    +
    @@ -5441,6 +13631,62 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • service (Service) – Contains the actual Service object
      • +
    +
    @@ -5453,11 +13699,72 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • service (vmware.vapi.struct.VapiStruct) – Contains the actual ServiceEntry object +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +ServiceEntry. When methods return a value of this class as +a return value, the attribute will contain all the attributes +defined in ServiceEntry.
      • +
    +
    -class com.vmware.nsx_policy.model_client.ChildServiceInstanceEndpoint(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, policy_service_instance=None)
    +class com.vmware.nsx_policy.model_client.ChildServiceInstanceEndpoint(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, service_instance_endpoint=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    Child wrapper object for ServiceInstanceEndpoint used in hierarchical API.

    @@ -5465,54 +13772,742 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • service_instance_endpoint (ServiceInstanceEndpoint) – Contains actual ServiceInstanceEndpoint.
      • +
    +
    -class com.vmware.nsx_policy.model_client.ChildServiceInterface(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, provider_interface=None)
    +class com.vmware.nsx_policy.model_client.ChildServiceInterface(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, service_interface=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Child wrapper object for ServiceInterface, used in hierarchical API

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    - -
    -
    -class com.vmware.nsx_policy.model_client.ChildSslTrustObjectData(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, ssl_trust_object_data=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Child wrapper for SslTrustObjectData, used in hierarchical API

    +

    Child wrapper object for ServiceInterface, used in hierarchical API.

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • service_interface (ServiceInterface) – Contains the actual ServiceInterface object.
      • +
    +
    class com.vmware.nsx_policy.model_client.ChildStaticARPConfig(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, static_arp_config=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Child wrapper object for StaticARPConfig, used in hierarchical API

    +

    Child wrapper object for StaticARPConfig, used in hierarchical API.

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • static_arp_config (StaticARPConfig) – Contains the actual StaticARPConfig object.
      • +
    +
    class com.vmware.nsx_policy.model_client.ChildStaticRoutes(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, static_routes=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Child wrapper object for StaticRoutes, used in hierarchical API

    +

    Child wrapper object for StaticRoutes, used in hierarchical API.

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • static_routes (StaticRoutes) – Contains the actual StaticRoutes object.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.ChildTier0(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, tier0=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Child wrapper object for Tier-0, used in hierarchical API.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • tier0 (Tier0) – Contains the actual Tier-0 object.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.ChildTier0DeploymentMap(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, tier0_deployment_map=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Child wrapper object for Tier0DeploymentMap, used in hierarchical API

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • tier0_deployment_map (Tier0DeploymentMap) – Contains the actual Tier0DeploymentMap object
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.ChildTier0Interface(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, tier0_interface=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Child wrapper object for Tier0Interface, used in hierarchical API.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • tier0_interface (Tier0Interface) – Contains the actual Tier0Interface object.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.ChildTier1(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, tier1=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Child wrapper object for Tier-1 , used in hierarchical API.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • tier1 (Tier1) – Contains the actual Tier-1 object.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.ChildTlsCertificate(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, tls_certificate=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Child wrapper for TlsCertificate, used in hierarchical API

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • tls_certificate (TlsCertificate) – Contains the actual TlsCertificate object
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.ChildTlsTrustData(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, tls_trust_data=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Child wrapper for TlsTrustData, used in hierarchical API

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • tls_trust_data (TlsTrustData) – Contains the actual TlsTrustData object
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.ChildVirtualEndpoint(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, virtual_endpoint=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Child wrapper object for VirtualEndpoint used in hierarchical API.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • virtual_endpoint (VirtualEndpoint) – Contains reference to actual VirtualEndpoint.
      • +
    +
    @@ -5524,6 +14519,18 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • network (str) – destination in cidr format: address-or-block-or-range
      • +
    • next_hop (str) – router format: ip
      • +
    +
    @@ -5535,6 +14542,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • certificate_chain_depth (long or None) – authentication depth is used to set the verification depth in the +client certificates chain. format: int64
      • +
    • client_auth (str or None) –

      Possible values are:

      + +
      +
      client authentication mode
      +
      • +
    • client_auth_ca_ids (list of str or None) – If client auth type is REQUIRED, client certificate must be signed +by one of the trusted Certificate Authorities (CAs), also referred +to as root CAs, whose self signed certificates are specified.
      • +
    • client_auth_crl_ids (list of str or None) – A Certificate Revocation List (CRL) can be specified in the +client-side SSL profile binding to disallow compromised client +certificates.
      • +
    • default_certificate_id (str) – A default certificate should be specified which will be used if the +server does not host multiple hostnames on the same IP address or +if the client does not support SNI extension.
      • +
    • sni_certificate_ids (list of str or None) – Client-side SSL profile binding allows multiple certificates, for +different hostnames, to be bound to the same virtual server.
      • +
    • ssl_profile_id (str or None) – Client SSL profile defines reusable, application-independent client +side SSL properties.
      • +
    +
    CLIENT_AUTH_IGNORE = 'IGNORE'
    @@ -5557,6 +14597,30 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    CLIENT_TYPE_CONTROL_PLANE = 'CONTROL_PLANE'
    @@ -5599,6 +14663,25 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • ip_address (str or None) – IP address of the node from which the backup was taken format: ip +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • node_id (str or None) – ID of the node from which the backup was taken +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • timestamp (long or None) – timestamp of the cluster backup file format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -5610,6 +14693,41 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of ClusterBackupInfo or None) – List of timestamps of backed-up cluster files +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -5621,6 +14739,35 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • cluster_id (str or None) – Unique identifier of this cluster +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • control_cluster_changes_allowed (bool) – True if control cluster nodes may be added or removed
      • +
    • mgmt_cluster_changes_allowed (bool) – True if management cluster nodes may be added or removed
      • +
    +
    @@ -5633,6 +14780,33 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • member_name (str or None) – Name of the group member format: ip +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • member_status (str or None) –

      Possible values are:

      + +
      +
      Status of the group member
      +

      This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    • member_uuid (str or None) – UUID of the group member +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    MEMBER_STATUS_DOWN = 'DOWN'
    @@ -5665,6 +14839,25 @@ This type contains the attributes of a leader.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • leader_uuid (str or None) – Member UUID of the leader +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • lease_version (long or None) – Number of times the lease has been renewed format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • service_name (str or None) – Name of the service +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -5677,6 +14870,49 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    GROUP_STATUS_DEGRADED = 'DEGRADED'
    @@ -5732,6 +14968,22 @@ decommission it explicitly).

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • disk_store_id (str or None) – The (internal) disk-store ID of the member +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • host_address (str or None) – The IP address (or domain name) of the cluster node +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -5743,6 +14995,70 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • appliance_mgmt_listen_addr (str or None) – The IP and port for the appliance management API service on this +node +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • controller_role (ControllerClusterRoleConfig or None) –
      • +
    • external_id (str or None) – Internal identifier provided by the node +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • manager_role (ManagementClusterRoleConfig or None) –
      • +
    +
    @@ -5754,6 +15070,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of ClusterNodeConfig) – Cluster node configuration results
      • +
    +
    @@ -5765,6 +15114,22 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • control_cluster_status (ControlClusterNodeStatus or None) – Clustering status for control plane functions on this node
      • +
    • mgmt_cluster_status (ManagementClusterNodeStatus or None) – Clustering status for management plane functions on this node
      • +
    • system_status (NodeStatusProperties or None) – Node status properties
      • +
    • version (str or None) – Software version running on node +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -5777,6 +15142,20 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:placement_type (str) –

    Possible values are:

    + +

    Specifies the config for the platform through which to deploy the +VM

    +
    PLACEMENT_TYPE_VSPHERECLUSTERNODEVMDEPLOYMENTCONFIG = 'VsphereClusterNodeVMDeploymentConfig'
    @@ -5795,6 +15174,51 @@ deployed or already deployed by the Manager

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    FORM_FACTOR_LARGE = 'LARGE'
    @@ -5805,6 +15229,11 @@ names.

    FORM_FACTOR_MEDIUM = 'MEDIUM'
    +
    +
    +FORM_FACTOR_MEDIUM_LARGE = 'MEDIUM_LARGE'
    +
    +
    FORM_FACTOR_SMALL = 'SMALL'
    @@ -5815,6 +15244,11 @@ names.

    ROLES_CONTROLLER = 'CONTROLLER'
    +
    +
    +ROLES_MANAGER = 'MANAGER'
    +
    +
    @@ -5827,6 +15261,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of ClusterNodeVMDeploymentRequest) – Array of existing ClusterNodeVMDeploymentRequests
      • +
    +
    @@ -5838,6 +15305,69 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    +
    RESOURCE_TYPE_BRIDGEHIGHAVAILABILITYCLUSTERPROFILE = 'BridgeHighAvailabilityClusterProfile'
    @@ -5860,6 +15390,46 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of vmware.vapi.struct.VapiStruct or None) – Cluster Profile Results +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +ClusterProfile. When methods return a value of this class +as a return value, the attribute will contain all the attributes +defined in ClusterProfile. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -5871,6 +15441,26 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    RESOURCE_TYPE_BRIDGEHIGHAVAILABILITYCLUSTERPROFILE = 'BridgeHighAvailabilityClusterProfile'
    @@ -5893,6 +15483,43 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • backup_timestamp (long or None) – Timestamp when backup was initiated in epoch millisecond format: +int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • endpoints (list of ResourceLink or None) – The list of allowed endpoints, based on the current state of the +restore process +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • id (str or None) – Unique id for backup request +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • instructions (list of InstructionInfo or None) – Instructions for users to reconcile Restore operations +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • restore_end_time (long or None) – Timestamp when restore was completed in epoch millisecond format: +int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • restore_start_time (long or None) – Timestamp when restore was started in epoch millisecond format: +int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • status (GlobalRestoreStatus or None) –
      • +
    • step (RestoreStep or None) –
      • +
    • total_steps (long or None) – Total number of steps in the entire restore process format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -5904,6 +15531,23 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:type (str or None) –

    Possible values are:

    + +
    +
    Type of this role configuration
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    TYPE_CONTROLLERCLUSTERROLECONFIG = 'ControllerClusterRoleConfig'
    @@ -5918,13 +15562,28 @@ names.

    -class com.vmware.nsx_policy.model_client.ClusterStatus(control_cluster_status=None, mgmt_cluster_status=None)
    +class com.vmware.nsx_policy.model_client.ClusterStatus(cluster_id=None, control_cluster_status=None, mgmt_cluster_status=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • cluster_id (str or None) – Unique identifier of this cluster +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • control_cluster_status (ControllerClusterStatus or None) – The current status of the control cluster
      • +
    • mgmt_cluster_status (ManagementClusterStatus or None) – The current status of the management cluster
      • +
    +
    @@ -5937,6 +15596,18 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • join_to_existing_cluster (bool) – Property to indicate if the node must join an existing cluster.
      • +
    • shared_secret (str or None) – Shared secret of the cluster.
      • +
    +
    @@ -5948,6 +15619,19 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    @@ -5960,6 +15644,42 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • column_identifier (str or None) – Identifies the column and used for fetching content upon an user +click or drilldown. If column identifier is not provided, the +column’s data will not participate in searches and drilldowns.
      • +
    • drilldown_id (str or None) – Id of drilldown widget, if any. Id should be a valid id of an +existing widget.
      • +
    • field (str) – Field from which values of the column will be derived.
      • +
    • hidden (bool or None) – If set to true, hides the column
      • +
    • label (Label) – Label of the column.
      • +
    • navigation (str or None) – Hyperlink of the specified UI page that provides details. If +drilldown_id is provided, then navigation cannot be used.
      • +
    • render_configuration (list of RenderConfiguration or None) – Render configuration to be applied, if any.
      • +
    • sort_ascending (bool or None) – If true, the value of the column are sorted in ascending order. +Otherwise, in descending order.
      • +
    • sort_key (str or None) – Sorting on column is based on the sort_key. sort_key represents the +field in the output data on which sort is requested.
      • +
    • tooltip (list of Tooltip or None) – Multi-line text to be shown on tooltip while hovering over a cell +in the grid.
      • +
    • type (str) –

      Possible values are:

      + +
      +
      Data type of the field.
      +
      • +
    +
    TYPE_DATE = 'Date'
    @@ -5988,6 +15708,110 @@ types of traffic flowing between workload groups.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • action (str or None) –

      Possible values are:

      + +
      +
      The action to be applied to all the services
      +
      • +
    • destination_groups (list of str or None) – We need paths as duplicate names may exist for groups under +different domains.In order to specify all groups, use the constant +"ANY". This is case insensitive. If "ANY" is used, +it should be the ONLY element in the group array. Error will be +thrown if ANY is used in conjunction with other values.
      • +
    • logged (bool or None) – Flag to enable packet logging. Default is disabled.
      • +
    • scope (list of str or None) – The list of policy paths where the communication entry is applied +Edge/LR/T0/T1/LRP/CGW/MGW/etc. Note that a given rule can be +applied on multiple LRs/LRPs.
      • +
    • sequence_number (long or None) – This field is used to resolve conflicts between multiple +CommunicationEntries under CommunicationMap for a Domain format: +int32
      • +
    • services (list of str or None) – In order to specify all services, use the constant "ANY". +This is case insensitive. If "ANY" is used, it should be +the ONLY element in the services array. Error will be thrown if ANY +is used in conjunction with other values.
      • +
    • source_groups (list of str or None) – We need paths as duplicate names may exist for groups under +different domains. In order to specify all groups, use the constant +"ANY". This is case insensitive. If "ANY" is used, +it should be the ONLY element in the group array. Error will be +thrown if ANY is used in conjunction with other values.
      • +
    +
    ACTION_ALLOW = 'ALLOW'
    @@ -6015,6 +15839,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of CommunicationEntry) – CommunicationEntry list results
      • +
    +
    @@ -6028,6 +15885,28 @@ map or communication entry w.r.t to another one.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    OPERATION_AFTER = 'insert_after'
    @@ -6061,6 +15940,92 @@ along with the Domain.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • category (str or None) – Policy framework provides four pre-defined categories for +classifying a communication map. They are "Emergency", +"Infrastructure" "Environmental" and +"Application". There is a pre-determined order in which the +policy framework manages the priority of these communication maps. +Emergency category has the highest priority followed by +Infrastructure, Environmental and then Application rules. +Administrator can choose to categorize a communication map into the +above categories or can choose to leave it empty. If empty it will +have the least precedence w.r.t the above four categories.
      • +
    • communication_entries (list of CommunicationEntry or None) – CommunicationEntries that are a part of this CommunicationMap
      • +
    • precedence (long or None) –
      • +
    +
    @@ -6073,6 +16038,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of CommunicationMap) – CommunicationMap list results
      • +
    +
    @@ -6085,6 +16083,26 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • expression (list of CommunityMatchOperation) – Array of community match operations
      • +
    • operator (str or None) –

      Possible values are:

      + +

      Operator for evaluating community match expressions. AND logical +AND operator +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    +
    OPERATOR_AND = 'AND'
    @@ -6102,6 +16120,34 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    MATCH_OPERATOR_ALL = 'MATCH_ALL'
    @@ -6138,6 +16184,54 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • last_sync_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • cm_local_id (str or None) – Local Id of the compute collection in the Compute Manager +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • external_id (str or None) – External ID of the ComputeCollection in the source Compute manager, +e.g. mo-ref in VC +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • origin_id (str or None) – Id of the compute manager from where this Compute Collection was +discovered +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • origin_properties (list of KeyValuePair or None) – Key-Value map of additional specific properties of compute +collection in the Compute Manager +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • origin_type (str or None) – ComputeCollection type like VC_Cluster. Here the Compute Manager +type prefix would help in differentiating similar named Compute +Collection types from different Compute Managers +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • owner_id (str or None) – Id of the owner of compute collection in the Compute Manager +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -6150,6 +16244,65 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • auto_install_nsx (bool) – Indicates whether NSX components should be automcatically +installed. When ‘true’ NSX components will be automatically +installed on the new host added to compute collection.
      • +
    • compute_collection_id (str) – Associated compute collection id
      • +
    +
    @@ -6162,6 +16315,41 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of ComputeCollectionFabricTemplate or None) – List of compute collection fabric template +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -6174,6 +16362,84 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of ComputeCollection) – Compute Collection list results
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.ComputeCollectionNetworkInterfacesListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    List of network interfaces for all discovered nodes in compute collection

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of DiscoveredNodeNetworkInterfaces) – List of discovered node with network interfaces
      • +
    +
    @@ -6186,6 +16452,75 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • compute_collection_ids (list of str) – Associated compute collection ids
      • +
    • host_switch_spec (vmware.vapi.struct.VapiStruct or None) – Property ‘host_switch_spec’ can be used to create either standard +host switch or preconfigured host switch. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +HostSwitchSpec. When methods return a value of this class +as a return value, the attribute will contain all the attributes +defined in HostSwitchSpec.
      • +
    • network_migration_spec_ids (list of NetworkMigrationSpecTypeIdEntry or None) – Property ‘network_migration_spec_ids’ should only be used for +compute collections which are clusters in VMware vCenter. Currently +only HostProfileNetworkMigrationSpec type is supported. This +specification will only apply to Stateless ESX hosts which are +under this vCenter cluster.
      • +
    • transport_zone_endpoints (list of TransportZoneEndPoint or None) – Transport zone endpoints
      • +
    +
    @@ -6198,6 +16533,22 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • compute_collection_id (str or None) – Associated compute collection id +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • template_states (list of TransportNodeTemplateState or None) – Transport node template states in compute collection +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -6210,6 +16561,41 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of ComputeCollectionTransportNodeTemplateState or None) – State list per compute collection +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -6221,6 +16607,72 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • credential (vmware.vapi.struct.VapiStruct or None) – Login credentials for the compute manager +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +LoginCredential. When methods return a value of this class +as a return value, the attribute will contain all the attributes +defined in LoginCredential.
      • +
    • origin_properties (list of KeyValuePair or None) – Key-Value map of additional specific properties of compute manager +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • origin_type (str) – Compute manager type like vCenter
      • +
    • server (str) – IP address or hostname of compute manager format: hostname-or-ip
      • +
    +
    @@ -6233,6 +16685,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of ComputeManager) – List of compute managers
      • +
    +
    @@ -6245,6 +16730,113 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • key (str) –

      Possible values are:

      + +
      +
      Key
      +
      • +
    • member_type (str) –

      Possible values are:

      + +
      +
      Group member type
      +
      • +
    • operator (str) –

      Possible values are:

      + +
      +
      operator
      +
      • +
    • value (str) – Value
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    KEY_NAME = 'Name'
    @@ -6291,6 +16883,24 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • source_ip (str or None) – The source ip used by the fowarder of the zone. If no source ip +specified, the ip address of listener of the dns forwarder will be +used. format: ipv4
      • +
    • upstream_servers (list of str) – Ip address of the upstream dns servers the dns forwarder accesses. +format: ipv4
      • +
    • domain_names (list of str) – A forwarder domain name should be a valid FQDN. If reverse lookup +is needed for this zone, reverse lookup domain name like +X.in-addr.arpa can be defined. Here the X represents a subnet.
      • +
    +
    @@ -6316,6 +16926,27 @@ conjunction with some exression. Example - { "condition" : {

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    OPERATOR_EQUALS = 'EQUALS'
    @@ -6343,6 +16974,40 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    STATE_FAILED = 'failed'
    @@ -6390,6 +17055,43 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • failure_code (long or None) – Error code format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • failure_message (str or None) – Error message in case of failure +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • state (str or None) –

      Possible values are:

      + +
      +
      State of configuration on this sub system
      +

      This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    • sub_system_address (str or None) – URI of backing resource on sub system +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sub_system_id (str or None) – Identifier of backing resource on sub system +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sub_system_type (str or None) – Type of backing resource on sub system +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    STATE_FAILED = 'failed'
    @@ -6422,6 +17124,95 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • conjunction_operator (str) –

      Possible values are:

      + +
      +
      Conjunction Operator Node
      +
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    CONJUNCTION_OPERATOR_AND = 'AND'
    @@ -6445,6 +17236,28 @@ between the source and destination elements.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • dest_element_id (str or None) – Unique element ID of destination element to which the connection is +established. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • number_of_events (long or None) – Represents the number of events/flows between the source and +destination elements. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • src_element_id (str or None) – Unique element ID of source element from which the connection is +established. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -6459,6 +17272,63 @@ connection information is returned.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • group_connections (list of GroupConnection or None) – List of Group Communications +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • network_connections (list of NetworkConnection or None) –
      • +
    • process_connections (list of ProcessConnection or None) – List of process connections +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • vm_connections (list of VMConnection or None) – List of VM connections +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.ConnectivityAdvancedConfig(connectivity=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Advanced configuration for Policy connectivity

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:connectivity (str or None) –

    Possible values are:

    + +

    Connectivity configuration to manually connect (ON) or disconnect +(OFF) a logical entity from network topology.

    +
    +
    +
    +CONNECTIVITY_OFF = 'OFF'
    +
    + +
    +
    +CONNECTIVITY_ON = 'ON'
    +
    +
    @@ -6472,6 +17342,19 @@ realized entities and enforcement points.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • consolidated_status (ConsolidatedStatus or None) – Consolidated state across enforcement points.
      • +
    • consolidated_status_per_enforcement_point (list of ConsolidatedStatusPerEnforcementPoint or None) – Aggregated consolidated status by enforcement point
      • +
    • intent_path (str or None) – Intent path of the object representing this consolidated state
      • +
    +
    @@ -6484,6 +17367,15 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:consolidated_status (str or None) – Possible values could be SUCCESS, ERROR, UNAVAILABLE This list is +not exhaustive.
    @@ -6496,6 +17388,18 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • consolidated_status (ConsolidatedStatus or None) – Detailed consolidated realized status for intent object
      • +
    • enforcement_point_id (str or None) – Enforcement point id used to consolidate state
      • +
    +
    @@ -6521,6 +17425,88 @@ vCenter. { "target":{

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • constraint_expression (vmware.vapi.struct.VapiStruct) – Expression to constrain the target attribute value. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +ConstraintExpression. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in ConstraintExpression.
      • +
    • message (str or None) – User friendly message to be shown to users upon violation.
      • +
    • target (ConstraintTarget) – Target resource attribute details.
      • +
    +
    @@ -6534,11 +17520,78 @@ present for extensibility.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    +
    RESOURCE_TYPE_ENTITYINSTANCECOUNTCONSTRAINTEXPRESSION = 'EntityInstanceCountConstraintExpression'
    +
    +
    +RESOURCE_TYPE_FIELDSANITYCONSTRAINTEXPRESSION = 'FieldSanityConstraintExpression'
    +
    +
    RESOURCE_TYPE_RELATEDATTRIBUTECONDITIONALEXPRESSION = 'RelatedAttributeConditionalExpression'
    @@ -6561,6 +17614,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of Constraint) – Constraint list results
      • +
    +
    @@ -6578,6 +17664,22 @@ given as: { "target_resource_type":"CommunicationEntry",

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • attribute (str or None) – Attribute name of the target entity.
      • +
    • path_prefix (str or None) – Path prefix of the entity to apply constraint. This is required to +further disambiguiate if multiple policy entities share the same +resource type. Example - Edge FW and DFW use the same resource type +CommunicationMap, CommunicationEntry, Group, etc.
      • +
    • target_resource_type (str) – Resource type of the target entity.
      • +
    +
    @@ -6591,6 +17693,92 @@ have a common purpose.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • labels (list of Label or None) – Labels for the container.
      • +
    • navigation (str or None) – Hyperlink of the specified UI page that provides details.
      • +
    • span (long or None) – Represents the horizontal span of the container. format: int32
      • +
    • widgets (list of WidgetItem or None) – If not specified, creates an empty container.
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str) – Title of the widget.
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      Supported visualization types are LabelValueConfiguration, +DonutConfiguration, GridConfiguration, StatsConfiguration, +MultiWidgetConfiguration and ContainerConfiguration.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • datasources (list of Datasource or None) – The ‘datasources’ represent the sources from which data will be +fetched. Currently, only NSX-API is supported as a ‘default’ +datasource. An example of specifying ‘default’ datasource along +with the urls to fetch data from is given at ‘example_request’ +section of ‘CreateWidgetConfiguration’ API.
      • +
    • drilldown_id (str or None) – Id of drilldown widget, if any. Id should be a valid id of an +existing widget. A widget is considered as drilldown widget when it +is associated with any other widget and provides more detailed +information about any data item from the parent widget.
      • +
    • footer (Footer or None) –
      • +
    • is_drilldown (bool or None) – Set to true if this widget should be used as a drilldown.
      • +
    • shared (bool or None) – Please use the property ‘shared’ of View instead of this. The +widgets of a shared view are visible to other users.
      • +
    • weight (long or None) – Specify relavite weight in WidgetItem for placement in a view. +Please see WidgetItem for details. format: int32
      • +
    +
    @@ -6602,6 +17790,28 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    CONTROL_CLUSTER_STATUS_CONNECTED = 'CONNECTED'
    @@ -6628,6 +17838,45 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    FAILURE_STATUS_CONNECTION_REFUSED = 'CONNECTION_REFUSED'
    @@ -6689,6 +17938,31 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    TYPE_CONTROLLERCLUSTERROLECONFIG = 'ControllerClusterRoleConfig'
    @@ -6710,6 +17984,24 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:status (str or None) –

    Possible values are:

    + +
    +
    The current status of the controller cluster
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    STATUS_STABLE = 'STABLE'
    @@ -6736,6 +18028,29 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • node_interface_properties (list of NodeInterfaceProperties or None) – Array of Node interface statistic properties +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • node_interface_statistics (list of NodeInterfaceStatisticsProperties or None) – Array of Node network interface statistic properties +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • node_status (ClusterNodeStatus or None) –
      • +
    • node_status_properties (list of NodeStatusProperties or None) – Time series of the node’s system properties
      • +
    • role_config (ControllerClusterRoleConfig or None) –
      • +
    +
    @@ -6749,6 +18064,20 @@ NUMA node configuration for Enhanced Networking Stack enabled HostSwitch.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • num_lcores (long) – Number of Logical cpu cores (Lcores) to be placed on a specified +NUMA node format: int32
      • +
    • numa_node_index (long) – Unique index of the Non Uniform Memory Access (NUMA) node format: +int32
      • +
    +
    @@ -6760,6 +18089,63 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • details (X509Crl or None) – details of the X509Crl object
      • +
    • pem_encoded (str) – pem encoded crl data
      • +
    +
    @@ -6772,6 +18158,41 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of Crl or None) – CRL list +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -6783,6 +18204,62 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • pem_encoded (str) – pem encoded crl data
      • +
    +
    @@ -6794,6 +18271,22 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • key_size (list of long or None) – supported key sizes for the algorithm format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • name (str or None) – crypto algorithm name +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -6805,6 +18298,75 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • algorithm (str) –

      Possible values are:

      + +

      Cryptographic algorithm(asymmetric ) used by the public key for +data encryption

      +
      • +
    • key_size (long) – size measured in bits of the public key used in a cryptographic +algorithm format: int64
      • +
    • pem_encoded (str or None) – pem encoded certificate data +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • subject (Principal) – the certificate owner’s information (CN, O, OU, C, ST, L)
      • +
    +
    ALGORITHM_DSA = 'DSA'
    @@ -6827,6 +18389,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of Csr) – CSR list
      • +
    +
    @@ -6839,6 +18434,14 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:file_name (str or None) – File name set by HTTP server if API returns CSV result as a file.
    @@ -6863,6 +18466,36 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    CURRENT_STEP_CLUSTER_BACKUP = 'BACKUP_CREATING_CLUSTER_BACKUP'
    @@ -6885,103 +18518,6 @@ names.

    -
    -
    -class com.vmware.nsx_policy.model_client.CustomPolicyLbPersistenceProfile(persistence=None, persistence_shared=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='CustomPolicyLbPersistenceProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Some applications maintain state and require all relevant connections to be -sent to the same server as the application state is not synchronized among -servers. Persistence is enabled on a PolicyLbVirtualServer by binding a -persistence profile to it.

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    - -
    - -
    -
    -PERSISTENCE_SOURCE_IP = 'SOURCE_IP'
    -
    - -
    - -
    -
    -class com.vmware.nsx_policy.model_client.CustomPolicyLbVirtualServer(app_protocol=None, client_ssl_certificate_ids=None, client_ssl_settings=None, default_client_ssl_certificate_id=None, server_auth_ca_certificate_ids=None, server_ssl_settings=None, insert_client_ip_header=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, access_log_enabled=None, ip_address=None, lb_persistence_profile=None, ports=None, router_path=None, traffic_source=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Virtual server acts as a facade to an application, receives all client -connections over a specified protocol and distributes them among the -backend servers. This custom type allows for more complex settings than the -simplified PolicyLbVirtualServer types. This object allows for complex -configurations for PolicyLbVirtualServers of all types. All HTTP specific -inputs will be rejected when combined with TPC or UDP protocols.

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    -APP_PROTOCOL_HTTP = 'HTTP'
    -
    - -
    -
    -APP_PROTOCOL_HTTPS = 'HTTPS'
    -
    - -
    -
    -APP_PROTOCOL_TCP = 'TCP'
    -
    - -
    -
    -APP_PROTOCOL_UDP = 'UDP'
    -
    - -
    -
    -CLIENT_SSL_SETTINGS_BASE_SECURE_111317 = 'BASE_SECURE_111317'
    -
    - -
    -
    -CLIENT_SSL_SETTINGS_HIGH_SECURE_111317 = 'HIGH_SECURE_111317'
    -
    - -
    -
    -CLIENT_SSL_SETTINGS_MODERATE_SECURE_111317 = 'MODERATE_SECURE_111317'
    -
    - -
    -
    -SERVER_SSL_SETTINGS_BASE_SECURE_111317 = 'BASE_SECURE_111317'
    -
    - -
    -
    -SERVER_SSL_SETTINGS_DISABLED = 'DISABLED'
    -
    - -
    -
    -SERVER_SSL_SETTINGS_HIGH_SECURE_111317 = 'HIGH_SECURE_111317'
    -
    - -
    -
    -SERVER_SSL_SETTINGS_MODERATE_SECURE_111317 = 'MODERATE_SECURE_111317'
    -
    - -
    -
    class com.vmware.nsx_policy.model_client.DSRule(links=None, schema=None, self_=None, revision=None, owner=None, description=None, display_name=None, id=None, resource_type=None, action=None, applied_tos=None, destinations=None, destinations_excluded=None, direction=None, disabled=None, ip_protocol=None, is_default=None, logged=None, notes=None, rule_tag=None, services=None, sources=None, sources_excluded=None)
    @@ -6991,6 +18527,91 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • owner (OwnerResourceLink or None) – Owner of this resource
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Identifier of the resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • action (str) –

      Possible values are:

      + +

      Action enforced on the packets which matches the distributed +service rule. Currently DS Layer supports below actions. ALLOW - +Forward any packet when a rule with this action gets a match (Used +by Firewall). DROP - Drop any packet when a rule with this action +gets a match. Packets won’t go further(Used by Firewall). REJECT - +Terminate TCP connection by sending TCP reset for a packet when a +rule with this action gets a match (Used by Firewall). REDIRECT - +Redirect any packet to a partner appliance when a rule with this +action gets a match (Used by Service Insertion). DO_NOT_REDIRECT - +Do not redirect any packet to a partner appliance when a rule with +this action gets a match (Used by Service Insertion).

      +
      • +
    • applied_tos (list of ResourceReference or None) – List of object where rule will be enforced. The section level field +overrides this one. Null will be treated as any.
      • +
    • destinations (list of ResourceReference or None) – List of the destinations. Null will be treated as any.
      • +
    • destinations_excluded (bool or None) – Negation of the destination.
      • +
    • direction (str or None) –

      Possible values are:

      + +

      Rule direction in case of stateless distributed service rules. This +will only considered if section level parameter is set to +stateless. Default to IN_OUT if not specified.

      +
      • +
    • disabled (bool or None) – Flag to disable rule. Disabled will only be persisted but never +provisioned/realized.
      • +
    • ip_protocol (str or None) –

      Possible values are:

      + +
      +
      Type of IP packet that should be matched while enforcing the rule.
      +
      • +
    • is_default (bool or None) – Flag to indicate whether rule is default. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • logged (bool or None) – Flag to enable packet logging. Default is disabled.
      • +
    • notes (str or None) – User notes specific to the rule.
      • +
    • rule_tag (str or None) – User level field which will be printed in CLI and packet logs.
      • +
    • services (list of DSService or None) – List of the services. Null will be treated as any.
      • +
    • sources (list of ResourceReference or None) – List of sources. Null will be treated as any.
      • +
    • sources_excluded (bool or None) – Negation of the source.
      • +
    +
    ACTION_ALLOW = 'ALLOW'
    @@ -7057,6 +18678,43 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • details (list of ConfigurationStateElement or None) – Array of configuration state of various sub systems +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • failure_code (long or None) – Error code format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • failure_message (str or None) – Error message in case of failure +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • state (str or None) –

      Possible values are:

      + +
      +
      Gives details of state of desired configuration
      +

      This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    • revision_desired (long or None) – revision number of the desired state format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    STATE_FAILED = 'failed'
    @@ -7103,6 +18761,83 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • applied_tos (list of ResourceReference or None) – List of objects where the rules in this section will be enforced. +This will take precedence over rule level appliedTo.
      • +
    • is_default (bool or None) – It is a boolean flag which reflects whether a distributed service +section is default section or not. Each Layer 3 and Layer 2 section +will have at least and at most one default section. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • rule_count (long or None) – Number of rules in this section. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • section_type (str) –

      Possible values are:

      + +

      Type of the rules which a section can contain. Only homogeneous +sections are supported.

      +
      • +
    • stateful (bool) – Stateful or Stateless nature of distributed service section is +enforced on all rules inside the section. Layer3 sections can be +stateful or stateless. Layer2 sections can only be stateless.
      • +
    +
    SECTION_TYPE_L3REDIRECT = 'L3REDIRECT'
    @@ -7129,6 +18864,42 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of DSSection or None) – List of the distributed service sections. The list has to be +homogenous. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -7140,6 +18911,43 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • details (list of ConfigurationStateElement or None) – Array of configuration state of various sub systems +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • failure_code (long or None) – Error code format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • failure_message (str or None) – Error message in case of failure +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • state (str or None) –

      Possible values are:

      + +
      +
      Gives details of state of desired configuration
      +

      This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    • revision_desired (long or None) – revision number of the desired state format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    STATE_FAILED = 'failed'
    @@ -7186,6 +18994,33 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • is_valid (bool or None) – Will be set to false if the referenced NSX resource has been +deleted. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • target_display_name (str or None) – Display name of the NSX resource. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • target_id (str or None) – Identifier of the NSX resource.
      • +
    • target_type (str or None) – Type of the NSX resource.
      • +
    • service (vmware.vapi.struct.VapiStruct or None) – Distributed Service API accepts raw protocol and ports as part of +NS service element in Distributed Service Rule that describes +traffic corresponding to an NSService. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +NSServiceElement. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in NSServiceElement.
      • +
    +
    @@ -7197,6 +19032,22 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • hour_of_day (long) – Hour at which data will be collected. Specify a value between 0 +through 23. format: int64
      • +
    • minutes (long or None) – Minute at which data will be collected. Specify a value between 0 +through 59. format: int64
      • +
    • frequency_type (str) – Specify one of DailyTelemetrySchedule, WeeklyTelemetrySchedule, or +MonthlyTelemetrySchedule.
      • +
    +
    @@ -7209,6 +19060,25 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    DATA_TYPE_STATISTICS = 'STATISTICS'
    @@ -7231,18 +19101,20 @@ names.

    The arguments are used to initialize data attributes with the same names.

    -
    - -
    -
    -class com.vmware.nsx_policy.model_client.DeleteRequestParameters(force=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Parameters that affect how delete operations are processed

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    + +++ + + + +
    Parameters:
      +
    • display_name (str) – Name of a datasource instance.
      • +
    • urls (list of UrlAlias) – Array of urls relative to the datasource configuration. For +example, api/v1/fabric/nodes is a relative url of nsx-manager +instance.
      • +
    +
    @@ -7254,6 +19126,18 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:placement_type (str) –

    Possible values are:

    + +
    PLACEMENT_TYPE_VSPHEREDEPLOYMENTCONFIG = 'VsphereDeploymentConfig'
    @@ -7271,6 +19155,18 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • fabric_module_version (str) – version of fabric module
      • +
    • versioned_deployment_specs (list of VersionedDeploymentSpec) – List of Versioned deployment specs
      • +
    +
    @@ -7284,6 +19180,20 @@ service is created. These attributes are opaque to NSX.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • attributes (list of Attribute or None) – List of attributes specific to a partner for which the service is +created. There attributes are passed on to the partner appliance +and is opaque to the NSX Manager.
      • +
    • name (str or None) – Deployment Template name.
      • +
    +
    @@ -7296,6 +19206,81 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • enforcement_points (list of EnforcementPoint or None) – Logical grouping of enforcement points
      • +
    +
    @@ -7308,6 +19293,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of DeploymentZone) – Deployment Zones
      • +
    +
    @@ -7322,6 +19340,65 @@ the enable property.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • customer_id (str) – The unique ID assigned to a customer.
      • +
    • enabled (bool or None) – Flag to enable or disable the feature.
      • +
    • provider_url (str) – URL of the provider which provides the reputation and category +databases.
      • +
    +
    @@ -7334,6 +19411,18 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • client_block_enabled (bool) – Indicates whether DHCP client blocking is enabled
      • +
    • server_block_enabled (bool) – Indicates whether DHCP server blocking is enabled
      • +
    +
    @@ -7345,6 +19434,71 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • gateway_ip (str or None) – gateway ip format: ip
      • +
    • lease_time (long or None) – lease time, in seconds, [60-(2^32-1)], default 86400 format: int64
      • +
    • options (DhcpOptions or None) – If an option is defined at server level and not configred at +ip-pool/static-binding level, the option will be inherited to +ip-pool/static-binding. If both define a same-code option, the +option defined at ip-pool/static-binding level take precedence over +that defined at server level.
      • +
    • allocation_ranges (list of IpPoolRange) – ip-ranges
      • +
    • error_threshold (long or None) – error threshold, valid [80-100], default 100 format: int64
      • +
    • warning_threshold (long or None) – warning threshold, valid [50-80], default 80 format: int64
      • +
    +
    @@ -7356,6 +19510,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of DhcpIpPool) – paginated list of dhcp ip pools
      • +
    +
    @@ -7367,6 +19554,14 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:static_routes (list of ClasslessStaticRoute) – dhcp classless static routes
    @@ -7378,6 +19573,18 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    @@ -7389,6 +19596,69 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • edge_cluster_id (str) – edge cluster uuid
      • +
    • edge_cluster_member_indexes (list of long or None) – If none is provided, the NSX will auto-select two edge-nodes from +the given edge cluster. If user provides only one edge node, there +will be no HA support. If both the member indexes are changed in a +same PUT API, e.g. change from [a,b] to [x,y], the current dhcp +server states will be lost, which could cause the network crash due +to ip conflicts. Hence the suggestion is to change only one member +index in one single update, e.g. from [a,b] to [a,y]. format: int64
      • +
    +
    @@ -7400,6 +19670,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of DhcpProfile) – paginated list of dhcp profiles
      • +
    +
    @@ -7411,6 +19714,62 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • server_addresses (list of str) –
      • +
    +
    @@ -7422,6 +19781,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of DhcpRelayProfile) – Dhcp relay profile list results
      • +
    +
    @@ -7433,6 +19825,62 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • dhcp_relay_profile_id (str) – dhcp relay profile referenced by the dhcp relay service
      • +
    +
    @@ -7444,6 +19892,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of DhcpRelayService) – Dhcp relay service list results
      • +
    +
    @@ -7455,6 +19936,71 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • gateway_ip (str or None) – gateway ip format: ip
      • +
    • lease_time (long or None) – lease time, in seconds, [60-(2^32-1)], default 86400 format: int64
      • +
    • options (DhcpOptions or None) – If an option is defined at server level and not configred at +ip-pool/static-binding level, the option will be inherited to +ip-pool/static-binding. If both define a same-code option, the +option defined at ip-pool/static-binding level take precedence over +that defined at server level.
      • +
    • host_name (str or None) – host name format: hostname
      • +
    • ip_address (str) – ip addres format: ip
      • +
    • mac_address (str) – mac address
      • +
    +
    @@ -7466,11 +20012,44 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of DhcpStaticBinding) – paginated list of dhcp static bindings
      • +
    +
    -class com.vmware.nsx_policy.model_client.DirectoryAdDomain(base_distinguished_name=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, name=None)
    +class com.vmware.nsx_policy.model_client.DirectoryAdDomain(base_distinguished_name=None, sync_settings=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, name=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    Active Directory Domain

    @@ -7478,6 +20057,74 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • base_distinguished_name (str or None) – Each active directory domain has a domain naming context (NC), +which contains domain-specific data. The root of this naming +context is represented by a domain’s distinguished name (DN) and is +typically referred to as the NC head.
      • +
    • sync_settings (DirectoryDomainSyncSettings or None) – Each domain sync settings can be changed using this object. It is +not required since there are default values used if there is no +specification for this object.
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) – Domain resource type comes from multiple sub-classes extending this +base class. For example, DirectoryAdDomain is one accepted +resource_type. If there are more sub-classes defined, they will +also be accepted resource_type.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • name (str) – Directory domain name which best describes the domain. It could be +unique fqdn name or it could also be descriptive. There is no +unique contraint for domain name among different domains.
      • +
    +
    @@ -7489,6 +20136,77 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • object_guid (str) – GUID is a 128-bit value that is unique not only in the enterprise +but also across the world. GUIDs are assigned to every object +created by Active Directory, not just User and Group objects.
      • +
    • secure_id (str) – A security identifier (SID) is a unique value of variable length +used to identify a trustee. A SID consists of the following +components - The revision level of the SID structure; A 48-bit +identifier authority value that identifies the authority that +issued the SID; A variable number of subauthority or relative +identifier (RID) values that uniquely identify the trustee relative +to the authority that issued the SID.
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) – Directory group resource type comes from multiple sub-classes +extending this base class. For example, DirectoryAdGroup is one +accepted resource_type. If there are more sub-classes defined, they +will also be accepted resource_type.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • distinguished_name (str) – Directory group distinguished name
      • +
    • domain_id (str) – Domain ID this directory group belongs to.
      • +
    • domain_sync_node_id (str) – Domain sync node under which this directory group is located.
      • +
    +
    @@ -7501,6 +20219,67 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) – Domain resource type comes from multiple sub-classes extending this +base class. For example, DirectoryAdDomain is one accepted +resource_type. If there are more sub-classes defined, they will +also be accepted resource_type.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • name (str) – Directory domain name which best describes the domain. It could be +unique fqdn name or it could also be descriptive. There is no +unique contraint for domain name among different domains.
      • +
    +
    @@ -7513,11 +20292,49 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of vmware.vapi.struct.VapiStruct) – List of Directory Domains +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +DirectoryDomain. When methods return a value of this class +as a return value, the attribute will contain all the attributes +defined in DirectoryDomain.
      • +
    +
    -class com.vmware.nsx_policy.model_client.DirectoryDomainSyncNode(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, distinguished_name=None, domain_id=None)
    +class com.vmware.nsx_policy.model_client.DirectoryDomainSyncNode(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, distinguished_name=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    Directory Domain Synchronization Nodes

    @@ -7525,6 +20342,62 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • distinguished_name (str) – Distinguished name of the domain sync node
      • +
    +
    @@ -7537,6 +20410,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of DirectoryDomainSyncNode) – List of Directory Domain Synchronization Nodes
      • +
    +
    @@ -7549,11 +20455,44 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of str) – Directory domain sync remote node candidate
      • +
    +
    -class com.vmware.nsx_policy.model_client.DirectoryDomainSyncSettings(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, delta_sync_interval=None, enable_full_sync=None, full_sync_cron_expr=None, sync_entire_domain=None)
    +class com.vmware.nsx_policy.model_client.DirectoryDomainSyncSettings(delta_sync_interval=None, full_sync_cron_expr=None, sync_entire_domain=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    Domain synchronization settings

    @@ -7561,6 +20500,25 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • delta_sync_interval (long or None) – Directory domain delta synchronization interval time between two +delta sync in minutes. format: int64
      • +
    • full_sync_cron_expr (str or None) – Directory domain full synchronization schedule using cron +expression. For example, cron expression "0 0 12 ? \* SUN +\*" means full sync is scheduled every Sunday midnight. If +this object is null, it means there is no background cron job +running for full sync.
      • +
    • sync_entire_domain (bool or None) – This flag will decide whether to synchronize the directory objects +under entire domain or configured synchronization nodes.
      • +
    +
    @@ -7573,6 +20531,119 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • avg_delta_sync_time (long or None) – All the historical delta sync are counted in calculating the +average delta sync time in seconds. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • avg_full_sync_time (long or None) – All the historical full sync are counted in calculating the average +full sync time in seconds. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • current_state (str or None) –

      Possible values are:

      + +

      Current running state of the directory domain in synchronization +life cycle. It could be one of the following three states. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    • current_state_begin_time (long or None) – Since what time the current state has begun. The time is expressed +in millisecond epoch time. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • num_delta_sync (long or None) – number of historical delta sync initiated either by system or by +API request. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • num_full_sync (long or None) – number of historical full sync initiated either by system or by API +request. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • prev_sync_end_time (long or None) – Directory domain previous sync ending time expressed in millisecond +epoch time. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • prev_sync_status (str or None) –

      Possible values are:

      + +

      Directory domain previous sync status. It could be one of the +following two states. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    • prev_sync_type (str or None) –

      Possible values are:

      + +

      Directory domain previous sync type. It could be one of the +following three states. Right after the directory domain is +configured, this field is set to IDLE. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    +
    CURRENT_STATE_DELTA_SYNC = 'DELTA_SYNC'
    @@ -7629,6 +20700,67 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) – Directory group resource type comes from multiple sub-classes +extending this base class. For example, DirectoryAdGroup is one +accepted resource_type. If there are more sub-classes defined, they +will also be accepted resource_type.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • distinguished_name (str) – Directory group distinguished name
      • +
    • domain_id (str) – Domain ID this directory group belongs to.
      • +
    • domain_sync_node_id (str) – Domain sync node under which this directory group is located.
      • +
    +
    @@ -7640,6 +20772,44 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of vmware.vapi.struct.VapiStruct) – Directory group list +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +DirectoryGroup. When methods return a value of this class +as a return value, the attribute will contain all the attributes +defined in DirectoryGroup.
      • +
    +
    @@ -7651,6 +20821,68 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • group_distinguished_name (str) – Directory group distinguished name this group member belongs to.
      • +
    • group_id (str) – Directory group id this group member belongs to
      • +
    • member_group_distinguished_name (str) – Directory group name this group member owns
      • +
    • member_group_id (str) – Directory group id this group member owns
      • +
    • nested (bool) – Whether this member group is a directory member of the parent group +speicified by group_id or a nested member group which parent group +is also member group of the parent group speicified by group_id.
      • +
    +
    @@ -7662,6 +20894,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of DirectoryGroupMember) – Directory group member list
      • +
    +
    @@ -7674,6 +20939,78 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • enabled (bool or None) – Whether this directory LDAP server is enabled or not.
      • +
    • host (str) – Directory LDAP server DNS host name or ip address which is +reachable by NSX manager to be connected and do object +synchronization. format: ip-or-hostname
      • +
    • password (str) – Directory LDAP server connection password.
      • +
    • port (long or None) – Directory LDAP server connection TCP/UDP port. format: int64
      • +
    • protocol (str or None) –

      Possible values are:

      + +

      Directory LDAP server connection protocol which is either LDAP or +LDAPS.

      +
      • +
    • thumbprint (str or None) – Directory LDAP server certificate thumbprint used in secure LDAPS +connection.
      • +
    • username (str) – Directory LDAP server connection user name.
      • +
    +
    PROTOCOL_LDAP = 'LDAP'
    @@ -7696,6 +21033,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of DirectoryLdapServer) – List of Directory Domain Ldap Servers
      • +
    +
    @@ -7707,6 +21077,97 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • last_sync_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Display name of discovered node +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • certificate (str or None) – Certificate of the discovered node
      • +
    • cm_local_id (str or None) – Local Id of the discovered node in the Compute Manager +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • external_id (str or None) – External id of the discovered node, ex. a mo-ref from VC +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • hardware_id (str or None) – Hardware Id is generated using system hardware info. It is used to +retrieve fabric node of the esx. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • ip_addresses (list of str or None) – IP Addresses of the the discovered node. format: ip +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • node_type (str or None) – Discovered Node type like Host +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • origin_id (str or None) – Id of the compute manager from where this node was discovered +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • origin_properties (list of KeyValuePair or None) – Key-Value map of additional specific properties of discovered node +in the Compute Manager +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • os_type (str or None) – OS type of the discovered node +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • os_version (str or None) – OS version of the discovered node +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • parent_compute_collection (str or None) – External id of the compute collection to which this node belongs +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • stateless (bool or None) – The stateless property describes whether host persists its state +across reboot or not. If state persists, value is set as false +otherwise true. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.DiscoveredNodeInterfaceProperties(connected_switch=None, interface_id=None, physical_address=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Network interface properties of discovered node

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • connected_switch (str or None) – Switch name which is connected to nic, switch can be opaque, +proxyHostSwitch or virtual
      • +
    • interface_id (str or None) – Id of the network interface
      • +
    • physical_address (str or None) – Mac address of the interface
      • +
    +
    @@ -7719,6 +21180,63 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of DiscoveredNode) – Discovered Node list results
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.DiscoveredNodeNetworkInterfaces(discovered_node_id=None, network_interfaces=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    All the network interfaces of the discovered node

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • discovered_node_id (str) – Id of the discovered node
      • +
    • network_interfaces (list of DiscoveredNodeInterfaceProperties or None) – Network interfaces of the node
      • +
    +
    @@ -7731,6 +21249,31 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • last_sync_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    +
    @@ -7743,6 +21286,80 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -7755,6 +21372,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of DiscoverySession) – Discovery session list results
      • +
    +
    @@ -7766,6 +21416,89 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • cache_size (long or None) – One dns answer cache entry will consume ~120 bytes. Hence 1 KB +cache size can cache ~8 dns answer entries, and the default 1024 KB +cache size can hold ~8k dns answer entries. format: int32
      • +
    • conditional_forwarders (list of ConditionalForwarderZone or None) – The conditional zone forwarders. During matching a zone forwarder, +the dns forwarder will use the conditional fowarder with the +longest domain name that matches the query.
      • +
    • default_forwarder (ForwarderZone) – The default zone forwarder that catches all other domain names +except those matched by conditional forwarder zone.
      • +
    • listener_ip (str) – The ip address the dns forwarder listens on. It can be an ip +address already owned by the logical-router uplink port or +router-link, or a loopback port ip address. But it can not be a +downlink port address. User needs to ensure the address is +reachable via router or NAT from both client VMs and upstream +servers. User will need to create Firewall rules if needed to allow +such traffic on a Tier-1 or Tier-0. format: ipv4
      • +
    • log_level (str or None) –

      Possible values are:

      + +
      +
      Log level of the dns forwarder
      +
      • +
    • logical_router_id (str) – Specify the LogicalRouter where the DnsForwarder runs. The HA mode +of the hosting LogicalRouter must be Active/Standby.
      • +
    +
    LOG_LEVEL_DEBUG = 'DEBUG'
    @@ -7802,6 +21535,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of DnsForwarder) – Paginated list of dns forwarders
      • +
    +
    @@ -7813,6 +21579,83 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • communication_maps (list of CommunicationMap or None) – List of communication maps under this domain.
      • +
    • groups (list of Group or None) – This field is used while creating or updating the Domain. Please +take a look at the UpdateTenant API documentation for details.
      • +
    +
    @@ -7825,6 +21668,81 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • enforcement_point_path (str) – Path of enforcement point on which domain will be deployed
      • +
    +
    @@ -7837,6 +21755,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of DomainDeploymentMap) – Domain Deployment Map
      • +
    +
    @@ -7849,6 +21800,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of Domain) – Domain list results
      • +
    +
    @@ -7861,6 +21845,93 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • display_count (bool or None) – If true, displays the count of entities in the donut
      • +
    • label (Label or None) – Displayed at the middle of the donut, by default. It labels the +entities of donut.
      • +
    • navigation (str or None) – Hyperlink of the specified UI page that provides details.
      • +
    • sections (list of DonutSection) – Sections
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str) – Title of the widget.
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      Supported visualization types are LabelValueConfiguration, +DonutConfiguration, GridConfiguration, StatsConfiguration, +MultiWidgetConfiguration and ContainerConfiguration.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • datasources (list of Datasource or None) – The ‘datasources’ represent the sources from which data will be +fetched. Currently, only NSX-API is supported as a ‘default’ +datasource. An example of specifying ‘default’ datasource along +with the urls to fetch data from is given at ‘example_request’ +section of ‘CreateWidgetConfiguration’ API.
      • +
    • drilldown_id (str or None) – Id of drilldown widget, if any. Id should be a valid id of an +existing widget. A widget is considered as drilldown widget when it +is associated with any other widget and provides more detailed +information about any data item from the parent widget.
      • +
    • footer (Footer or None) –
      • +
    • is_drilldown (bool or None) – Set to true if this widget should be used as a drilldown.
      • +
    • shared (bool or None) – Please use the property ‘shared’ of View instead of this. The +widgets of a shared view are visible to other users.
      • +
    • weight (long or None) – Specify relavite weight in WidgetItem for placement in a view. +Please see WidgetItem for details. format: int32
      • +
    +
    @@ -7873,6 +21944,25 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • field (str) – A numerical value that represents the portion or entity of the +donut or stats chart.
      • +
    • label (Label or None) – If a section ‘template’ holds this donut or stats part, then the +label is auto-generated from the fetched field values after +applying the template.
      • +
    • render_configuration (list of RenderConfiguration or None) – Additional rendering or conditional evaluation of the field values +to be performed, if any.
      • +
    • tooltip (list of Tooltip or None) – Multi-line text to be shown on tooltip while hovering over the +portion.
      • +
    +
    @@ -7886,6 +21976,20 @@ stats chart.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • parts (list of DonutPart) – Array of portions or parts of the donut or stats chart.
      • +
    • row_list_field (str or None) – Field of the root of the api result set for forming parts.
      • +
    • template (bool or None) – If true, the section will be appled as template for forming parts. +Only one part will be formed from each element of ‘row_list_field’.
      • +
    +
    @@ -7898,6 +22002,25 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • mode (str or None) –

      Possible values are:

      + +
      +
      Trust settings
      +
      • +
    • priority (long or None) – Internal Forwarding Priority format: int32
      • +
    +
    MODE_TRUSTED = 'TRUSTED'
    @@ -7920,6 +22043,14 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:acceptance (bool) – End User License Agreement acceptance status
    @@ -7932,6 +22063,14 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:content (str or None) – End User License Agreement content
    @@ -7943,6 +22082,95 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • cluster_profile_bindings (list of ClusterProfileTypeIdEntry or None) – Edge cluster profile bindings
      • +
    • deployment_type (str or None) –

      Possible values are:

      + +

      This field is a readonly field which shows the deployment_type of +members. It returns UNKNOWN if there are no members, and returns +VIRTUAL_MACHINE| PHYSICAL_MACHINE if all edge members are +VIRTUAL_MACHINE|PHYSICAL_MACHINE. It returns HYBRID if the cluster +contains edge members of both types VIRTUAL_MACHINE and +PHYSICAL_MACHINE. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    • member_node_type (str or None) –

      Possible values are:

      + +

      Edge cluster is homogenous collection of transport nodes. Hence all +transport nodes of the cluster must be of same type. This readonly +field shows the type of transport nodes. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    • members (list of EdgeClusterMember or None) – EdgeCluster only supports homogeneous members. These member should +be backed by either EdgeNode or PublicCloudGatewayNode. +TransportNode type of these nodes should be the same. +DeploymentType (VIRTUAL_MACHINE|PHYSICAL_MACHINE) of these +EdgeNodes is recommended to be the same. EdgeCluster supports +members of different deployment types.
      • +
    +
    DEPLOYMENT_TYPE_PHYSICAL_MACHINE = 'PHYSICAL_MACHINE'
    @@ -7984,6 +22212,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of EdgeCluster) – Edge cluster list results
      • +
    +
    @@ -7995,6 +22256,81 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • description (str or None) – description of edge cluster member
      • +
    • display_name (str or None) – display name of edge cluster member
      • +
    • member_index (long or None) – System generated index for cluster member format: int32 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • transport_node_id (str) – Identifier of the transport node backed by an Edge node
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.EdgeClusterMemberAllocationPool(allocation_pool_type='EdgeClusterMemberAllocationPool')
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:allocation_pool_type (str) –

    Possible values are:

    + +
    +
    +
    +ALLOCATION_POOL_TYPE_LOADBALANCERALLOCATIONPOOL = 'LoadBalancerAllocationPool'
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.model_client.EdgeClusterMemberAllocationProfile(allocation_pool=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:allocation_pool (vmware.vapi.struct.VapiStruct or None) – Logical router allocation can be tracked for specific services and +services may have their own hard limits and allocation sizes. For +example load balancer pool should be specified if load balancer +service will be attached to logical router. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +EdgeClusterMemberAllocationPool. When methods return a +value of this class as a return value, the attribute will contain +all the attributes defined in +EdgeClusterMemberAllocationPool.
    @@ -8006,6 +22342,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of EdgeClusterMember) – edge cluster member list results
      • +
    +
    @@ -8018,6 +22387,92 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • category (str or None) – Policy framework provides four pre-defined categories for +classifying a communication map. They are "Emergency", +"Infrastructure" "Environmental" and +"Application". There is a pre-determined order in which the +policy framework manages the priority of these communication maps. +Emergency category has the highest priority followed by +Infrastructure, Environmental and then Application rules. +Administrator can choose to categorize a communication map into the +above categories or can choose to leave it empty. If empty it will +have the least precedence w.r.t the above four categories.
      • +
    • communication_entries (list of CommunicationEntry or None) – CommunicationEntries that are a part of this CommunicationMap
      • +
    • precedence (long or None) –
      • +
    +
    @@ -8030,6 +22485,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of CommunicationMap) – CommunicationMap list results
      • +
    +
    @@ -8042,6 +22530,74 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • bfd_allowed_hops (long or None) – BFD allowed hops format: int64
      • +
    • bfd_declare_dead_multiple (long or None) – Number of times a packet is missed before BFD declares the neighbor +down. format: int64
      • +
    • bfd_probe_interval (long or None) – the time interval (in millisec) between probe packets for heartbeat +purpose format: int64
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    +
    @@ -8053,6 +22609,92 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • allocation_list (list of str or None) – List of logical router ids to which this edge node is allocated. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • deployment_config (EdgeNodeDeploymentConfig or None) – When this configuration is specified, edge fabric node of +deployment_type VIRTUAL_MACHINE will be deployed and registered +with MP.
      • +
    • deployment_type (str or None) –

      Possible values are:

      + +
      +
      Supported edge deployment type.
      +

      This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) – Fabric node type, for example ‘HostNode’, ‘EdgeNode’ or +‘PublicCloudGatewayNode’
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • discovered_ip_addresses (list of str or None) – Discovered IP Addresses of the fabric node, version 4 or 6 format: +ip +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • external_id (str or None) – ID of the Node maintained on the Node and used to recognize the +Node
      • +
    • fqdn (str or None) – Fully qualified domain name of the fabric node +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • ip_addresses (list of str or None) – IP Addresses of the Node, version 4 or 6. This property is +mandatory for all nodes except for automatic deployment of edge +virtual machine node. For automatic deployment, the ip address from +management_port_subnets property will be considered. format: ip
      • +
    +
    DEPLOYMENT_TYPE_PHYSICAL_MACHINE = 'PHYSICAL_MACHINE'
    @@ -8079,6 +22721,34 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    FORM_FACTOR_LARGE = 'LARGE'
    @@ -8096,6 +22766,125 @@ names.

    +
    +
    +class com.vmware.nsx_policy.model_client.EdgeNodeElement(element_id=None, elements=None, resource_name=None, resource_type=None, fqdn=None, ip_addresses=None, os=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Edge node element extends from Element class. This class contains the +information of Edge.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters: +
    +
    +
    +RESOURCE_TYPE_EDGENODEELEMENT = 'EdgeNodeElement'
    +
    + +
    +
    +RESOURCE_TYPE_GROUPELEMENT = 'GroupElement'
    +
    + +
    +
    +RESOURCE_TYPE_HOSTNODEELEMENT = 'HostNodeElement'
    +
    + +
    +
    +RESOURCE_TYPE_LBVIRTUALSERVERELEMENT = 'LBVirtualServerElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOADBALANCERSERVICEELEMENT = 'LoadBalancerServiceElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALROUTERPORTELEMENT = 'LogicalRouterPortElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALSWITCHELEMENT = 'LogicalSwitchElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALSWITCHPORTELEMENT = 'LogicalSwitchPortElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALT0ROUTERELEMENT = 'LogicalT0RouterElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALT1ROUTERELEMENT = 'LogicalT1RouterElement'
    +
    + +
    +
    +RESOURCE_TYPE_PROCESSELEMENT = 'ProcessElement'
    +
    + +
    +
    +RESOURCE_TYPE_VIRTUALNETWORKINTERFACEELEMENT = 'VirtualNetworkInterfaceElement'
    +
    + +
    +
    +RESOURCE_TYPE_VMELEMENT = 'VMElement'
    +
    + +
    +
    class com.vmware.nsx_policy.model_client.EffectiveIPAddressMemberListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    @@ -8105,6 +22894,40 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of str) – Paged Collection of effective ip addresses for the given NSGroup +format: address-or-block-or-range
      • +
    +
    @@ -8116,6 +22939,40 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of ResourceReference) – Paged Collection of resources which are the effective members of an +NSGroup.
      • +
    +
    @@ -8128,6 +22985,27 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    RESOURCE_TYPE_EGRESSRATESHAPER = 'EgressRateShaper'
    @@ -8156,16 +23034,80 @@ Process, LogicalSwitch, LogicalT0Router, LogicalT1Router element.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    +
    +
    +RESOURCE_TYPE_EDGENODEELEMENT = 'EdgeNodeElement'
    +
    +
    RESOURCE_TYPE_GROUPELEMENT = 'GroupElement'
    +
    +
    +RESOURCE_TYPE_HOSTNODEELEMENT = 'HostNodeElement'
    +
    + +
    +
    +RESOURCE_TYPE_LBVIRTUALSERVERELEMENT = 'LBVirtualServerElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOADBALANCERSERVICEELEMENT = 'LoadBalancerServiceElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALROUTERPORTELEMENT = 'LogicalRouterPortElement'
    +
    +
    RESOURCE_TYPE_LOGICALSWITCHELEMENT = 'LogicalSwitchElement'
    +
    +
    +RESOURCE_TYPE_LOGICALSWITCHPORTELEMENT = 'LogicalSwitchPortElement'
    +
    +
    RESOURCE_TYPE_LOGICALT0ROUTERELEMENT = 'LogicalT0RouterElement'
    @@ -8181,6 +23123,11 @@ names.

    RESOURCE_TYPE_PROCESSELEMENT = 'ProcessElement'
    +
    +
    +RESOURCE_TYPE_VIRTUALNETWORKINTERFACEELEMENT = 'VirtualNetworkInterfaceElement'
    +
    +
    RESOURCE_TYPE_VMELEMENT = 'VMElement'
    @@ -8198,11 +23145,42 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • owner (OwnerResourceLink or None) – Owner of this resource
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Identifier of the resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    +
    -class com.vmware.nsx_policy.model_client.Endpoint(default_gateway=None, device_name=None, ip=None, label=None, subnet_mask=None)
    +class com.vmware.nsx_policy.model_client.Endpoint(default_gateway=None, device_name=None, ip=None, label=None, mac=None, subnet_mask=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    An Endpoint object is part of HostSwitch configuration in TransportNode

    @@ -8210,6 +23188,36 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • default_gateway (str or None) – Gateway IP format: ip +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • device_name (str or None) – Name of the virtual tunnel endpoint +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • ip (str or None) – Depending upon the EndpointIpConfig used in HostSwitch, IP could be +allocated either from DHCP (default) or from Static IP Pool. +format: ip +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • label (long or None) – Unique label for this Endpoint format: int32 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • mac (str or None) – MAC address +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • subnet_mask (str or None) – Subnet mask format: ip +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -8222,6 +23230,90 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • connection_info (vmware.vapi.struct.VapiStruct) – Enforcement point connection info +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +EnforcementPointConnectionInfo. When methods return a +value of this class as a return value, the attribute will contain +all the attributes defined in +EnforcementPointConnectionInfo.
      • +
    • version (str or None) – Version of the Enforcement point +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -8234,6 +23326,28 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    RESOURCE_TYPE_NSXTCONNECTIONINFO = 'NSXTConnectionInfo'
    @@ -8256,6 +23370,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of EnforcementPoint) – EnforcementPoint list results
      • +
    +
    @@ -8270,6 +23417,70 @@ MGWs or Providers that can created in a system.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • count (long) – Instance count. format: int64
      • +
    • operator (str) – Operations supported ‘<’ and ‘<=’.
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    +
    @@ -8282,6 +23493,20 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • error_id (long) – The error id for which metadata information is needed format: int64
      • +
    • resolver_present (bool) – Indicates whether there is a resolver associated with the error or +not
      • +
    • user_metadata (ErrorResolverUserMetadata or None) – User supplied metadata that might be required by the resolver
      • +
    +
    @@ -8294,6 +23519,14 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:results (list of ErrorResolverInfo) – ErrorResolverInfo list
    @@ -8306,6 +23539,21 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • entity_id (str) – The entity/node UUID where the error has occurred.
      • +
    • error_id (long) – The error id as reported by the entity where the error occurred. +format: int64
      • +
    • system_metadata (ErrorResolverSystemMetadata or None) – This can come from some external system like syslog collector
      • +
    • user_metadata (ErrorResolverUserMetadata or None) – User supplied metadata that might be required by the resolver
      • +
    +
    @@ -8318,6 +23566,14 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:errors (list of ErrorResolverMetadata) – List of errors with their corresponding metadata.
    @@ -8330,6 +23586,14 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:value (str or None) – The value fetched from another system
    @@ -8342,6 +23606,27 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    DATA_TYPE_NUMBER = 'NUMBER'
    @@ -8369,6 +23654,14 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:user_input_list (list of ErrorResolverUserInputData or None) – List of user supplied input data.
    @@ -8381,6 +23674,29 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    @@ -8393,6 +23709,89 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • ether_type (long) – Type of the encapsulated protocol format: int64
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -8404,6 +23803,62 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • members (list of ResourceReference) – List of the members in the exclude list
      • +
    +
    @@ -8417,6 +23872,87 @@ present for extensibility.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    RESOURCE_TYPE_CONDITION = 'Condition'
    @@ -8454,6 +23990,14 @@ logical switch and logical port.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:config_pair (KeyValuePair) – Key value pair in string for the configuration
    @@ -8466,11 +24010,78 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • extra_configs (list of ExtraConfig or None) – list of extra configs
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • required_capabilities (list of str or None) –
      • +
    +
    -class com.vmware.nsx_policy.model_client.FabricModule(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, current_version=None, deployment_specs=None, fabric_module_name=None, source_authentication_mode=None)
    +class com.vmware.nsx_policy.model_client.FabricModule(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, current_version=None, custom_data=None, deployment_specs=None, fabric_module_name=None, source_authentication_mode=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    Fabric module contains list of deployment specs and current version. Each deployment spec is a different version of same fabric module. If fabric @@ -8481,6 +24092,76 @@ version will specify which version needs to be installed.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • current_version (str) – current version on for the host prep fabric module.
      • +
    • custom_data (list of StringMapEntry or None) – Slot for storing consumer data (fabric module’s specific data +common across all the realizations of the fabric module)
      • +
    • deployment_specs (list of DeploymentSpec) – List of deployment specs
      • +
    • fabric_module_name (str) – Name of the fabric module
      • +
    • source_authentication_mode (str or None) –

      Possible values are:

      + +

      This enum specifies the authentication supported at source i.e. for +downloading VM. If this attribute is not provided, then +NO_AUTHENTICATION will be considered.

      +
      • +
    +
    SOURCE_AUTHENTICATION_MODE_BASIC_AUTHENTICATION = 'BASIC_AUTHENTICATION'
    @@ -8508,6 +24189,181 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of FabricModule or None) – Fabric Module list results +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.FeatureAccess(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, enabled=None, feature=None, information=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Feature access

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • enabled (bool or None) – Feature enabled or not +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • feature (str or None) – Feature +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • information (list of FeatureInfo or None) – Feature Info
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.FeatureAccessListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of FeatureAccess) – List results
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.FeatureInfo(info=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Feature Info

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:info (str or None) – Info +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    @@ -8520,6 +24376,31 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    PERMISSION_CRUD = 'crud'
    @@ -8551,6 +24432,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of FeaturePermission) – List results
      • +
    +
    @@ -8563,6 +24477,63 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • client_type_collection_configurations (list of ClientTypeCollectionConfiguration or None) – The set of client type data collection configurations
      • +
    • feature_stack_name (str) – The name of the feature stack
      • +
    +
    @@ -8575,6 +24546,16 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:results (list of FeatureStackCollectionConfiguration or None) – The complete set of feature stack data collection configurations +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    @@ -8587,17 +24568,63 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • capacity_usage (list of CapacityUsage or None) – Capacity Usage List +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • feature (str or None) – name of the feature +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    -class com.vmware.nsx_policy.model_client.FeatureUsageCsvRecord(cpu_usage_count=None, feature=None, vm_usage_count=None)
    +class com.vmware.nsx_policy.model_client.FeatureUsageCsvRecord(cpu_usage_count=None, feature=None, vcpu_usage_count=None, vm_usage_count=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • cpu_usage_count (long or None) – count of number of cpu sockets used by this feature format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • feature (str or None) – name of the feature +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • vcpu_usage_count (long or None) – count of number of vcpus of public cloud VMs format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • vm_usage_count (long or None) – count of number of vms used by this feature format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -8610,6 +24637,27 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • feature_usage_info (list of FeatureUsage or None) – Feature Usage List +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -8621,6 +24669,140 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • file_name (str or None) – File name set by HTTP server if API returns CSV result as a file.
      • +
    • last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has +never updated the data. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of FeatureUsageCsvRecord or None) –
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.FieldSanityConstraintExpression(checks=None, operator=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='FieldSanityConstraintExpression', tags=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Represents the field value constraint to constrain specified field value +based on defined sanity checks. Example - For DNS.upstream_servers, all the +IP addresses must either be public or private. { "target": { +"target_resource_type": "DnsForwarderZone", +"attribute": "upstreamServers", "path_prefix": +"/infra/dns-forwarder-zones/" }, "constraint_expression": { +"resource_type": "FieldSanityConstraintExpression", +"operator": "OR", "checks": +["ALL_PUBLIC_IPS", "ALL_PRIVATE_IPS"] } }

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • checks (list of str) –

      Possible values are:

      + +
      +
      List of sanity checks.
      +
      • +
    • operator (str) –

      Possible values are:

      + +
      +
      A conditional operator
      +
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    +
    +
    +
    +CHECKS_PRIVATE_IPS = 'ALL_PRIVATE_IPS'
    +
    + +
    +
    +CHECKS_PUBLIC_IPS = 'ALL_PUBLIC_IPS'
    +
    + +
    +
    +OPERATOR_AND = 'AND'
    +
    + +
    +
    +OPERATOR_OR = 'OR'
    +
    +
    @@ -8633,6 +24815,25 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    SCHEME_NAME_PASSWORD = 'PASSWORD'
    @@ -8650,6 +24851,34 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • authentication_scheme (FileTransferAuthenticationScheme) – Scheme to authenticate if required
      • +
    • protocol_name (str) –

      Possible values are:

      + +
      +
      Protocol name
      +
      • +
    • ssh_fingerprint (str) – The expected SSH fingerprint of the server. If the server’s +fingerprint does not match this fingerprint, the connection will be +terminated. Only ECDSA fingerprints hashed with SHA256 are +supported. To obtain the host’s ssh fingerprint, you should connect +via some method other than SSH to obtain this information. You can +use one of these commands to view the key’s fingerprint: 1. +ssh-keygen -l -E sha256 -f ssh_host_ecdsa_key.pub 2. awk ‘{print +$2}’ ssh_host_ecdsa_key.pub | base64 -d | sha256sum -b | sed ‘s/ +.\*$//’ | xxd -r -p | base64 | sed ‘s/.//44g’ | awk ‘{print +"SHA256:"$1}’
      • +
    +
    PROTOCOL_NAME_SFTP = 'sftp'
    @@ -8667,6 +24896,18 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • field_names (str) – Comma seperated fields to be filtered on
      • +
    • value (str) – Filter value
      • +
    +
    @@ -8678,6 +24919,47 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • results (list of FirewallRule or None) – Firewall rule list result with pagination support. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • service_type (str) –

      Possible values are:

      + +
      • +
    +
    @@ -8689,6 +24971,94 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • owner (OwnerResourceLink or None) – Owner of this resource
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Identifier of the resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • action (str) –

      Possible values are:

      + +

      Action enforced on the packets which matches the distributed +service rule. Currently DS Layer supports below actions. ALLOW - +Forward any packet when a rule with this action gets a match (Used +by Firewall). DROP - Drop any packet when a rule with this action +gets a match. Packets won’t go further(Used by Firewall). REJECT - +Terminate TCP connection by sending TCP reset for a packet when a +rule with this action gets a match (Used by Firewall). REDIRECT - +Redirect any packet to a partner appliance when a rule with this +action gets a match (Used by Service Insertion). DO_NOT_REDIRECT - +Do not redirect any packet to a partner appliance when a rule with +this action gets a match (Used by Service Insertion).

      +
      • +
    • applied_tos (list of ResourceReference or None) – List of object where rule will be enforced. The section level field +overrides this one. Null will be treated as any.
      • +
    • destinations (list of ResourceReference or None) – List of the destinations. Null will be treated as any.
      • +
    • destinations_excluded (bool or None) – Negation of the destination.
      • +
    • direction (str or None) –

      Possible values are:

      + +

      Rule direction in case of stateless distributed service rules. This +will only considered if section level parameter is set to +stateless. Default to IN_OUT if not specified.

      +
      • +
    • disabled (bool or None) – Flag to disable rule. Disabled will only be persisted but never +provisioned/realized.
      • +
    • ip_protocol (str or None) –

      Possible values are:

      + +
      +
      Type of IP packet that should be matched while enforcing the rule.
      +
      • +
    • is_default (bool or None) – Flag to indicate whether rule is default. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • logged (bool or None) – Flag to enable packet logging. Default is disabled.
      • +
    • notes (str or None) – User notes specific to the rule.
      • +
    • rule_tag (str or None) – User level field which will be printed in CLI and packet logs.
      • +
    • services (list of FirewallService or None) – List of the services. Null will be treated as any.
      • +
    • sources (list of ResourceReference or None) – List of sources. Null will be treated as any.
      • +
    • sources_excluded (bool or None) – Negation of the source.
      • +
    • section_id (str or None) – Section Id of the section to which this rule belongs to. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    ACTION_ALLOW = 'ALLOW'
    @@ -8755,17 +25125,153 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of FirewallRule or None) – Firewall rule list result with pagination support. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    -class com.vmware.nsx_policy.model_client.FirewallSection(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, applied_tos=None, is_default=None, rule_count=None, section_type=None, stateful=None)
    +class com.vmware.nsx_policy.model_client.FirewallSection(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, applied_tos=None, is_default=None, rule_count=None, section_type=None, stateful=None, autoplumbed=None, comments=None, enforced_on=None, lock_modified_by=None, lock_modified_time=None, locked=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • applied_tos (list of ResourceReference or None) – List of objects where the rules in this section will be enforced. +This will take precedence over rule level appliedTo.
      • +
    • is_default (bool or None) – It is a boolean flag which reflects whether a distributed service +section is default section or not. Each Layer 3 and Layer 2 section +will have at least and at most one default section. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • rule_count (long or None) – Number of rules in this section. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • section_type (str) –

      Possible values are:

      + +

      Type of the rules which a section can contain. Only homogeneous +sections are supported.

      +
      • +
    • stateful (bool) – Stateful or Stateless nature of distributed service section is +enforced on all rules inside the section. Layer3 sections can be +stateful or stateless. Layer2 sections can only be stateless.
      • +
    • autoplumbed (bool or None) – This flag indicates whether it is an auto-plumbed section that is +associated to a LogicalRouter. Auto-plumbed sections are system +owned and cannot be updated via the API. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • comments (str or None) – Comments for section lock/unlock. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • enforced_on (str or None) – This attribute represents enforcement point of firewall section. +For example, firewall section enforced on logical port with +attachment type bridge endpoint will have ‘BRIDGEENDPOINT’ value, +firewall section enforced on logical router will have +‘LOGICALROUTER’ value and rest have ‘VIF’ value. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • lock_modified_by (str or None) – ID of the user who last modified the lock for the section. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • lock_modified_time (long or None) – Section locked/unlocked time in epoch milliseconds. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • locked (bool or None) – Section is locked/unlocked. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    SECTION_TYPE_L3REDIRECT = 'L3REDIRECT'
    @@ -8792,17 +25298,155 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of FirewallSection or None) – List of the firewall sections. The list has to be homogenous. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    -class com.vmware.nsx_policy.model_client.FirewallSectionRuleList(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, applied_tos=None, is_default=None, rule_count=None, section_type=None, stateful=None, rules=None)
    +class com.vmware.nsx_policy.model_client.FirewallSectionRuleList(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, applied_tos=None, is_default=None, rule_count=None, section_type=None, stateful=None, autoplumbed=None, comments=None, enforced_on=None, lock_modified_by=None, lock_modified_time=None, locked=None, rules=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • applied_tos (list of ResourceReference or None) – List of objects where the rules in this section will be enforced. +This will take precedence over rule level appliedTo.
      • +
    • is_default (bool or None) – It is a boolean flag which reflects whether a distributed service +section is default section or not. Each Layer 3 and Layer 2 section +will have at least and at most one default section. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • rule_count (long or None) – Number of rules in this section. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • section_type (str) –

      Possible values are:

      + +

      Type of the rules which a section can contain. Only homogeneous +sections are supported.

      +
      • +
    • stateful (bool) – Stateful or Stateless nature of distributed service section is +enforced on all rules inside the section. Layer3 sections can be +stateful or stateless. Layer2 sections can only be stateless.
      • +
    • autoplumbed (bool or None) – This flag indicates whether it is an auto-plumbed section that is +associated to a LogicalRouter. Auto-plumbed sections are system +owned and cannot be updated via the API. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • comments (str or None) – Comments for section lock/unlock. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • enforced_on (str or None) – This attribute represents enforcement point of firewall section. +For example, firewall section enforced on logical port with +attachment type bridge endpoint will have ‘BRIDGEENDPOINT’ value, +firewall section enforced on logical router will have +‘LOGICALROUTER’ value and rest have ‘VIF’ value. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • lock_modified_by (str or None) – ID of the user who last modified the lock for the section. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • lock_modified_time (long or None) – Section locked/unlocked time in epoch milliseconds. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • locked (bool or None) – Section is locked/unlocked. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • rules (list of FirewallRule) – List of firewall rules in the section. Only homogenous rules are +supported.
      • +
    +
    SECTION_TYPE_L3REDIRECT = 'L3REDIRECT'
    @@ -8829,6 +25473,43 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    STATE_FAILED = 'failed'
    @@ -8875,6 +25556,40 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • rule_count (long or None) – Total number of rules in the section. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • section_count (long or None) – Total number of sections for the section type. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • section_type (str or None) –

      Possible values are:

      + +
      +
      Type of rules which a section can contain.
      +

      This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    +
    SECTION_TYPE_L2DFW = 'L2DFW'
    @@ -8896,17 +25611,100 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • is_valid (bool or None) – Will be set to false if the referenced NSX resource has been +deleted. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • target_display_name (str or None) – Display name of the NSX resource. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • target_id (str or None) – Identifier of the NSX resource.
      • +
    • target_type (str or None) – Type of the NSX resource.
      • +
    • service (vmware.vapi.struct.VapiStruct or None) – Distributed Service API accepts raw protocol and ports as part of +NS service element in Distributed Service Rule that describes +traffic corresponding to an NSService. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +NSServiceElement. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in NSServiceElement.
      • +
    +
    -class com.vmware.nsx_policy.model_client.FirewallStats(links=None, schema=None, self_=None, byte_count=None, packet_count=None, rule_id=None, session_count=None, total_session_count=None)
    +class com.vmware.nsx_policy.model_client.FirewallStats(links=None, schema=None, self_=None, byte_count=None, max_popularity_index=None, max_session_count=None, packet_count=None, popularity_index=None, rule_id=None, session_count=None, total_session_count=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • byte_count (long or None) – Aggregated number of bytes processed by the rule. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • max_popularity_index (long or None) – Maximum value of popularity index of all firewall rules of the +type. This is aggregated statistic which are computed with lower +frequency compared to individual generic rule statistics. It may +have a computation delay up to 15 minutes in response to this API. +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • max_session_count (long or None) – Maximum value of sessions count of all firewall rules of the type. +This is aggregated statistic which are computed with lower +frequency compared to generic rule statistics. It may have a +computation delay up to 15 minutes in response to this API. format: +int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • packet_count (long or None) – Aggregated number of packets processed by the rule. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • popularity_index (long or None) – This is calculated by sessions count divided by age of the rule. +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • rule_id (str or None) – Rule Identifier of the Firewall rule. This is a globally unique +number. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • session_count (long or None) – Aggregated number of sessions processed by the rule. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • total_session_count (long or None) – Aggregated number of sessions processed by the all firewall rules. +This is aggregated statistic which are computed with lower +frequency compared to individual generic rule statistics. It may +have a computation delay up to 15 minutes in response to this API. +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -8919,6 +25717,80 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • context (str) –

      Possible values are:

      + +
      +
      Types of firewall contexts.
      +
      • +
    • global_status (str) –

      Possible values are:

      + +

      Firewall status for a fabric entity or in global context where +firewall is supported.

      +
      • +
    • target_statuses (list of TargetResourceStatus or None) – List of firewall status on various target logical resources. This +will override the global status of corresponding firewall context +(e.g it will override the gloabal status of logical_routers).
      • +
    +
    CONTEXT_LOGICAL_ROUTERS = 'logical_routers'
    @@ -8951,6 +25823,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of FirewallStatus or None) –
      • +
    +
    @@ -8966,6 +25871,24 @@ API.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • actions (list of FooterAction or None) – Action to be performed at the footer of a widget. An action at the +footer can be simple text description or a hyperlink to a UI page. +Action allows a clickable url for navigation. An example usage of +footer action is provided under ‘example_request’ section of +‘CreateWidgetConfiguration’ API.
      • +
    • condition (str or None) – If the condition is met then the footer will be applied. Examples +of expression syntax are provided under ‘example_request’ section +of ‘CreateWidgetConfiguration’ API.
      • +
    +
    @@ -8981,6 +25904,20 @@ of footer action is provided under the ‘example_request’ section of

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • dock_to_container_footer (bool or None) – If true, the footer will appear in the underlying container that +holds the widget.
      • +
    • label (Label) – Label to be displayed against the footer action.
      • +
    • url (str or None) – Hyperlink to the UI page that provides details of action.
      • +
    +
    @@ -8992,6 +25929,164 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • source_ip (str or None) – The source ip used by the fowarder of the zone. If no source ip +specified, the ip address of listener of the dns forwarder will be +used. format: ipv4
      • +
    • upstream_servers (list of str) – Ip address of the upstream dns servers the dns forwarder accesses. +format: ipv4
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.GatewayPolicy(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, category=None, rules=None, sequence_number=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Contains ordered list of Rules for GatewayPolicy

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • category (str or None) – Policy framework provides four pre-defined categories for +classifying a security policy. They are "Emergency", +"Infrastructure" "Environmental" and +"Application". There is a pre-determined order in which the +policy framework manages the priority of these security policies. +Emergency category has the highest priority followed by +Infrastructure, Environmental and then Application rules. +Administrator can choose to categorize a security policy into the +above categories or can choose to leave it empty. If empty it will +have the least precedence w.r.t the above four categories.
      • +
    • rules (list of Rule or None) – Rules that are a part of this SecurityPolicy
      • +
    • sequence_number (long or None) –
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.GatewayPolicyListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Paged Collection of gateway policies

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of SecurityPolicy) – SecurityPolicy list results
      • +
    +
    @@ -9003,6 +26098,18 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • code (long) – dhcp option code, [0-255] format: int64
      • +
    • values (list of str) – dhcp option value
      • +
    +
    @@ -9015,11 +26122,91 @@ names.

    The arguments are used to initialize data attributes with the same names.

    -
    -
    -ENTITY_TYPE_DUMMY = 'DUMMY'
    -
    - + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • alarms (list of PolicyAlarmResource or None) – Alarm info detail
      • +
    • intent_reference (list of str or None) – Desire state paths of this object
      • +
    • realization_specific_identifier (str or None) – Realization id of this object
      • +
    • runtime_status (str or None) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is +not exhaustive.
      • +
    • state (str) –

      Possible values are:

      + +
      +
      Realization state of this object
      +
      • +
    • entity_type (str or None) – Type of realized entity +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • extended_attributes (list of AttributeVal or None) – Collection of type specific properties +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    STATE_ERROR = 'ERROR'
    @@ -9052,6 +26239,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of GenericPolicyRealizedResource or None) – List of realized resources
      • +
    +
    @@ -9063,6 +26283,71 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • aggregated_data_collection_frequency (long) – The frequency in seconds at which data, which is subject to the +aggregation function, is collected. format: int64
      • +
    • is_data_collection_enabled (bool) – Indicates whether data collection required by the aggregation +service is enabled. If false, no aggregation service data will be +collected. Changing this property will not affect the existing data +collection frequency settings.
      • +
    • modified_feature_stack_collection_configurations (FeatureStackCollectionConfigurationList or None) – The list of the locally modified feature stack data collection +frequency settings. If all feature stack data collection +configurations are set to their default values, this list will be +empty.
      • +
    +
    @@ -9075,6 +26360,35 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    VALUE_ABORTED = 'ABORTED'
    @@ -9127,6 +26441,94 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • columns (list of ColumnItem) – Array of columns of a Grid widget
      • +
    • page_size (long or None) – Number of records per page. page_size will be effective only when +the urls provided in the datasource support paging. format: int32
      • +
    • row_list_fields (list of RowListField) – Rows of grid or table are formed from the list of objects returned +by a row list field.
      • +
    • span (long or None) – Represents the horizontal span of the Grid. format: int32
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str) – Title of the widget.
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      Supported visualization types are LabelValueConfiguration, +DonutConfiguration, GridConfiguration, StatsConfiguration, +MultiWidgetConfiguration and ContainerConfiguration.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • datasources (list of Datasource or None) – The ‘datasources’ represent the sources from which data will be +fetched. Currently, only NSX-API is supported as a ‘default’ +datasource. An example of specifying ‘default’ datasource along +with the urls to fetch data from is given at ‘example_request’ +section of ‘CreateWidgetConfiguration’ API.
      • +
    • drilldown_id (str or None) – Id of drilldown widget, if any. Id should be a valid id of an +existing widget. A widget is considered as drilldown widget when it +is associated with any other widget and provides more detailed +information about any data item from the parent widget.
      • +
    • footer (Footer or None) –
      • +
    • is_drilldown (bool or None) – Set to true if this widget should be used as a drilldown.
      • +
    • shared (bool or None) – Please use the property ‘shared’ of View instead of this. The +widgets of a shared view are visible to other users.
      • +
    • weight (long or None) – Specify relavite weight in WidgetItem for placement in a view. +Please see WidgetItem for details. format: int32
      • +
    +
    @@ -9138,6 +26540,107 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • expression (list of vmware.vapi.struct.VapiStruct or None) – The expression list must follow below criteria: 1. A non-empty +expression list, must be of odd size. In a list, with indices +starting from 0, all conjunction expressions must be at odd +indices, and all non-conjunction expressions must be at even +indices. 2. There may be at most 5 non-conjunction expressions in a +list. 3. All non-conjunction expressions must be of the same type, +and must be Condition expressions or IPAddress expressions. 4. For +IPAddressExpression nodes, OR is the only conjunction operator +allowed. 5. For ConditionExpression, both OR and AND operators are +allowed, but there must not be two consecutive AND operators. 6. +All Condition expressions must have same member type. 7. Each +expression must be a valid Expression. See the definition of the +Expression type for more information. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +Expression. When methods return a value of this class as a +return value, the attribute will contain all the attributes defined +in Expression.
      • +
    • state (str or None) –

      Possible values are:

      + +
      +
      Realization state of this group
      +
      • +
    +
    STATE_FAILURE = 'FAILURE'
    @@ -9166,6 +26669,28 @@ between two groups.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • dest_element_id (str or None) – Unique element ID of destination element to which the connection is +established. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • number_of_events (long or None) – Represents the number of events/flows between the source and +destination elements. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • src_element_id (str or None) – Unique element ID of source element from which the connection is +established. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -9179,16 +26704,80 @@ information related to the group.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    +
    +
    +RESOURCE_TYPE_EDGENODEELEMENT = 'EdgeNodeElement'
    +
    +
    RESOURCE_TYPE_GROUPELEMENT = 'GroupElement'
    +
    +
    +RESOURCE_TYPE_HOSTNODEELEMENT = 'HostNodeElement'
    +
    + +
    +
    +RESOURCE_TYPE_LBVIRTUALSERVERELEMENT = 'LBVirtualServerElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOADBALANCERSERVICEELEMENT = 'LoadBalancerServiceElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALROUTERPORTELEMENT = 'LogicalRouterPortElement'
    +
    +
    RESOURCE_TYPE_LOGICALSWITCHELEMENT = 'LogicalSwitchElement'
    +
    +
    +RESOURCE_TYPE_LOGICALSWITCHPORTELEMENT = 'LogicalSwitchPortElement'
    +
    +
    RESOURCE_TYPE_LOGICALT0ROUTERELEMENT = 'LogicalT0RouterElement'
    @@ -9204,6 +26793,11 @@ names.

    RESOURCE_TYPE_PROCESSELEMENT = 'ProcessElement'
    +
    +
    +RESOURCE_TYPE_VIRTUALNETWORKINTERFACEELEMENT = 'VirtualNetworkInterfaceElement'
    +
    +
    RESOURCE_TYPE_VMELEMENT = 'VMElement'
    @@ -9221,6 +26815,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of Group) – Group list results
      • +
    +
    @@ -9232,6 +26859,24 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • enabled (bool or None) – Flag to enable this ha vip config.
      • +
    • ha_vip_subnets (list of VIPSubnet) – Array of IP address subnets which will be used as floating IP +addresses. | Note - this configuration is applicable only for +Active-Standby LogicalRouter. | For Active-Active LogicalRouter +this configuration will be rejected.
      • +
    • redundant_uplink_port_ids (list of str) – Identifiers of logical router uplink ports which are to be paired +to provide | redundancy. Floating IP will be owned by one of these +uplink ports (depending upon | which node is Active).
      • +
    +
    @@ -9244,6 +26889,64 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • host (HostNode or None) – Host attributes
      • +
    • status (NodeStatus or None) – Host status
      • +
    • transport_node (TransportNode or None) –
      • +
    +
    @@ -9256,6 +26959,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of HostAggregateInfo) – Host Aggregate Info Results
      • +
    +
    @@ -9279,6 +27015,32 @@ error will be returned.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    TRAFFIC_NAME_FAULT_TOLERANCE = 'FAULT_TOLERANCE'
    @@ -9335,6 +27097,109 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • discovered_node_id (str or None) – Id of the discovered node which was converted to create this node +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • host_credential (HostNodeLoginCredential or None) – Login credentials for the host
      • +
    • managed_by_server (str or None) – The id of the virtual center server managing the ESXi type +HostNode. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • os_type (str) –

      Possible values are:

      + +
      +
      Hypervisor type, for example ESXi or RHEL KVM.
      +
      • +
    • os_version (str or None) – The version of the hypervisor operating system.
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) – Fabric node type, for example ‘HostNode’, ‘EdgeNode’ or +‘PublicCloudGatewayNode’
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • discovered_ip_addresses (list of str or None) – Discovered IP Addresses of the fabric node, version 4 or 6 format: +ip +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • external_id (str or None) – ID of the Node maintained on the Node and used to recognize the +Node
      • +
    • fqdn (str or None) – Fully qualified domain name of the fabric node +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • ip_addresses (list of str or None) – IP Addresses of the Node, version 4 or 6. This property is +mandatory for all nodes except for automatic deployment of edge +virtual machine node. For automatic deployment, the ip address from +management_port_subnets property will be considered. format: ip
      • +
    +
    +
    +
    +OS_TYPE_CENTOSKVM = 'CENTOSKVM'
    +
    + +
    +
    +OS_TYPE_CENTOSSERVER = 'CENTOSSERVER'
    +
    +
    OS_TYPE_ESXI = 'ESXI'
    @@ -9345,16 +27210,152 @@ names.

    OS_TYPE_HYPERV = 'HYPERV'
    +
    +
    +OS_TYPE_RHELCONTAINER = 'RHELCONTAINER'
    +
    +
    OS_TYPE_RHELKVM = 'RHELKVM'
    +
    +
    +OS_TYPE_RHELSERVER = 'RHELSERVER'
    +
    +
    OS_TYPE_UBUNTUKVM = 'UBUNTUKVM'
    +
    +
    +OS_TYPE_UBUNTUSERVER = 'UBUNTUSERVER'
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.model_client.HostNodeElement(element_id=None, elements=None, resource_name=None, resource_type=None, fqdn=None, ip_addresses=None, os=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Host node element extends from Element class. This class contains the +information of Host.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters: +
    +
    +
    +RESOURCE_TYPE_EDGENODEELEMENT = 'EdgeNodeElement'
    +
    + +
    +
    +RESOURCE_TYPE_GROUPELEMENT = 'GroupElement'
    +
    + +
    +
    +RESOURCE_TYPE_HOSTNODEELEMENT = 'HostNodeElement'
    +
    + +
    +
    +RESOURCE_TYPE_LBVIRTUALSERVERELEMENT = 'LBVirtualServerElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOADBALANCERSERVICEELEMENT = 'LoadBalancerServiceElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALROUTERPORTELEMENT = 'LogicalRouterPortElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALSWITCHELEMENT = 'LogicalSwitchElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALSWITCHPORTELEMENT = 'LogicalSwitchPortElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALT0ROUTERELEMENT = 'LogicalT0RouterElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALT1ROUTERELEMENT = 'LogicalT1RouterElement'
    +
    + +
    +
    +RESOURCE_TYPE_PROCESSELEMENT = 'ProcessElement'
    +
    + +
    +
    +RESOURCE_TYPE_VIRTUALNETWORKINTERFACEELEMENT = 'VirtualNetworkInterfaceElement'
    +
    + +
    +
    +RESOURCE_TYPE_VMELEMENT = 'VMElement'
    +
    +
    @@ -9367,6 +27368,20 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • password (str or None) – The authentication password of the host node
      • +
    • thumbprint (str or None) – For ESXi hosts, the thumbprint of the ESXi management service. For +KVM hosts, the SSH key fingerprint.
      • +
    • username (str or None) – The username of the account on the host node
      • +
    +
    @@ -9383,6 +27398,73 @@ supports migration vmkernal adapters to NSX logical switches.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • network_mappings (list of VmkToLogicalSwitchMapping or None) – Based on provided mappings, VMkernal adapters will be migrated to +mentioned logical switch. Without mappings specification doesn’t +make any sense, hence minium one mapping should be specified. +Assuming some sane value of 10 maximum migrations which will be +supported by any single specification.
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    +
    @@ -9395,6 +27477,30 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • host_switch_name (str or None) – If this name is unset or empty then the default host switch name +will be used. The name must be unique among all host switches +specified in a given Transport Node; unset name, empty name and the +default host switch name are considered the same in terms of +uniqueness.
      • +
    • host_switch_profile_ids (list of HostSwitchProfileTypeIdEntry or None) – HostSwitch profiles bound to this HostSwitch. If a profile ID is +not provided for any HostSwitchProfileType that is supported by the +Transport Node, the corresponding default profile will be bound to +the HostSwitch.
      • +
    • pnics (list of Pnic or None) – Physical NICs connected to the host switch
      • +
    • static_ip_pool_id (str or None) – ID of configured Static IP Pool. If specified allocate IP for +Endpoints from Pool. Else assume IP will be assigned for Endpoints +from DHCP. This field is deprecated, use ip_assignment_spec field +instead.
      • +
    +
    @@ -9406,6 +27512,28 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    KEY_EXTRACONFIGHOSTSWITCHPROFILE = 'ExtraConfigHostSwitchProfile'
    @@ -9438,6 +27566,46 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of vmware.vapi.struct.VapiStruct or None) – HostSwitch Profile Results +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +BaseHostSwitchProfile. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in BaseHostSwitchProfile. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -9451,6 +27619,19 @@ switch specifications.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:resource_type (str) –

    Possible values are:

    + +
    RESOURCE_TYPE_PRECONFIGUREDHOSTSWITCHSPEC = 'PreconfiguredHostSwitchSpec'
    @@ -9473,95 +27654,30 @@ names.

    The arguments are used to initialize data attributes with the same names.

    -
    - -
    -
    -class com.vmware.nsx_policy.model_client.HttpPolicyLbMonitorProfile(url=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='HttpPolicyLbMonitorProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, fall_count=None, interval=None, monitor_port=None, rise_count=None, timeout=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Active healthchecks are disabled by default and can be enabled for a server -pool by binding a health monitor to the Group through the PolicyLbRule -object. This represents active health monitoring over HTTP. Active -healthchecks are initiated periodically, at a configurable interval, to -each member of the Group. Only if a healthcheck fails consecutively for a -specified number of times (fall_count) to a member will the member status -be marked DOWN. Once a member is DOWN, a specified number of consecutive -successful healthchecks (rise_count) will bring the member back to UP -state. After a healthcheck is initiated, if it does not complete within a -certain period, then also the healthcheck is considered to be unsuccessful. -Completing a healthcheck within timeout means establishing a connection -(TCP or SSL), if applicable, sending the request and receiving the -response, all within the configured timeout.

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    - -
    -
    -class com.vmware.nsx_policy.model_client.HttpPolicyLbVirtualServer(insert_client_ip_header=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='HttpPolicyLbVirtualServer', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, access_log_enabled=None, ip_address=None, lb_persistence_profile=None, ports=None, router_path=None, traffic_source=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Virtual server acts as a facade to an application, receives all client -connections over HTTP and distributes them among the backend servers.

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    - -
    -
    -class com.vmware.nsx_policy.model_client.HttpsPolicyLbMonitorProfile(url=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, fall_count=None, interval=None, monitor_port=None, rise_count=None, timeout=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Active healthchecks are disabled by default and can be enabled for a server -pool by binding a health monitor to the Group through the PolicyLbRule -object. This represents active health monitoring over HTTPS. Active -healthchecks are initiated periodically, at a configurable interval, to -each member of the Group. Only if a healthcheck fails consecutively for a -specified number of times (fall_count) to a member will the member status -be marked DOWN. Once a member is DOWN, a specified number of consecutive -successful healthchecks (rise_count) will bring the member back to UP -state. After a healthcheck is initiated, if it does not complete within a -certain period, then also the healthcheck is considered to be unsuccessful. -Completing a healthcheck within timeout means establishing a connection -(TCP or SSL), if applicable, sending the request and receiving the -response, all within the configured timeout.

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    - -
    -
    -class com.vmware.nsx_policy.model_client.HttpsPolicyLbVirtualServer(client_ssl_certificate_ids=None, client_ssl_settings=None, default_client_ssl_certificate_id=None, insert_client_ip_header=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, access_log_enabled=None, ip_address=None, lb_persistence_profile=None, ports=None, router_path=None, traffic_source=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Virtual server acts as a facade to an application, receives all client -connections over HTTPS and distributes them among the backend servers.

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    -CLIENT_SSL_SETTINGS_BASE_SECURE_111317 = 'BASE_SECURE_111317'
    -
    - -
    -
    -CLIENT_SSL_SETTINGS_HIGH_SECURE_111317 = 'HIGH_SECURE_111317'
    -
    - -
    -
    -CLIENT_SSL_SETTINGS_MODERATE_SECURE_111317 = 'MODERATE_SECURE_111317'
    -
    - + +++ + + + +
    Parameters:
      +
    • endpoints (list of Endpoint or None) – List of virtual tunnel endpoints which are configured on this +switch +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • host_switch_id (str or None) – External ID of the HostSwitch +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • host_switch_name (str or None) – The name must be unique among all host switches specified in a +given Transport Node. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • transport_zone_ids (list of str or None) – List of Ids of TransportZones this HostSwitch belongs to +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -9574,6 +27690,38 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    PROTOCOL_ICMPV4 = 'ICMPv4'
    @@ -9596,6 +27744,96 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • icmp_code (long or None) – ICMP message code format: int64
      • +
    • icmp_type (long or None) – ICMP message type format: int64
      • +
    • protocol (str) –

      Possible values are:

      + +
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    PROTOCOL_ICMPV4 = 'ICMPv4'
    @@ -9618,6 +27856,25 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:resource_type (str) –

    Possible values are:

    + +
    +
    The specific type of NSServiceElement
    +
    @@ -9630,6 +27887,88 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -9643,18 +27982,96 @@ addition of IP addresses in a group.

    The arguments are used to initialize data attributes with the same names.

    -
    - -
    -
    -class com.vmware.nsx_policy.model_client.IPAddressPortPair(ip_address=None, port=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    IP Address and Port information

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    + +++ + + + +
    Parameters:
      +
    • ip_addresses (list of str) – This array can consist of a single IP address, IP address range or +a subnet. Its type can be of either IPv4 or IPv6. Both IPv4 and +IPv6 addresses within one expression is not allowed. Supported list +of formats are, "192.168.1.1", +"192.168.1.1-192.168.1.100", "192.168.0.0/24", +"fe80::250:56ff:fe83:318c", +"fe80::250:56ff:fe83:3181-fe80::250:56ff:fe83:318c", +"fe80::250:56ff:fe83:318c/64". format: +address-or-block-or-range
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -9668,6 +28085,82 @@ be provided for collector.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • ipaddress (str) – IP address for the IPFIX collector. format: ip
      • +
    • port (long) – Port for the IPFIX collector. format: int32
      • +
    +
    @@ -9680,6 +28173,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of IPFIXCollectorProfile) – IPFIX collector Instances list results
      • +
    +
    @@ -9693,6 +28219,82 @@ be provided for collector.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • ipaddress (str) – IP address for the IPFIX collector. format: ip
      • +
    • port (long) – Port for the IPFIX collector. format: int32
      • +
    +
    @@ -9705,6 +28307,440 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • ipfix_collectors (list of IPFIXCollectorProfile) – IPFIX collector profiles
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.IPFIXDFWCollector(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, collector_ip_address=None, collector_port=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    IPFIX DFW data will be collected on collector Host IP and Port address +should be provided for collector.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • collector_ip_address (str) – IP address for the IPFIX DFW collector. format: ip
      • +
    • collector_port (long) – Port for the IPFIX DFW collector. format: int32
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.IPFIXDFWCollectorProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, ipfix_dfw_collectors=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    IPFIX data for the NSX distributed firewall will be sent to the specified +IPFIX collectors.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • ipfix_dfw_collectors (list of IPFIXDFWCollector) – It accepts Multiple Collectors.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.IPFIXDFWCollectorProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Paged Collection of IPFIX DFW Collector Profile

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of IPFIXDFWCollectorProfile) – IPFIX DFW Collection Instances list results
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.IPFIXDFWProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, active_flow_export_timeout=None, ipfix_dfw_collector_profile_path=None, observation_domain_id=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    IPFIX packets from source will be sent to IPFIX DFW collector.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • active_flow_export_timeout (long) – For long standing active flows, IPFIX records will be sent per +timeout period in seconds. format: int32
      • +
    • ipfix_dfw_collector_profile_path (str) – Policy path for IPFIX collector profiles. IPFIX data from these +logical segments will be sent to all specified IPFIX collectors.
      • +
    • observation_domain_id (long or None) – An identifier that is unique to the exporting process and used to +meter the flows. format: int32
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.IPFIXDFWProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Paged Collection of IPFIX DFW Profile

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of IPFIXDFWProfile) – IPFIX DFW Profile list results
      • +
    +
    @@ -9717,6 +28753,94 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • active_timeout (long) – The time in seconds after a flow is expired even if more packets +matching this flow are received by the cache. format: int32
      • +
    • idle_timeout (long) – The time in seconds after a Flow is expired if no more packets +matching this Flow are received by the cache. format: int32
      • +
    • ipfix_collector_profile_paths (list of str) – Policy path for IPFIX collector profiles. IPFIX data from these +logical segments will be sent to all specified IPFIX collectors.
      • +
    • max_flows (long or None) – The maximum number of flow entries in each exporter flow cache. +format: int64
      • +
    • observation_domain_id (long or None) – An identifier that is unique to the exporting process and used to +meter the Flows. format: int32
      • +
    • packet_sample_probability (float) – The probability in percentage that a packet is sampled, in range +0-100. The probability is equal for every packet.
      • +
    • source_logical_segment_paths (list of str) – Policy path for source tier-1 segment. IPFIX data from these +logical segments will be sent IPFIX collector.
      • +
    +
    @@ -9729,6 +28853,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of IPFIXSwitchCollectionInstance) – IPFIX Switch Collection Instances list results
      • +
    +
    @@ -9740,6 +28897,18 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • ip_addresses (list of str) – IPv4 Addresses format: ipv4
      • +
    • prefix_length (long) – Subnet Prefix Length format: int64
      • +
    +
    @@ -9751,6 +28920,40 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    ENCAPSULATION_TYPE_ERSPAN_THREE = 'ERSPAN_THREE'
    @@ -9777,6 +28980,65 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • logical_router_id (str or None) – Logical router id +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • prefixes (list of PrefixConfig) – Ordered list of PrefixConfig
      • +
    +
    @@ -9788,6 +29050,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of IPPrefixList) – Paginated list of IPPrefixLists
      • +
    +
    @@ -9800,6 +29095,29 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    @@ -9812,6 +29130,89 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • protocol_number (long) –
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -9826,6 +29227,64 @@ sessions consuming this profile.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • dpd_probe_interval (long or None) – DPD probe interval defines a periodic interval for DPD probes. +format: int64
      • +
    • enabled (bool or None) – If true, enable dead peer detection.
      • +
    +
    @@ -9838,6 +29297,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of IPSecVPNDPDProfile) – IPSec DPD Profile list results
      • +
    +
    @@ -9852,6 +29344,104 @@ profile.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • dh_groups (list of str or None) –

      Possible values are:

      + +

      Diffie-Hellman group to be used if PFS is enabled. Default is +GROUP14.

      +
      • +
    • digest_algorithms (list of str or None) –

      Possible values are:

      + +

      Algorithm to be used for message digest during Internet Key +Exchange(IKE) negotiation. Default is SHA2_256.

      +
      • +
    • encryption_algorithms (list of str or None) –

      Possible values are:

      + +

      Encryption algorithm is used during Internet Key Exchange(IKE) +negotiation. Default is AES_128.

      +
      • +
    • ike_version (str or None) –

      Possible values are:

      + +

      IKE protocol version to be used. IKE-Flex will initiate IKE-V2 and +responds to both IKE-V1 and IKE-V2.

      +
      • +
    • sa_life_time (long or None) – Life time for security association. Default is 86400 seconds (1 +day). format: int64
      • +
    +
    DH_GROUPS_GROUP14 = 'GROUP14'
    @@ -9867,6 +29457,16 @@ names.

    DH_GROUPS_GROUP16 = 'GROUP16'
    +
    +
    +DH_GROUPS_GROUP2 = 'GROUP2'
    +
    + +
    +
    +DH_GROUPS_GROUP5 = 'GROUP5'
    +
    +
    DIGEST_ALGORITHMS_SHA1 = 'SHA1'
    @@ -9877,6 +29477,16 @@ names.

    DIGEST_ALGORITHMS_SHA2_256 = 'SHA2_256'
    +
    +
    +DIGEST_ALGORITHMS_SHA2_384 = 'SHA2_384'
    +
    + +
    +
    +DIGEST_ALGORITHMS_SHA2_512 = 'SHA2_512'
    +
    +
    ENCRYPTION_ALGORITHMS_128 = 'AES_128'
    @@ -9929,6 +29539,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of IPSecVPNIKEProfile) – IKE Profile list results
      • +
    +
    @@ -9942,6 +29585,72 @@ terminated.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • certificate_id (str or None) – Site certificate identifier. Field is marked for future use. +Certificate based authentication is not supported.
      • +
    • ipsec_vpn_service_id (ResourceReference) – VPN Service id.
      • +
    • local_address (str) – IPV4 Address for local endpoint. format: ipv4
      • +
    • local_id (str or None) – Local identifier.
      • +
    • trust_ca_ids (list of str or None) – Certificate authority (CA) identifier list to verify peer +certificates. Field is marked for future use. Certificate based +authentication is not supported.
      • +
    • trust_crl_ids (list of str or None) – Certificate revocation list (CRL) identifier list to peer +certificates. Field is marked for future use. Certificate based +authentication is not supported.
      • +
    +
    @@ -9954,6 +29663,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of IPSecVPNLocalEndpoint) – IPSec local endpoint list results
      • +
    +
    @@ -9967,6 +29709,94 @@ establish a session with remote endpoint on peer site.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • authentication_mode (str or None) –

      Possible values are:

      + +

      For peer authentication only Pre shared key (PSK) mode will be +supported.

      +
      • +
    • connection_initiation_mode (str or None) –

      Possible values are:

      + +

      Connection initiation mode used by local endpoint to establish ike +connection with peer endpoint. INITIATOR - In this mode local +endpoint initiates tunnel setup and will also respond to incoming +tunnel setup requests from peer gateway. RESPOND_ONLY - In this +mode, local endpoint shall only respond to incoming tunnel setup +requests. It shall not initiate the tunnel setup. ON_DEMAND - In +this mode local endpoint will initiate tunnel creation once first +packet matching the policy rule is received and will also respond +to incoming initiation request.

      +
      • +
    • dpd_profile_id (str or None) – Dead peer detection (DPD) profile id. Default will be set according +to system default policy.
      • +
    • ike_profile_id (str or None) – IKE profile id to be used. Default will be set according to system +default policy.
      • +
    • ipsec_tunnel_profile_id (str or None) – Tunnel profile id to be used. By default it will point to system +default profile.
      • +
    • peer_address (str) – IPV4 address of peer endpoint on remote site.
      • +
    • peer_id (str) – Peer identifier.
      • +
    • psk (str or None) – IPSec Pre-shared key. Maximum length of this field is 128 +characters.
      • +
    +
    AUTHENTICATION_MODE_PSK = 'PSK'
    @@ -9999,6 +29829,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of IPSecVPNPeerEndpoint) – IPSec Peer endpoint list results
      • +
    +
    @@ -10006,13 +29869,58 @@ names.

    class com.vmware.nsx_policy.model_client.IPSecVPNPolicyRule(links=None, schema=None, self_=None, revision=None, owner=None, description=None, display_name=None, id=None, resource_type=None, action=None, destinations=None, enabled=None, logged=None, sources=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    For policy-based IPsec VPNs, a security policy specifies as its action the -VPN tunnel to be used for transit traffic that meets the policys match +VPN tunnel to be used for transit traffic that meets the policy’s match criteria.

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • owner (OwnerResourceLink or None) – Owner of this resource
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique policy id.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • action (str or None) –

      Possible values are:

      + +

      PROTECT - Protect rules are defined per policy based IPSec VPN +session. BYPASS - Bypass rules are defined per IPSec VPN service +and affects all policy based IPSec VPN sessions. Bypass rules are +prioritized over protect rules. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    • destinations (list of IPSecVPNPolicySubnet or None) – List of peer subnets.
      • +
    • enabled (bool or None) – A flag to enable/disable the policy rule.
      • +
    • logged (bool or None) – A flag to enable/disable the logging for the policy rule.
      • +
    • sources (list of IPSecVPNPolicySubnet or None) – List of local subnets.
      • +
    +
    ACTION_BYPASS = 'BYPASS'
    @@ -10035,6 +29943,14 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:subnet (str) – Subnet used in policy rule. format: ipv4-cidr-block
    @@ -10047,6 +29963,78 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • bypass_rules (list of IPSecVPNPolicyRule or None) – Bypass policy rules are configured using VPN service. Bypass rules +always have higher priority over protect rules and they affect all +policy based vpn sessions associated with the IPSec VPN service. +Protect rules are defined per policy based vpn session.
      • +
    • enabled (bool or None) – If true, enable VPN services for given logical router.
      • +
    • ike_log_level (str or None) –

      Possible values are:

      + +
      +
      Log level for internet key exchange (IKE).
      +
      • +
    • logical_router_id (str) – Logical router id.
      • +
    +
    IKE_LOG_LEVEL_DEBUG = 'DEBUG'
    @@ -10084,6 +30072,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of IPSecVPNService) – IPSec VPN serivce list result
      • +
    +
    @@ -10097,6 +30118,80 @@ session is defined configuration is not realized.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      A Policy Based VPN requires to define protect rules that match +local and peer subnets. IPSec security associations is negotiated +for each pair of local and peer subnet. A Route Based VPN is more +flexible, more powerful and recommended over policy based VPN. IP +Tunnel port is created and all traffic routed via tunnel port is +protected. Routes can be configured statically or can be learned +through BGP. A route based VPN is must for establishing redundant +VPN session to remote site.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • enabled (bool or None) – Enable/Disable IPSec VPN session.
      • +
    • ipsec_vpn_service_id (str or None) – Identifier of VPN Service linked with local endpoint. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • local_endpoint_id (str) – Local endpoint identifier.
      • +
    • peer_endpoint_id (str) – Peer endpoint identifier.
      • +
    +
    RESOURCE_TYPE_POLICYBASEDIPSECVPNSESSION = 'PolicyBasedIPSecVPNSession'
    @@ -10119,6 +30214,44 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of vmware.vapi.struct.VapiStruct) – IPSec VPN sessions list result +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +IPSecVPNSession. When methods return a value of this class +as a return value, the attribute will contain all the attributes +defined in IPSecVPNSession.
      • +
    +
    @@ -10133,6 +30266,131 @@ VPN sessions consuming this profile.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • df_policy (str or None) –

      Possible values are:

      + +

      Defragmentation policy helps to handle defragmentation bit present +in the inner packet. COPY copies the defragmentation bit from the +inner IP packet into the outer packet. CLEAR ignores the +defragmentation bit present in the inner packet.

      +
      • +
    • dh_groups (list of str or None) –

      Possible values are:

      + +

      Diffie-Hellman group to be used if PFS is enabled. Default is +GROUP14.

      +
      • +
    • digest_algorithms (list of str or None) –

      Possible values are:

      + +

      Algorithm to be used for message digest. Default digest algorithm +is implicitly covered by default encryption algorithm +"AES_GCM_128".

      +
      • +
    • enable_perfect_forward_secrecy (bool or None) – If true, perfect forward secrecy (PFS) is enabled.
      • +
    • encapsulation_mode (str or None) –

      Possible values are:

      + +

      Encapsulation Mode to be used for encryption of packet. Tunnel mode +protects internal routing information by encrypting IP header of +original packet. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    • encryption_algorithms (list of str or None) –

      Possible values are:

      + +

      Encryption algorithm to encrypt/decrypt the messages exchanged +between IPSec VPN initiator and responder during tunnel +negotiation. Default is AES_GCM_128.

      +
      • +
    • sa_life_time (long or None) – SA life time specifies the expiry time of security association. +Default is 3600 seconds. format: int64
      • +
    • transform_protocol (str or None) –

      Possible values are:

      + +
      +
      IPSec transform specifies IPSec security protocol.
      +

      This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    +
    DF_POLICY_CLEAR = 'CLEAR'
    @@ -10158,6 +30416,16 @@ names.

    DH_GROUPS_GROUP16 = 'GROUP16'
    +
    +
    +DH_GROUPS_GROUP2 = 'GROUP2'
    +
    + +
    +
    +DH_GROUPS_GROUP5 = 'GROUP5'
    +
    +
    DIGEST_ALGORITHMS_SHA1 = 'SHA1'
    @@ -10168,34 +30436,64 @@ names.

    DIGEST_ALGORITHMS_SHA2_256 = 'SHA2_256'
    +
    +
    +DIGEST_ALGORITHMS_SHA2_384 = 'SHA2_384'
    +
    + +
    +
    +DIGEST_ALGORITHMS_SHA2_512 = 'SHA2_512'
    +
    +
    ENCAPSULATION_MODE_MODE = 'TUNNEL_MODE'
    -
    -ENCRYPTION_ALGORITHMS_128 = 'AES_128'
    +
    +ENCRYPTION_ALGORITHMS_AES_128 = 'AES_128'
    -
    -ENCRYPTION_ALGORITHMS_256 = 'AES_256'
    +
    +ENCRYPTION_ALGORITHMS_AES_256 = 'AES_256'
    -
    -ENCRYPTION_ALGORITHMS_GCM_128 = 'AES_GCM_128'
    +
    +ENCRYPTION_ALGORITHMS_AES_GCM_128 = 'AES_GCM_128'
    -
    -ENCRYPTION_ALGORITHMS_GCM_192 = 'AES_GCM_192'
    +
    +ENCRYPTION_ALGORITHMS_AES_GCM_192 = 'AES_GCM_192'
    -
    -ENCRYPTION_ALGORITHMS_GCM_256 = 'AES_GCM_256'
    +
    +ENCRYPTION_ALGORITHMS_AES_GCM_256 = 'AES_GCM_256'
    +
    + +
    +
    +ENCRYPTION_ALGORITHMS_NO_ENCRYPTION = 'NO_ENCRYPTION'
    +
    + +
    +
    +ENCRYPTION_ALGORITHMS_NO_ENCRYPTION_AUTH_AES_GMAC_128 = 'NO_ENCRYPTION_AUTH_AES_GMAC_128'
    +
    + +
    +
    +ENCRYPTION_ALGORITHMS_NO_ENCRYPTION_AUTH_AES_GMAC_192 = 'NO_ENCRYPTION_AUTH_AES_GMAC_192'
    +
    + +
    +
    +ENCRYPTION_ALGORITHMS_NO_ENCRYPTION_AUTH_AES_GMAC_256 = 'NO_ENCRYPTION_AUTH_AES_GMAC_256'
    @@ -10215,19 +30513,76 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of IPSecVPNTunnelProfile) – IPSec Tunnel Profile list results
      • +
    +
    class com.vmware.nsx_policy.model_client.IPSecVpnIkeSessionStatus(fail_reason=None, ike_session_state=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Status for IPSec Vpn Ike session UP, DOWN, NEGOTIATING and fail reason if +

    Status for IPSec VPN Ike session UP, DOWN, NEGOTIATING and fail reason if Ike session is down.

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    IKE_SESSION_STATE_DOWN = 'DOWN'
    @@ -10249,31 +30604,74 @@ names.

    class com.vmware.nsx_policy.model_client.IPSecVpnIkeTrafficStatistics(bytes_in=None, bytes_out=None, fail_count=None, packets_in=None, packets_out=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Traffic statistics for IPSec Vpn Ike session.

    +

    Traffic statistics for IPSec VPN Ike session. Note - Not supported in this +release.

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • bytes_in (long or None) – Number of bytes in. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • bytes_out (long or None) – Number of bytes out. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • fail_count (long or None) – Fail count. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • packets_in (long or None) – Number of packets in. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • packets_out (long or None) – Number of packets out. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    class com.vmware.nsx_policy.model_client.IPSecVpnPolicyTrafficStatistics(aggregate_traffic_counters=None, rule_path=None, tunnel_statistics=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    IPSec Vpn policy traffic statistics

    +

    IPSec VPN policy traffic statistics.

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • aggregate_traffic_counters (IPSecVpnTrafficCounters or None) – Aggregate traffic statistics across all ipsec tunnels.
      • +
    • rule_path (str or None) – L3Vpn rule path. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • tunnel_statistics (list of IPSecVpnTunnelTrafficStatistics or None) – Tunnel statistics. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    class com.vmware.nsx_policy.model_client.IPSecVpnSessionStatistics(aggregate_traffic_counters=None, ike_status=None, ike_traffic_statistics=None, last_update_timestamp=None, policy_statistics=None, enforcement_point_path=None, resource_type='IPSecVpnSessionStatistics')

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    IPSec Vpn session statistics represents statistics on an NSX-T type of +

    IPSec VPN session statistics represents statistics on an NSX-T type of enforcement point. It gives aggregated statistics of all policies for all the tunnels.

    @@ -10281,30 +30679,185 @@ the tunnels.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • aggregate_traffic_counters (IPSecVpnTrafficCounters or None) – Aggregate traffic statistics across all ipsec tunnels.
      • +
    • ike_status (IPSecVpnIkeSessionStatus or None) – Status for IPSec VPN Ike session UP/DOWN and fail reason if Ike +session is down.
      • +
    • ike_traffic_statistics (IPSecVpnIkeTrafficStatistics or None) – Traffic statistics for IPSec VPN Ike session. Note - Not supported +in this release.
      • +
    • last_update_timestamp (long or None) – Timestamp when the data was last updated. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • policy_statistics (list of IPSecVpnPolicyTrafficStatistics or None) – Gives aggregate traffic statistics across all ipsec tunnels and +individual tunnel statistics. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • enforcement_point_path (str or None) – Policy Path referencing the enforcement point wehere the statistics +are fetched. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    +
    class com.vmware.nsx_policy.model_client.IPSecVpnTrafficCounters(bytes_in=None, bytes_out=None, dropped_packets_in=None, dropped_packets_out=None, packets_in=None, packets_out=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Traffic counters for IPSec Vpn session.

    +

    Traffic counters for IPSec VPN session.

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • bytes_in (long or None) – Total number of bytes recevied. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • bytes_out (long or None) – Total number of bytes sent. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • dropped_packets_in (long or None) – Total number of incoming packets dropped on inbound security +association. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • dropped_packets_out (long or None) – Total number of outgoing packets dropped on outbound security +association. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • packets_in (long or None) – Total number of packets received. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • packets_out (long or None) – Total number of packets sent. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    class com.vmware.nsx_policy.model_client.IPSecVpnTunnelTrafficStatistics(bytes_in=None, bytes_out=None, decryption_failures=None, dropped_packets_in=None, dropped_packets_out=None, encryption_failures=None, integrity_failures=None, local_subnet=None, nomatching_policy_errors=None, packets_in=None, packets_out=None, packets_received_other_error=None, packets_sent_other_error=None, remote_subnet=None, replay_errors=None, sa_mismatch_errors_in=None, sa_mismatch_errors_out=None, seq_number_overflow_error=None, tunnel_down_reason=None, tunnel_status=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    IPSec Vpn tunnel traffic statistics.

    +

    IPSec VPN tunnel traffic statistics.

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • bytes_in (long or None) – Total number of incoming bytes on inbound Security association. +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • bytes_out (long or None) – Total number of outgoing bytes on outbound Security association. +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • decryption_failures (long or None) – Total number of packets dropped due to decryption failures. format: +int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • dropped_packets_in (long or None) – Total number of incoming packets dropped on inbound security +association. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • dropped_packets_out (long or None) – Total number of outgoing packets dropped on outbound security +association. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • encryption_failures (long or None) – Total number of packets dropped because of failure in encryption. +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • integrity_failures (long or None) – Total number of packets dropped due to integrity failures. format: +int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • local_subnet (str or None) – Local subnet to which a tunnel belongs. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • nomatching_policy_errors (long or None) – Number of packets dropped because of no matching policy is +available. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • packets_in (long or None) – Total number of incoming packets on inbound Security association. +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • packets_out (long or None) – Total number of outgoing packets on outbound Security association. +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • packets_received_other_error (long or None) – Total number of incoming packets dropped on inbound Security +association. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • packets_sent_other_error (long or None) – Total number of packets dropped while sending for any reason. +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • remote_subnet (str or None) – Peer subnet to which a tunnel belongs. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • replay_errors (long or None) – Total number of packets dropped due to replay check on that +Security association. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sa_mismatch_errors_in (long or None) – Totoal number of security association mismatch errors on incoming +packets. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sa_mismatch_errors_out (long or None) – Totoal number of security association mismatch errors on outgoing +packets. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • seq_number_overflow_error (long or None) – Total number of packets dropped while sending due to overflow in +sequence number. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • tunnel_down_reason (str or None) – Gives the detailed reason about the tunnel when it is down. If +tunnel is UP tunnel down reason will be empty. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • tunnel_status (str or None) –

      Possible values are:

      + +
      +
      Specifies the status of tunnel, if it is UP/DOWN.
      +

      This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    +
    TUNNEL_STATUS_DOWN = 'DOWN'
    @@ -10330,18 +30883,62 @@ firewall rules. These can also be used as members of NSGroups.

    The arguments are used to initialize data attributes with the same names.

    -
    - -
    -
    -class com.vmware.nsx_policy.model_client.IPSetDeleteRequestParameters(force=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    IPSet delete request parameters

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • ip_addresses (list of str or None) – IP addresses format: address-or-block-or-range
      • +
    +
    @@ -10354,6 +30951,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of IPSet) – IPSet list results
      • +
    +
    @@ -10365,6 +30995,18 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • ip_addresses (list of str) – IPv4 Addresses format: ipv4
      • +
    • prefix_length (long) – Subnet Prefix Length format: int64
      • +
    +
    @@ -10376,30 +31018,23 @@ names.

    The arguments are used to initialize data attributes with the same names.

    -
    - -
    -
    -class com.vmware.nsx_policy.model_client.IcmpPolicyLbMonitorProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='IcmpPolicyLbMonitorProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, fall_count=None, interval=None, monitor_port=None, rise_count=None, timeout=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Active healthchecks are disabled by default and can be enabled for a server -pool by binding a health monitor to the Group through the PolicyLbRule -object. This represents active health monitoring over ICMP. Active -healthchecks are initiated periodically, at a configurable interval, to -each member of the Group. Only if a healthcheck fails consecutively for a -specified number of times (fall_count) to a member will the member status -be marked DOWN. Once a member is DOWN, a specified number of consecutive -successful healt hchecks (rise_count) will bring the member back to UP -state. After a healthcheck is initiated, if it does not complete within a -certain period, then also the healthcheck is considered to be unsuccessful. -Completing a healthcheck within timeout means establishing a connection -(TCP or SSL), if applicable, sending the request and receiving the -response, all within the configured timeout.

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    + +++ + + + +
    Parameters:
      +
    • dhcp_server_ip (str) – dhcp server ip in cidr format format: ipv4-cidr-block
      • +
    • dns_nameservers (list of str or None) – dns ips format: ipv4
      • +
    • domain_name (str or None) – domain name format: hostname
      • +
    • gateway_ip (str or None) – gateway ip format: ipv4
      • +
    • options (DhcpOptions or None) – Defines the default options for all ip-pools and static-bindings of +this server. These options will be ignored if options are defined +for ip-pools or static-bindings.
      • +
    +
    @@ -10412,6 +31047,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    PLACEMENT_POST = 'POST'
    @@ -10469,6 +31137,15 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:included_fields (str or None) – Comma separated list of fields that should be included in query +result
    @@ -10481,11 +31158,109 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • connectivity_strategy (str or None) –

      Possible values are:

      + +

      This field indicates the default connectivity policy for the infra +or tenant space WHITELIST - Adds a default drop rule. Administrator +can then use "allow" rules (aka whitelist) to allow traffic +between groups BLACKLIST - Adds a default allow rule. Admin can +then use "drop" rules (aka blacklist) to block traffic +between groups WHITELIST_ENABLE_LOGGING - Whitelising with logging +enabled BLACKLIST_ENABLE_LOGGING - Blacklisting with logging +enabled NONE - No default rules are added. This is the default +setting

      +
      • +
    • domains (list of Domain or None) – This field is used while creating or updating the infra space.
      • +
    +
    CONNECTIVITY_STRATEGY_BLACKLIST = 'BLACKLIST'
    +
    +
    +CONNECTIVITY_STRATEGY_BLACKLIST_ENABLE_LOGGING = 'BLACKLIST_ENABLE_LOGGING'
    +
    +
    CONNECTIVITY_STRATEGY_NONE = 'NONE'
    @@ -10496,6 +31271,11 @@ names.

    CONNECTIVITY_STRATEGY_WHITELIST = 'WHITELIST'
    +
    +
    +CONNECTIVITY_STRATEGY_WHITELIST_ENABLE_LOGGING = 'WHITELIST_ENABLE_LOGGING'
    +
    +
    @@ -10508,6 +31288,27 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    RESOURCE_TYPE_EGRESSRATESHAPER = 'EgressRateShaper'
    @@ -10535,6 +31336,27 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    RESOURCE_TYPE_EGRESSRATESHAPER = 'EgressRateShaper'
    @@ -10561,6 +31383,24 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • node_id (str or None) – Unique id of the backed-up configuration from which the appliance +will be restored +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • timestamp (long or None) – Timestamp of the backed-up configuration from which the appliance +will be restored format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -10574,20 +31414,112 @@ install time.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • compute_id (str) – Resource Pool or Compute Id.
      • +
    • context_id (str) – Context Id or VCenter Id.
      • +
    • storage_id (str) – Storage Id.
      • +
    • vm_nic_infos (list of VmNicInfo) – List of set of NIC information for VMs
      • +
    +
    -class com.vmware.nsx_policy.model_client.InstanceEndpoint(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, endpoint_type=None, service_attachment_id=None, target_ips=None)
    +class com.vmware.nsx_policy.model_client.InstanceEndpoint(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, endpoint_type=None, link_ids=None, service_attachments=None, target_ips=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    An InstanceEndpoint belongs to one ServiceInstance and is attached to one -ServiceAttachment. An InstanceEndpoint represents a redirection target for -a Rule. For Example - It can be an L3 Destination.

    +

    An InstanceEndpoint belongs to one ServiceInstance and represents a +redirection target for a Rule. For Example - It can be an L3 Destination. +Service Attachments is required for a InstanceEndpoint of type LOGICAL, and +deployed_to if its a VIRTUAL InstanceEndpoint.

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • endpoint_type (str or None) –

      Possible values are:

      + +

      LOGICAL - It must be created with a ServiceAttachment and +identifies a destination connected to the Service Port of the +ServiceAttachment, through the ServiceAttachment’s Logical Switch. +VIRTUAL - It represents a L3 destination the router can route to +but does not provide any further information about its location in +the network. Virtual InstanceEndpoints are used for redirection +targets that are not connected to Service Ports, such as the +next-hop routers on the Edge uplinks.

      +
      • +
    • link_ids (list of ResourceReference or None) – Link Ids are mandatory for VIRTUAL Instance Endpoint. Even though +VIRTUAL, the Instance Endpoint should be connected/accessible +through an NSX object. The link id is this NSX object id. Example - +For North-South Service Insertion, this is the LogicalRouter Id +through which the targetIp/L3 destination accessible.
      • +
    • service_attachments (list of ResourceReference or None) – Id(s) of the Service Attachment where this enndpoint is connected +to. Service Attachment is mandatory for LOGICAL Instance Endpoint.
      • +
    • target_ips (list of IPInfo) – Target IPs on an interface of the Service Instance.
      • +
    +
    ENDPOINT_TYPE_LOGICAL = 'LOGICAL'
    @@ -10610,6 +31542,41 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of InstanceEndpoint or None) – List of instance endpoints. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -10623,6 +31590,101 @@ deployed.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • deployment_status (str or None) –

      Possible values are:

      + +

      Service-Instance Runtime deployment status of the Service-VM. It +shows the latest status during the process of deployment, redeploy, +upgrade, and un-deployment of VM. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    • error_message (str or None) – Error message for the Service Instance Runtime if any. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • runtime_status (str or None) –

      Possible values are:

      + +
      +
      Service-Instance Runtime status of the deployed Service-VM.
      +

      This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    • service_instance_id (str or None) – Id of an instantiation of a registered service. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • service_vm_id (str or None) – Service-VM/SVM id of deployed virtual-machine. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • vm_nic_info (VmNicInfo or None) – VM NIC info
      • +
    +
    DEPLOYMENT_STATUS_DEPLOYMENT_FAILED = 'DEPLOYMENT_FAILED'
    @@ -10678,6 +31740,11 @@ names.

    RUNTIME_STATUS_NEEDS_ATTENTION = 'NEEDS_ATTENTION'
    +
    +
    +RUNTIME_STATUS_NOT_AVAILABLE = 'NOT_AVAILABLE'
    +
    +
    RUNTIME_STATUS_OUT_OF_SERVICE = 'OUT_OF_SERVICE'
    @@ -10695,6 +31762,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of InstanceRuntime) – Array of existing InstanceRuntimes in database
      • +
    +
    @@ -10707,6 +31807,28 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • actions (list of str or None) – A list of actions that are to be applied to resources +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • fields (list of str or None) – A list of fields that are displayable to users in a table +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • id (str or None) – UUID of the instruction +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • name (str or None) – Instruction name +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -10719,6 +31841,73 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • ifindex (long or None) – Interface index format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • mac (str or None) – Interface MAC address +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • name (str or None) – Interface Name +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • neighbors (list of NeighborProperties or None) – Neighbor properties +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -10731,6 +31920,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of InterfaceNeighborProperties or None) – Interface neighbor property results
      • +
    +
    @@ -10743,6 +31965,42 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • rx_bytes (long or None) – Count of bytes received on this port format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • rx_errors (long or None) – Count of receive errors occurring on this port format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • rx_packets (long or None) – Count of packets received on this port format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • tx_bytes (long or None) – Count of bytes transmitted on this port format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • tx_errors (long or None) – Count of transmit errors occurring on this port format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • tx_packets (long or None) – Count of packets transmitted on this port format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -10755,6 +32013,18 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • ip_addresses (list of str) – IP addresses assigned to interface format: ip
      • +
    • prefix_len (long) – Subnet prefix length format: int32
      • +
    +
    @@ -10768,6 +32038,26 @@ taken

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    @@ -10780,6 +32070,29 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • ip_addresses (list of str or None) – IP Addresses of the the virtual network interface, as discovered in +the source. format: ip +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • source (str or None) –

      Possible values are:

      + +
      +
      Source of the ipaddress information.
      +

      This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    +
    SOURCE_TOOLS = 'VM_TOOLS'
    @@ -10796,6 +32109,68 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • gateway_ip (str or None) – gateway ip format: ip
      • +
    • lease_time (long or None) – lease time, in seconds, [60-(2^32-1)], default 86400 format: int64
      • +
    • options (DhcpOptions or None) – If an option is defined at server level and not configred at +ip-pool/static-binding level, the option will be inherited to +ip-pool/static-binding. If both define a same-code option, the +option defined at ip-pool/static-binding level take precedence over +that defined at server level.
      • +
    +
    @@ -10809,6 +32184,21 @@ virtual tunnel endpoints

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:resource_type (str) –

    Possible values are:

    + +
    RESOURCE_TYPE_ASSIGNEDBYDHCP = 'AssignedByDhcp'
    @@ -10855,6 +32245,63 @@ IpBlockSubnet_Finance ( IpBlockSubnet_Eng1 IpBlockSubnet_Eng2 / ) /

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • cidr (str) – Represents network address and the prefix length which will be +associated with a layer-2 broadcast domain format: ipv4-cidr-block
      • +
    +
    @@ -10866,6 +32313,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of IpBlock) – IP block list results
      • +
    +
    @@ -10879,6 +32359,71 @@ will typically be associated with a layer-2 broadcast domain.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • allocation_ranges (list of IpPoolRange or None) – A collection of IPv4 IP ranges used for IP allocation. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • block_id (str) – Block id for which the subnet is created.
      • +
    • cidr (str or None) – Represents network address and the prefix length which will be +associated with a layer-2 broadcast domain format: ipv4-cidr-block +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • size (long) – Represents the size or number of ip addresses in the subnet format: +int64
      • +
    +
    @@ -10890,6 +32435,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of IpBlockSubnet) – IP block subnet list results
      • +
    +
    @@ -10901,6 +32479,71 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • arp_bindings_limit (long or None) – Indicates the number of arp snooped IP addresses to be remembered +per LogicalPort. Decreasing this value, will retain the latest +bindings from the existing list of address bindings. Increasing +this value will retain existing bindings and also learn any new +address bindings discovered on the port until the new limit is +reached. format: int32
      • +
    • arp_snooping_enabled (bool or None) – Indicates whether ARP snooping is enabled
      • +
    • dhcp_snooping_enabled (bool or None) – Indicates whether DHCP snooping is enabled
      • +
    • vm_tools_enabled (bool or None) – This option is only supported on ESX where vm-tools is installed.
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • required_capabilities (list of str or None) –
      • +
    +
    @@ -10913,6 +32556,18 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • ip (str) – IP address format: ip
      • +
    • mac (str or None) – MAC address
      • +
    +
    @@ -10929,18 +32584,64 @@ available as it has been allocated to a different client.

    The arguments are used to initialize data attributes with the same names.

    -
    - -
    -
    -class com.vmware.nsx_policy.model_client.IpPoolDeleteRequestParameters(force=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    IpPool delete request parameters

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • pool_usage (PoolUsage or None) – Pool usage statistics
      • +
    • subnets (list of IpPoolSubnet or None) – Subnets can be IPv4 or IPv6 and they should not overlap. The +maximum number will not exceed 5 subnets.
      • +
    +
    @@ -10952,6 +32653,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of IpPool) – IP pool list results
      • +
    +
    @@ -10964,6 +32698,26 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • end (str) – The end IP Address of the IP Range. format: ip
      • +
    • start (str) – The start IP Address of the IP Range. format: ip
      • +
    +
    @@ -10976,6 +32730,30 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • allocation_ranges (list of IpPoolRange) – A collection of IPv4 or IPv6 IP Pool Ranges.
      • +
    • cidr (str) – Represents network address and the prefix length which will be +associated with a layer-2 broadcast domain
      • +
    • dns_nameservers (list of str or None) – The collection of upto 3 DNS servers for the subnet. format: ip
      • +
    • dns_suffix (str or None) – The DNS suffix for the DNS server. format: hostname
      • +
    • gateway_ip (str or None) – The default gateway address on a layer-3 router. format: ip
      • +
    +
    @@ -10987,6 +32765,18 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • collector_ip_address (str) – IP address for the IPFIX collector format: ip
      • +
    • collector_port (long or None) – Port for the IPFIX collector format: int32
      • +
    +
    @@ -10999,6 +32789,62 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • collectors (list of IpfixCollector) – IPFIX Collectors
      • +
    +
    @@ -11011,6 +32857,41 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of IpfixCollectorConfig or None) – IPFIX Collector Config +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -11025,6 +32906,69 @@ config. The IPFIX exporter will send records to these collectors.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • collectors (list of IpfixCollector) – IPFIX Collector Set
      • +
    +
    RESOURCE_TYPE_IPFIXCOLLECTORUPMPROFILE = 'IpfixCollectorUpmProfile'
    @@ -11042,6 +32986,41 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of IpfixCollectorUpmProfile or None) – IPFIX Collector Profile List +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -11054,6 +33033,69 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      +
      Supported IPFIX Config Types.
      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • applied_tos (list of ResourceReference or None) – List of objects where the IPFIX Config will be enabled.
      • +
    +
    RESOURCE_TYPE_IPFIXDFWCONFIG = 'IpfixDfwConfig'
    @@ -11076,6 +33118,46 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of vmware.vapi.struct.VapiStruct or None) – IPFIX Config +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +IpfixConfig. When methods return a value of this class as +a return value, the attribute will contain all the attributes +defined in IpfixConfig. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -11088,6 +33170,80 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • active_flow_export_timeout (long or None) – For long standing active flows, IPFIX records will be sent per +timeout period format: int64
      • +
    • collector (str) – Each IPFIX DFW config can have its own collector config.
      • +
    • observation_domain_id (long) – An identifier that is unique to the exporting process and used to +meter the Flows. format: int64
      • +
    • priority (long) – This priority field is used to resolve conflicts in Logical Ports +which are covered by more than one IPFIX profiles. The IPFIX +exporter will send records to Collectors in highest priority +profile (lowest number) only. format: int64
      • +
    • template_parameters (IpfixDfwTemplateParameters or None) – An object that indicates whether each corresponding template +parameter is required or not.
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      +
      Supported IPFIX Config Types.
      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • applied_tos (list of ResourceReference or None) – List of objects where the IPFIX Config will be enabled.
      • +
    +
    @@ -11100,6 +33256,69 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • destination_address (bool or None) – The destination IP address of a monitored network flow. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • destination_transport_port (bool or None) – The destination transport port of a monitored network flow. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • firewall_event (bool or None) – Five valid values are allowed: 1. Flow Created. 2. Flow Deleted. 3. +Flow Denied. 4. Flow Alert (not used in DropKick implementation). +5. Flow Update. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • flow_direction (bool or None) – Two valid values are allowed: 1. 0x00: igress flow to VM. 2. 0x01: +egress flow from VM. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • flow_end (bool or None) – The absolute timestamp (seconds) of the last packet of this flow. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • flow_start (bool or None) – The absolute timestamp (seconds) of the first packet of this flow. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • icmp_code (bool or None) – Code of the IPv4 ICMP message. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • octet_delta_count (bool or None) – The number of octets since the previous report (if any) in incoming +packets for this flow at the observation point. The number of +octets include IP header(s) and payload. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • packet_delta_count (bool or None) – The number of incoming packets since the previous report (if any) +for this flow at the observation point. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protocol_identifier (bool or None) – The value of the protocol number in the IP packet header. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • rule_id (bool or None) – Firewall rule Id - enterprise specific Information Element that +uniquely identifies firewall rule. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • source_address (bool or None) – The source IP address of a monitored network flow. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • source_icmp_type (bool or None) – Type of the IPv4 ICMP message. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • source_transport_port (bool or None) – The source transport port of a monitored network flow. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • vif_uuid (bool or None) – VIF UUID - enterprise specific Information Element that uniquely +identifies VIF. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -11115,6 +33334,73 @@ switch, logical port and so on.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • active_timeout (long or None) – The time in seconds after a Flow is expired even if more packets +matching this Flow are received by the cache. format: int32
      • +
    • collectors (list of IpfixCollector or None) – List of IPFIX collectors
      • +
    • enabled (bool) – Enabled status of IPFIX export
      • +
    • idle_timeout (long or None) – The time in seconds after a Flow is expired if no more packets +matching this Flow are received by the cache. format: int32
      • +
    • max_flows (long or None) – The maximum number of flow entries in each exporter flow cache. +format: int64
      • +
    • observation_domain_id (long or None) – An identifier that is unique to the exporting process and used to +meter the Flows. format: int64
      • +
    • packet_sample_probability (float or None) – The probability in percentage that a packet is sampled, in range +0-100. The probability is equal for every packet.
      • +
    +
    @@ -11127,6 +33413,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of IpfixObsPointConfig or None) – IPFIX observation points
      • +
    +
    @@ -11138,6 +33457,52 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • results (list of vmware.vapi.struct.VapiStruct or None) – Ipfix config list result with pagination support. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +IpfixConfig. When methods return a value of this class as +a return value, the attribute will contain all the attributes +defined in IpfixConfig. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • service_type (str) –

      Possible values are:

      + +
      • +
    +
    @@ -11151,6 +33516,77 @@ specify its own collectors and observation ID.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • active_timeout (long or None) – The time in seconds after a Flow is expired even if more packets +matching this Flow are received by the cache. format: int32
      • +
    • idle_timeout (long or None) – The time in seconds after a Flow is expired if no more packets +matching this Flow are received by the cache. format: int32
      • +
    • max_flows (long or None) – The maximum number of flow entries in each exporter flow cache. +format: int64
      • +
    • packet_sample_probability (float or None) – The probability in percentage that a packet is sampled, in range +0-100. The probability is equal for every packet.
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      +
      Supported IPFIX Config Types.
      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • applied_tos (list of ResourceReference or None) – List of objects where the IPFIX Config will be enabled.
      • +
    +
    @@ -11164,6 +33600,89 @@ would be enabled on the switching module to collect flow information.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • active_timeout (long or None) – The time in seconds after a flow is expired even if more packets +matching this Flow are received by the cache. format: int32
      • +
    • applied_tos (AppliedTos or None) – Entities where the IPFIX profile will be enabled on. Maximum entity +count of all types is 128.
      • +
    • collector_profile (str) – Each IPFIX switching profile can have its own collector profile.
      • +
    • idle_timeout (long or None) – The time in seconds after a flow is expired if no more packets +matching this flow are received by the cache. format: int32
      • +
    • max_flows (long or None) – The maximum number of flow entries in each exporter flow cache. +format: int64
      • +
    • observation_domain_id (long) – An identifier that is unique to the exporting process and used to +meter the Flows. format: int64
      • +
    • packet_sample_probability (float or None) – The probability in percentage that a packet is sampled, in range +(0,100]. The probability is equal for every packet.
      • +
    • priority (long) – This priority field is used to resolve conflicts in logical +ports/switch which inherit multiple switch IPFIX profiles from +NSGroups. Override rule is : for multiple profiles inherited from +NSGroups, the one with highest priority (lowest number) overrides +others; the profile directly applied to logical switch overrides +profiles inherited from NSGroup; the profile directly applied to +logical port overides profiles inherited from logical switch and/or +nsgroup; The IPFIX exporter will send records to collectors of +final effective profile only. format: int32
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      +
      All IPFIX profile types.
      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    +
    @@ -11176,6 +33695,67 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      +
      All IPFIX profile types.
      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    +
    RESOURCE_TYPE_IPFIXSWITCHUPMPROFILE = 'IpfixSwitchUpmProfile'
    @@ -11193,6 +33773,46 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of vmware.vapi.struct.VapiStruct or None) – IPFIX Profile List +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +IpfixUpmProfile. When methods return a value of this class +as a return value, the attribute will contain all the attributes +defined in IpfixUpmProfile. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -11204,6 +33824,18 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • key (str) – key name
      • +
    • value (str) – key value
      • +
    +
    @@ -11216,11 +33848,23 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • key (str) – Key
      • +
    • value (str) – Value
      • +
    +
    -class com.vmware.nsx_policy.model_client.L2Extension(l2vpn_path=None, tunnel_id=None)
    +class com.vmware.nsx_policy.model_client.L2Extension(l2vpn_paths=None, tunnel_id=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    Segment specific L2 VPN configuration

    @@ -11228,6 +33872,18 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • l2vpn_paths (list of str or None) – Policy paths corresponding to the associated L2 VPN sessions.
      • +
    • tunnel_id (long or None) – Tunnel ID format: int32
      • +
    +
    @@ -11240,6 +33896,82 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • enabled (bool or None) – Enable to extend all the associated segments.
      • +
    • transport_tunnels (list of str) – List of paths referencing transport tunnels.
      • +
    +
    @@ -11251,18 +33983,117 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    class com.vmware.nsx_policy.model_client.L2VpnContext(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, enable_hub=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    L2Vpn Context provides meta-data information about the parent Provider.

    +

    L2Vpn Context provides meta-data information about the parent Tier-0.

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • enable_hub (bool or None) – If enabled, the tier-0 acts as a Hub and replicates traffic +received from peer to all other peers. If disabled, the tier-0 acts +as a Spoke and replicates only the local.
      • +
    +
    @@ -11275,6 +34106,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of L2Vpn) – L2Vpn list results
      • +
    +
    @@ -11289,6 +34153,26 @@ the tunnel.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • peer_codes (list of L2VpnTransportTunnelPeerCode) – List of peer codes per transport tunnel.
      • +
    • enforcement_point_path (str or None) – Policy Path referencing the enforcement point to which the config +belongs. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    +
    @@ -11302,6 +34186,25 @@ tunnel.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • enforcement_point_path (str or None) – Policy Path referencing the enforcement point to which the config +belongs. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    +
    RESOURCE_TYPE_L2VPNPEERCODES = 'L2VpnPeerCodes'
    @@ -11319,6 +34222,54 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • bum_bytes_in (long or None) – Total number of incoming Broadcast, Unknown unicast and Multicast +(BUM) bytes. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • bum_bytes_out (long or None) – Total number of outgoing Broadcast, Unknown unicast and Multicast +(BUM) bytes. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • bum_packets_in (long or None) – Total number of incoming Broadcast, Unknown unicast and Multicast +(BUM) packets. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • bum_packets_out (long or None) – Total number of outgoing Broadcast, Unknown unicast and Multicast +(BUM) packets. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • bytes_in (long or None) – Total number of incoming bytes. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • bytes_out (long or None) – Total number of outgoing bytes. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • packets_in (long or None) – Total number of incoming packets. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • packets_out (long or None) – Total number of outgoing packets. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • packets_receive_error (long or None) – Total number of incoming packets dropped. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • packets_sent_error (long or None) – Total number of packets dropped while sending for any reason. +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • segment_path (str or None) – Policy path referencing the segment on which stats are gathered. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -11332,6 +34283,65 @@ properties for the multiple L2VpnSessions associated with this service.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • enable_full_mesh (bool or None) – Hub replicates traffic received from peer to all other peers.
      • +
    • logical_router_id (str) – Logical router id
      • +
    • logical_tap_ip_pool (list of str or None) – IP Pool to allocate local and peer endpoint IPs for L2VpnSession +logical Tap. format: ipv4-cidr-block
      • +
    +
    @@ -11344,6 +34354,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of L2VpnService) – L2VPN serivce list result
      • +
    +
    @@ -11358,6 +34401,65 @@ L2VpnService.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • enabled (bool or None) – Enable to extend all the associated logical switches.
      • +
    • l2vpn_service_id (str) – L2VPN service id
      • +
    • transport_tunnels (list of ResourceReference) – List of transport tunnels for redundancy.
      • +
    • tunnel_encapsulation (L2VpnTunnelEncapsulation or None) – Tunnel encapsulation config.
      • +
    +
    @@ -11370,19 +34472,77 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of L2VpnSession) – L2VPN sessions list result
      • +
    +
    class com.vmware.nsx_policy.model_client.L2VpnSessionStatistics(tap_traffic_counters=None, traffic_statistics_per_segment=None, enforcement_point_path=None, resource_type='L2VpnSessionStatistics')

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Session statistics gives Vpn session status and traffic statistics per +

    Session statistics gives VPN session status and traffic statistics per segment.

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • tap_traffic_counters (list of L2VpnTapTrafficStatistics or None) – Tunnel port traffic counters. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • traffic_statistics_per_segment (list of L2VpnPerSegmentTrafficStatistics or None) – Traffic statistics per segment. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • enforcement_point_path (str or None) – Policy Path referencing the enforcement point wehere the statistics +are fetched. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    +
    @@ -11395,6 +34555,25 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • enforcement_point_path (str or None) – Policy Path referencing the enforcement point wehere the statistics +are fetched. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    +
    RESOURCE_TYPE_L2VPNSESSIONSTATISTICS = 'L2VpnSessionStatistics'
    @@ -11412,6 +34591,35 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • bytes_in (long or None) – Total number of incoming bytes. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • bytes_out (long or None) – Total number of outgoing bytes. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • packets_in (long or None) – Total number of incoming packets. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • packets_out (long or None) – Total number of outgoing packets. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • packets_receive_error (long or None) – Total number of incoming packets dropped. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • packets_sent_error (long or None) – Total number of packets dropped while sending for any reason. +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -11424,6 +34632,21 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • peer_code (str) – Copy this code to paste on the remote end of the tunnel. This is a +base64 encoded string which has all the configuration for tunnel. +E.g local/remote ips and protocol, encryption algorithm, etc. Peer +code also contains PSK; be careful when sharing or storing it.
      • +
    • transport_tunnel_path (str) – Policy Path referencing the transport tunnel.
      • +
    +
    @@ -11436,6 +34659,28 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • local_endpoint_ip (str or None) – IP Address of the tunnel port. The IP are allocated from +L2VpnService logical_tap_ip_pool. All sessions on same L2VpnService +get the same local_endpoint_ip. format: ipv4
      • +
    • peer_endpoint_ip (str or None) – IP Address of the peer tunnel port. The IP are allocated from +L2VpnService logical_tap_ip_pool. format: ipv4
      • +
    • protocol (str or None) –

      Possible values are:

      + +
      +
      Encapsulation protocol used by the tunnel
      +
      • +
    +
    PROTOCOL_GRE = 'GRE'
    @@ -11447,12 +34692,163 @@ names.

    class com.vmware.nsx_policy.model_client.L3Vpn(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, dh_groups=None, enable_perfect_forward_secrecy=None, enabled=None, ike_digest_algorithms=None, ike_encryption_algorithms=None, ike_version=None, l3vpn_session=None, local_address=None, passphrases=None, remote_private_address=None, remote_public_address=None, tunnel_digest_algorithms=None, tunnel_encryption_algorithms=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Contains information necessary to configure IPSec Vpn.

    +

    Contains information necessary to configure IPSec VPN.

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • dh_groups (list of str or None) –

      Possible values are:

      + +

      Diffie-Hellman group to be used if PFS is enabled. Default group is +GROUP14.

      +
      • +
    • enable_perfect_forward_secrecy (bool or None) – If true, perfect forward secrecy (PFS) is enabled.
      • +
    • enabled (bool or None) – Flag to enable L3Vpn. Default is enabled.
      • +
    • ike_digest_algorithms (list of str or None) –

      Possible values are:

      + +

      Algorithm to be used for message digest during Internet Key +Exchange(IKE) negotiation. Default is SHA2_256.

      +
      • +
    • ike_encryption_algorithms (list of str or None) –

      Possible values are:

      + +

      Algorithm to be used during Internet Key Exchange(IKE) negotiation. +Default is AES_128.

      +
      • +
    • ike_version (str or None) –

      Possible values are:

      + +

      IKE protocol version to be used. IKE-Flex will initiate IKE-V2 and +responds to both IKE-V1 and IKE-V2.

      +
      • +
    • l3vpn_session (vmware.vapi.struct.VapiStruct) – L3Vpn Session +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +L3VpnSession. When methods return a value of this class as +a return value, the attribute will contain all the attributes +defined in L3VpnSession.
      • +
    • local_address (str) – IPv4 address of local gateway format: ipv4
      • +
    • passphrases (list of str or None) – List of IPSec pre-shared keys used for IPSec authentication. If not +specified, the older passphrase values are retained if there are +any.
      • +
    • remote_private_address (str or None) – This field is used to resolve conflicts in case of a remote site +being behind NAT as remote public ip address is not enough. If it +is not the case the remote public address should be provided here. +If not provided, the value of this field is set to +remote_public_address.
      • +
    • remote_public_address (str) – Public IPv4 address of remote gateway format: ipv4
      • +
    • tunnel_digest_algorithms (list of str or None) –

      Possible values are:

      + +

      Algorithm to be used for message digest during tunnel +establishment. Default algorithm is empty.

      +
      • +
    • tunnel_encryption_algorithms (list of str or None) –

      Possible values are:

      + +

      Encryption algorithm to encrypt/decrypt the messages exchanged +between IPSec VPN initiator and responder during tunnel +negotiation. Default is AES_GCM_128.

      +
      • +
    +
    DH_GROUPS_GROUP14 = 'GROUP14'
    @@ -11468,6 +34864,16 @@ names.

    DH_GROUPS_GROUP16 = 'GROUP16'
    +
    +
    +DH_GROUPS_GROUP2 = 'GROUP2'
    +
    + +
    +
    +DH_GROUPS_GROUP5 = 'GROUP5'
    +
    +
    IKE_DIGEST_ALGORITHMS_SHA1 = 'SHA1'
    @@ -11566,6 +34972,100 @@ consume.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • available_local_addresses (list of PolicyIPAddressInfo or None) – Local gateway IPv4 addresses available for configuration of each +L3Vpn.
      • +
    • bypass_rules (list of L3VpnRule or None) – Bypass L3Vpn rules that will be shared across L3Vpns. Only Bypass +action is supported on these L3Vpn rules.
      • +
    • enabled (bool or None) – If true, enable L3Vpn Service for given tier-0. Enabling/disabling +this service affects all L3Vpns under the given tier-0.
      • +
    • ike_log_level (str or None) –

      Possible values are:

      + +
      +
      Log level for internet key exchange (IKE).
      +
      • +
    • label (str or None) – Policy path referencing Label. A label is used as a mechanism to +group route-based L3Vpns in order to apply edge firewall rules on +members’ VTIs.
      • +
    +
    IKE_LOG_LEVEL_DEBUG = 'DEBUG'
    @@ -11603,6 +35103,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of L3Vpn) – L3Vpn list results
      • +
    +
    @@ -11620,6 +35153,14 @@ enforcement point.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:enforcement_point_path (str or None) – enforcement point path, forward slashes must be escaped using %2F.
    @@ -11627,12 +35168,102 @@ names.

    class com.vmware.nsx_policy.model_client.L3VpnRule(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, action=None, destinations=None, sequence_number=None, sources=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    For policy-based L3Vpn sessions, a rule specifies as its action the vpn -tunnel to be used for transit traffic that meets the rules match criteria.

    +tunnel to be used for transit traffic that meets the rule’s match criteria.

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • action (str or None) –

      Possible values are:

      + +

      Action to exchange data with or without protection. PROTECT - +Allows to exchange data with ipsec protection. Protect rules are +defined per L3Vpn. BYPASS - Allows to exchange data without ipsec +protection. Bypass rules are defined per L3VpnContext and affects +all policy based L3Vpns. Bypass rules are prioritized over protect +rules.

      +
      • +
    • destinations (list of L3VpnSubnet) – List of remote subnets used in policy-based L3Vpn.
      • +
    • sequence_number (long or None) – This field is used to resolve conflicts between multiple L3VpnRules +associated with a single L3Vpn or L3VpnContext. format: int32
      • +
    • sources (list of L3VpnSubnet) – List of local subnets used in policy-based L3Vpn.
      • +
    +
    ACTION_BYPASS = 'BYPASS'
    @@ -11655,6 +35286,29 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:resource_type (str) –

    Possible values are:

    + +
      +
    • A Policy Based L3Vpn is a configuration in which protect rules to
      • +
    +

    match local and remote subnet needs to be defined. Tunnel is +established for each pair of local and remote subnet defined in +protect rules. - A Route Based L3Vpn is more flexible, more +powerful and recommended over policy based. IP Tunnel subnet is +created and all traffic routed through tunnel subnet (commonly +known as VTI) is sent over tunnel. Routes can be learned through +BGP. A route based L3Vpn is required when using redundant L3Vpn.

    +
    RESOURCE_TYPE_POLICYBASEDL3VPNSESSION = 'PolicyBasedL3VpnSession'
    @@ -11677,6 +35331,25 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • enforcement_point_path (str or None) – Policy Path referencing the enforcement point wehere the statistics +are fetched. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    +
    RESOURCE_TYPE_IPSECVPNSESSIONSTATISTICS = 'IPSecVpnSessionStatistics'
    @@ -11694,26 +35367,14 @@ names.

    The arguments are used to initialize data attributes with the same names.

    -
    - -
    -
    -class com.vmware.nsx_policy.model_client.L4PolicyLbPersistenceProfile(persistence=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='L4PolicyLbPersistenceProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Some applications maintain state and require all relevant connections to be -sent to the same server as the application state is not synchronized among -servers. Persistence is enabled on a PolicyLbVirtualServer by binding a -persistence profile to it.

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    -PERSISTENCE_IP = 'SOURCE_IP'
    -
    - + +++ + + + +
    Parameters:subnet (str) – Subnet used in L3Vpn Rule. format: ipv4-cidr-block
    @@ -11728,6 +35389,36 @@ Example of a PortSet: "22, 33-70, 44".

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    L4PROTOCOL_TCP = 'TCP'
    @@ -11752,6 +35443,96 @@ Example of a PortSet: "22, 33-70, 44".

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • destination_ports (list of str or None) –
      • +
    • l4_protocol (str) –

      Possible values are:

      + +
      • +
    • source_ports (list of str or None) –
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    L4PROTOCOL_TCP = 'TCP'
    @@ -11764,26 +35545,6 @@ names.

    -
    -
    -class com.vmware.nsx_policy.model_client.L7PolicyLbPersistenceProfile(persistence=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='L7PolicyLbPersistenceProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Some applications maintain state and require all relevant connections to be -sent to the same server as the application state is not synchronized among -servers. Persistence is enabled on a PolicyLbVirtualServer by binding a -persistence profile to it.

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    - -
    - -
    -
    class com.vmware.nsx_policy.model_client.L7ServiceEntry(destination_ports=None, entity=None, l7_protocol=None, operations=None, source_ports=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='L7ServiceEntry', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)
    @@ -11794,6 +35555,4064 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • destination_ports (list of str or None) –
      • +
    • entity (str or None) – Example - If REST/HTTP then the entity coulb be a resource URI.
      • +
    • l7_protocol (str) –
      • +
    • operations (list of str or None) – If the L7 protocol is REST/HTTP then possible operations are PUT, +GET, DELETE, etc.
      • +
    • source_ports (list of str or None) –
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBActiveMonitor(fall_count=None, interval=None, monitor_port=None, rise_count=None, timeout=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LBActiveMonitor', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    All the active types of LBMonitorProfile extend from this abstract class. +This is present for extensibility.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • fall_count (long or None) – Only if a healthcheck fails consecutively for a specified number of +times, given with fall_count, to a member will the member status be +marked DOWN. format: int64
      • +
    • interval (long or None) – Active healthchecks are initiated periodically, at a configurable +interval (in seconds), to each member of the Group. format: int64
      • +
    • monitor_port (long or None) – Typically, monitors perform healthchecks to Group members using the +member IP address and pool_port. However, in some cases, customers +prefer to run healthchecks against a different port than the pool +member port which handles actual application traffic. In such +cases, the port to run healthchecks against can be specified in the +monitor_port value. format: int32
      • +
    • rise_count (long or None) – Once a member is DOWN, a specified number of consecutive successful +healthchecks specified by rise_count will bring the member back to +UP state. format: int64
      • +
    • timeout (long or None) – Timeout specified in seconds. After a healthcheck is initiated, if +it does not complete within a certain period, then also the +healthcheck is considered to be unsuccessful. Completing a +healthcheck within timeout means establishing a connection (TCP or +SSL), if applicable, sending the request and receiving the +response, all within the configured timeout. format: int64
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      Load balancers monitor the health of backend servers to ensure +traffic is not black holed. In case of active healthchecks, load +balancer itself initiates new connections (or sends ICMP ping) to +the servers periodically to check their health, completely +independent of any data traffic. Currently, active health monitors +are supported for HTTP, HTTPS, TCP, UDP and ICMP protocols.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBAppProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LBAppProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      An application profile can be bound to a virtual server to specify +the application protocol characteristics. It is used to influence +how load balancing is performed. Currently, three types of +application profiles are supported: LBFastTCPProfile, +LBFastUDPProfile and LBHttpProfile. LBFastTCPProfile or +LBFastUDPProfile is typically used when the application is using a +custom protocol or a standard protocol not supported by the load +balancer. It is also used in cases where the user only wants L4 +load balancing mainly because L4 load balancing has much higher +performance and scalability, and/or supports connection mirroring. +LBHttpProfile is used for both HTTP and HTTPS applications. Though +application rules, if bound to the virtual server, can be used to +accomplish the same goal, LBHttpProfile is intended to simplify +enabling certain common use cases.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    +
    +
    +RESOURCE_TYPE_LBFASTTCPPROFILE = 'LBFastTcpProfile'
    +
    + +
    +
    +RESOURCE_TYPE_LBFASTUDPPROFILE = 'LBFastUdpProfile'
    +
    + +
    +
    +RESOURCE_TYPE_LBHTTPPROFILE = 'LBHttpProfile'
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBAppProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Paged Collection of LBAppProfile

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of vmware.vapi.struct.VapiStruct) – LBAppProfile list results +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +LBAppProfile. When methods return a value of this class as +a return value, the attribute will contain all the attributes +defined in LBAppProfile.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBClientSslProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, cipher_group_label=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • cipher_group_label (str or None) –

      Possible values are:

      + +
      +
      It is a label of cipher group which is mostly consumed by GUI.
      +
      • +
    +
    +
    +
    +CIPHER_GROUP_LABEL_BALANCED = 'BALANCED'
    +
    + +
    +
    +CIPHER_GROUP_LABEL_CUSTOM = 'CUSTOM'
    +
    + +
    +
    +CIPHER_GROUP_LABEL_HIGH_COMPATIBILITY = 'HIGH_COMPATIBILITY'
    +
    + +
    +
    +CIPHER_GROUP_LABEL_HIGH_SECURITY = 'HIGH_SECURITY'
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBClientSslProfileBinding(default_certificate_path=None, sni_certificate_paths=None, ssl_profile_path=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • default_certificate_path (str) – A default certificate should be specified which will be used if the +server does not host multiple hostnames on the same IP address or +if the client does not support SNI extension.
      • +
    • sni_certificate_paths (list of str or None) – Client-side SSL profile binding allows multiple certificates, for +different hostnames, to be bound to the same virtual server.
      • +
    • ssl_profile_path (str or None) – Client SSL profile defines reusable, application-independent client +side SSL properties.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBClientSslProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of LBClientSslProfile) – paginated list of load balancer client SSL profiles
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBCookiePersistenceProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LBCookiePersistenceProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, persistence_shared=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Some applications maintain state and require all relevant connections to be +sent to the same server as the application state is not synchronized among +servers. Persistence is enabled on a LBVirtualServer by binding a +persistence profile to it.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • persistence_shared (bool or None) – Persistence shared setting indicates that all LBVirtualServers that +consume this LBPersistenceProfile should share the same persistence +mechanism when enabled. Meaning, persistence entries of a client +accessing one virtual server will also affect the same client’s +connections to a different virtual server. For example, say there +are two virtual servers vip-ip1:80 and vip-ip1:8080 bound to the +same Group g1 consisting of two servers (s11:80 and s12:80). By +default, each virtual server will have its own persistence table or +cookie. So, in the earlier example, there will be two tables +(vip-ip1:80, p1) and (vip-ip1:8080, p1) or cookies. So, if a client +connects to vip1:80 and later connects to vip1:8080, the second +connection may be sent to a different server than the first. When +persistence_shared is enabled, then the second connection will +always connect to the same server as the original connection. For +COOKIE persistence type, the same cookie will be shared by multiple +virtual servers. For SOURCE_IP persistenct type, the persistence +table will be shared across virtual servers.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBFastTcpProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LBFastTcpProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      An application profile can be bound to a virtual server to specify +the application protocol characteristics. It is used to influence +how load balancing is performed. Currently, three types of +application profiles are supported: LBFastTCPProfile, +LBFastUDPProfile and LBHttpProfile. LBFastTCPProfile or +LBFastUDPProfile is typically used when the application is using a +custom protocol or a standard protocol not supported by the load +balancer. It is also used in cases where the user only wants L4 +load balancing mainly because L4 load balancing has much higher +performance and scalability, and/or supports connection mirroring. +LBHttpProfile is used for both HTTP and HTTPS applications. Though +application rules, if bound to the virtual server, can be used to +accomplish the same goal, LBHttpProfile is intended to simplify +enabling certain common use cases.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBFastUdpProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LBFastUdpProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      An application profile can be bound to a virtual server to specify +the application protocol characteristics. It is used to influence +how load balancing is performed. Currently, three types of +application profiles are supported: LBFastTCPProfile, +LBFastUDPProfile and LBHttpProfile. LBFastTCPProfile or +LBFastUDPProfile is typically used when the application is using a +custom protocol or a standard protocol not supported by the load +balancer. It is also used in cases where the user only wants L4 +load balancing mainly because L4 load balancing has much higher +performance and scalability, and/or supports connection mirroring. +LBHttpProfile is used for both HTTP and HTTPS applications. Though +application rules, if bound to the virtual server, can be used to +accomplish the same goal, LBHttpProfile is intended to simplify +enabling certain common use cases.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBHttpMonitorProfile(request_url=None, fall_count=None, interval=None, monitor_port=None, rise_count=None, timeout=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Active healthchecks are disabled by default and can be enabled for a server +pool by binding a health monitor to the Group through the LBRule object. +This represents active health monitoring over HTTP. Active healthchecks are +initiated periodically, at a configurable interval, to each member of the +Group. Only if a healthcheck fails consecutively for a specified number of +times (fall_count) to a member will the member status be marked DOWN. Once +a member is DOWN, a specified number of consecutive successful healthchecks +(rise_count) will bring the member back to UP state. After a healthcheck is +initiated, if it does not complete within a certain period, then also the +healthcheck is considered to be unsuccessful. Completing a healthcheck +within timeout means establishing a connection (TCP or SSL), if applicable, +sending the request and receiving the response, all within the configured +timeout.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • request_url (str or None) – For HTTP active healthchecks, the HTTP request url sent can be +customized and can include query parameters.
      • +
    • fall_count (long or None) – Only if a healthcheck fails consecutively for a specified number of +times, given with fall_count, to a member will the member status be +marked DOWN. format: int64
      • +
    • interval (long or None) – Active healthchecks are initiated periodically, at a configurable +interval (in seconds), to each member of the Group. format: int64
      • +
    • monitor_port (long or None) – Typically, monitors perform healthchecks to Group members using the +member IP address and pool_port. However, in some cases, customers +prefer to run healthchecks against a different port than the pool +member port which handles actual application traffic. In such +cases, the port to run healthchecks against can be specified in the +monitor_port value. format: int32
      • +
    • rise_count (long or None) – Once a member is DOWN, a specified number of consecutive successful +healthchecks specified by rise_count will bring the member back to +UP state. format: int64
      • +
    • timeout (long or None) – Timeout specified in seconds. After a healthcheck is initiated, if +it does not complete within a certain period, then also the +healthcheck is considered to be unsuccessful. Completing a +healthcheck within timeout means establishing a connection (TCP or +SSL), if applicable, sending the request and receiving the +response, all within the configured timeout. format: int64
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      Load balancers monitor the health of backend servers to ensure +traffic is not black holed. In case of active healthchecks, load +balancer itself initiates new connections (or sends ICMP ping) to +the servers periodically to check their health, completely +independent of any data traffic. Currently, active health monitors +are supported for HTTP, HTTPS, TCP, UDP and ICMP protocols.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBHttpProfile(x_forwarded_for=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LBHttpProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • x_forwarded_for (str or None) –

      Possible values are:

      + +
      +
      insert or replace x_forwarded_for
      +
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      An application profile can be bound to a virtual server to specify +the application protocol characteristics. It is used to influence +how load balancing is performed. Currently, three types of +application profiles are supported: LBFastTCPProfile, +LBFastUDPProfile and LBHttpProfile. LBFastTCPProfile or +LBFastUDPProfile is typically used when the application is using a +custom protocol or a standard protocol not supported by the load +balancer. It is also used in cases where the user only wants L4 +load balancing mainly because L4 load balancing has much higher +performance and scalability, and/or supports connection mirroring. +LBHttpProfile is used for both HTTP and HTTPS applications. Though +application rules, if bound to the virtual server, can be used to +accomplish the same goal, LBHttpProfile is intended to simplify +enabling certain common use cases.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    +
    +
    +XFORWARDED_FOR_INSERT = 'INSERT'
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBHttpRequestHeaderCondition(header_value=None, type='LBHttpRequestHeaderCondition')
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    This condition is used to match HTTP request messages by the specific HTTP +header field, Host. The Host request header specifies the domain name of +the server. The supplied Host HTTP header match condition will be matched +as a regular expression. The regular expressions in load balancer rules use +the features common to both Java regular expressions and Perl Compatible +Regular Expressions (PCREs) with some restrictions. Reference +http://www.pcre .org for PCRE and the NSX-T Administrator’s Guide for the +restrictions. Please note, when regular expressions are used in JSON +(JavaScript Object Notation) string, every backslash character (\) +needs to be escaped by one additional backslash character.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters: +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBHttpRequestUriCondition(uri=None, type='LBHttpRequestUriCondition')
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    This condition is used to match URIs(Uniform Resource Identifier) of HTTP +request messages. The URI field can be specified as a regluar expression. +If an HTTP request message is requesting an URI which matches specified +regular expression, it matches the condition. The syntax of whole URI looks +like this: +scheme:[//[user[:password]\@]host[:port]][/path][?query][#fragment] This +condition matches only the path part of entire URI. The path_match field is +used as a regular expression to match URI path of HTTP requests. For +example, to match any URI that has "/image/" or "/images/", +uri field can be specified as: "/image[s]?/". The regular +expressions in load balancer rules use the features common to both Java +regular expressions and Perl Compatible Regular Expressions (PCREs) with +some restrictions. Reference http://www.pcre .org for PCRE and the NSX-T +Administrator’s Guide for the restrictions. Please note, when regular +expressions are used in JSON (JavaScript Object Notation) string, every +backslash character (\) needs to be escaped by one additional +backslash character.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters: +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBHttpsMonitorProfile(request_url=None, fall_count=None, interval=None, monitor_port=None, rise_count=None, timeout=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Active healthchecks are disabled by default and can be enabled for a server +pool by binding a health monitor to the Group through the LBRule object. +This represents active health monitoring over HTTPS. Active healthchecks +are initiated periodically, at a configurable interval, to each member of +the Group. Only if a healthcheck fails consecutively for a specified number +of times (fall_count) to a member will the member status be marked DOWN. +Once a member is DOWN, a specified number of consecutive successful +healthchecks (rise_count) will bring the member back to UP state. After a +healthcheck is initiated, if it does not complete within a certain period, +then also the healthcheck is considered to be unsuccessful. Completing a +healthcheck within timeout means establishing a connection (TCP or SSL), if +applicable, sending the request and receiving the response, all within the +configured timeout.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • request_url (str or None) – For HTTPS active healthchecks, the HTTPS request url sent can be +customized and can include query parameters.
      • +
    • fall_count (long or None) – Only if a healthcheck fails consecutively for a specified number of +times, given with fall_count, to a member will the member status be +marked DOWN. format: int64
      • +
    • interval (long or None) – Active healthchecks are initiated periodically, at a configurable +interval (in seconds), to each member of the Group. format: int64
      • +
    • monitor_port (long or None) – Typically, monitors perform healthchecks to Group members using the +member IP address and pool_port. However, in some cases, customers +prefer to run healthchecks against a different port than the pool +member port which handles actual application traffic. In such +cases, the port to run healthchecks against can be specified in the +monitor_port value. format: int32
      • +
    • rise_count (long or None) – Once a member is DOWN, a specified number of consecutive successful +healthchecks specified by rise_count will bring the member back to +UP state. format: int64
      • +
    • timeout (long or None) – Timeout specified in seconds. After a healthcheck is initiated, if +it does not complete within a certain period, then also the +healthcheck is considered to be unsuccessful. Completing a +healthcheck within timeout means establishing a connection (TCP or +SSL), if applicable, sending the request and receiving the +response, all within the configured timeout. format: int64
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      Load balancers monitor the health of backend servers to ensure +traffic is not black holed. In case of active healthchecks, load +balancer itself initiates new connections (or sends ICMP ping) to +the servers periodically to check their health, completely +independent of any data traffic. Currently, active health monitors +are supported for HTTP, HTTPS, TCP, UDP and ICMP protocols.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBIcmpMonitorProfile(fall_count=None, interval=None, monitor_port=None, rise_count=None, timeout=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Active healthchecks are disabled by default and can be enabled for a server +pool by binding a health monitor to the Group through the LBRule object. +This represents active health monitoring over ICMP. Active healthchecks are +initiated periodically, at a configurable interval, to each member of the +Group. Only if a healthcheck fails consecutively for a specified number of +times (fall_count) to a member will the member status be marked DOWN. Once +a member is DOWN, a specified number of consecutive successful healt +hchecks (rise_count) will bring the member back to UP state. After a +healthcheck is initiated, if it does not complete within a certain period, +then also the healthcheck is considered to be unsuccessful. Completing a +healthcheck within timeout means establishing a connection (TCP or SSL), if +applicable, sending the request and receiving the response, all within the +configured timeout.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • fall_count (long or None) – Only if a healthcheck fails consecutively for a specified number of +times, given with fall_count, to a member will the member status be +marked DOWN. format: int64
      • +
    • interval (long or None) – Active healthchecks are initiated periodically, at a configurable +interval (in seconds), to each member of the Group. format: int64
      • +
    • monitor_port (long or None) – Typically, monitors perform healthchecks to Group members using the +member IP address and pool_port. However, in some cases, customers +prefer to run healthchecks against a different port than the pool +member port which handles actual application traffic. In such +cases, the port to run healthchecks against can be specified in the +monitor_port value. format: int32
      • +
    • rise_count (long or None) – Once a member is DOWN, a specified number of consecutive successful +healthchecks specified by rise_count will bring the member back to +UP state. format: int64
      • +
    • timeout (long or None) – Timeout specified in seconds. After a healthcheck is initiated, if +it does not complete within a certain period, then also the +healthcheck is considered to be unsuccessful. Completing a +healthcheck within timeout means establishing a connection (TCP or +SSL), if applicable, sending the request and receiving the +response, all within the configured timeout. format: int64
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      Load balancers monitor the health of backend servers to ensure +traffic is not black holed. In case of active healthchecks, load +balancer itself initiates new connections (or sends ICMP ping) to +the servers periodically to check their health, completely +independent of any data traffic. Currently, active health monitors +are supported for HTTP, HTTPS, TCP, UDP and ICMP protocols.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBMonitorProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LBMonitorProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      Load balancers monitor the health of backend servers to ensure +traffic is not black holed. In case of active healthchecks, load +balancer itself initiates new connections (or sends ICMP ping) to +the servers periodically to check their health, completely +independent of any data traffic. Currently, active health monitors +are supported for HTTP, HTTPS, TCP, UDP and ICMP protocols.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    +
    +
    +RESOURCE_TYPE_LBHTTPMONITORPROFILE = 'LBHttpMonitorProfile'
    +
    + +
    +
    +RESOURCE_TYPE_LBHTTPSMONITORPROFILE = 'LBHttpsMonitorProfile'
    +
    + +
    +
    +RESOURCE_TYPE_LBICMPMONITORPROFILE = 'LBIcmpMonitorProfile'
    +
    + +
    +
    +RESOURCE_TYPE_LBTCPMONITORPROFILE = 'LBTcpMonitorProfile'
    +
    + +
    +
    +RESOURCE_TYPE_LBUDPMONITORPROFILE = 'LBUdpMonitorProfile'
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBMonitorProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Paged Collection of LBMonitorProfiles

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of vmware.vapi.struct.VapiStruct) – LBMonitorProfile list results +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +LBMonitorProfile. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in LBMonitorProfile.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBPersistenceProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LBPersistenceProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, persistence_shared=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Some applications maintain state and require all relevant connections to be +sent to the same server as the application state is not synchronized among +servers. Persistence is enabled on a LBVirtualServer by binding a +persistence profile to it.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • persistence_shared (bool or None) – Persistence shared setting indicates that all LBVirtualServers that +consume this LBPersistenceProfile should share the same persistence +mechanism when enabled. Meaning, persistence entries of a client +accessing one virtual server will also affect the same client’s +connections to a different virtual server. For example, say there +are two virtual servers vip-ip1:80 and vip-ip1:8080 bound to the +same Group g1 consisting of two servers (s11:80 and s12:80). By +default, each virtual server will have its own persistence table or +cookie. So, in the earlier example, there will be two tables +(vip-ip1:80, p1) and (vip-ip1:8080, p1) or cookies. So, if a client +connects to vip1:80 and later connects to vip1:8080, the second +connection may be sent to a different server than the first. When +persistence_shared is enabled, then the second connection will +always connect to the same server as the original connection. For +COOKIE persistence type, the same cookie will be shared by multiple +virtual servers. For SOURCE_IP persistenct type, the persistence +table will be shared across virtual servers.
      • +
    +
    +
    +
    +RESOURCE_TYPE_LBCOOKIEPERSISTENCEPROFILE = 'LBCookiePersistenceProfile'
    +
    + +
    +
    +RESOURCE_TYPE_LBSOURCEIPPERSISTENCEPROFILE = 'LBSourceIpPersistenceProfile'
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBPersistenceProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Paged Collection of LBPersistenceProfiles

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of vmware.vapi.struct.VapiStruct) – LBPersistenceProfile list results +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +LBPersistenceProfile. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in LBPersistenceProfile.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBPool(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, active_monitor_paths=None, algorithm=None, member_group=None, members=None, snat_translation=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Defining access of a Group from a LBVirtualServer and binding to +LBMonitorProfile.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • active_monitor_paths (list of str or None) – In case of active healthchecks, load balancer itself initiates new +connections (or sends ICMP ping) to the servers periodically to +check their health, completely independent of any data traffic. +Active healthchecks are disabled by default and can be enabled for +a server pool by binding a health monitor to the pool. Currently, +only one active health monitor can be configured per server pool.
      • +
    • algorithm (str or None) –

      Possible values are:

      + +

      Load balanding algorithm controls how the incoming connections are +distributed among the members. - ROUND_ROBIN - requests to the +application servers are distributed in a round-robin fashion, - +LEAST_CONNECTION - next request is assigned to the server with the +least number of active connections

      +
      • +
    • member_group (LBPoolMemberGroup or None) – Load balancer pool support grouping object as dynamic pool members. +When member group is defined, members setting should not be +specified.
      • +
    • members (list of LBPoolMember or None) – Server pool consists of one or more pool members. Each pool member +is identified, typically, by an IP address and a port.
      • +
    • snat_translation (vmware.vapi.struct.VapiStruct or None) – Depending on the topology, Source NAT (SNAT) may be required to +ensure traffic from the server destined to the client is received +by the load balancer. SNAT can be enabled per pool. If SNAT is not +enabled for a pool, then load balancer uses the client IP and port +(spoofing) while establishing connections to the servers. This is +referred to as no-SNAT or TRANSPARENT mode. By default Source NAT +is enabled as LBSnatAutoMap. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +LBSnatTranslation. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in LBSnatTranslation.
      • +
    +
    +
    +
    +ALGORITHM_LEAST_CONNECTION = 'LEAST_CONNECTION'
    +
    + +
    +
    +ALGORITHM_ROUND_ROBIN = 'ROUND_ROBIN'
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBPoolListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Paged Collection of LBPool

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of LBPool) – LBPool list results
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBPoolMember(display_name=None, ip_address=None, port=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • display_name (str or None) – pool member name
      • +
    • ip_address (str) – pool member IP address format: ip
      • +
    • port (str or None) – If port is specified, all connections will be sent to this port. +Only single port is supported. If unset, the same port the client +connected to will be used, it could be overrode by +default_pool_member_port setting in virtual server. The port should +not specified for port range case. format: port-or-range
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBPoolMemberGroup(group_path=None, port=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • group_path (str) – Load balancer pool support Group as dynamic pool members. The IP +list of the Group would be used as pool member IP setting.
      • +
    • port (long or None) – If port is specified, all connections will be sent to this port. If +unset, the same port the client connected to will be used, it could +be overridden by default_pool_member_ports setting in virtual +server. The port should not specified for multiple ports case. +format: int32
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBRule(actions=None, display_name=None, match_conditions=None, match_strategy=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Binding of a LBPool and Group to a LBVirtualServer used to route +application traffic passing through load balancers. LBRule uses match +conditions to match application traffic passing through a LBVirtualServer +using HTTP or HTTPS. Can bind multiple LBVirtualServers to a Group. Each +LBRule consists of two optional match conditions, each match contidion +defines a criterion for application traffic. If no match conditions are +specified, then the LBRule will always match and it is used typically to +define default rules. If more than one match condition is specified, then +matching strategy determines if all conditions should match or any one +condition should match for the LBRule to be considered a match. A match +indicates that the LBVirtualServer should route the request to the Group +(parent of LBRule).

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • actions (list of vmware.vapi.struct.VapiStruct) – A list of actions to be executed at specified phase when load +balancer rule matches. The actions are used to manipulate +application traffic, such as rewrite URI of HTTP messages, redirect +HTTP messages, etc. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +LBRuleAction. When methods return a value of this class as +a return value, the attribute will contain all the attributes +defined in LBRuleAction.
      • +
    • display_name (str or None) – A display name useful for identifying an LbRule
      • +
    • match_conditions (list of vmware.vapi.struct.VapiStruct or None) – A list of match conditions used to match application traffic. +Multiple match conditions can be specified in one load balancer +rule, each match condition defines a criterion to match application +traffic. If no match conditions are specified, then the load +balancer rule will always match and it is used typically to define +default rules. If more than one match condition is specified, then +match strategy determines if all conditions should match or any one +condition should match for the load balancer rule to considered a +match. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +LBRuleCondition. When methods return a value of this class +as a return value, the attribute will contain all the attributes +defined in LBRuleCondition.
      • +
    • match_strategy (str or None) –

      Possible values are:

      + +

      If more than one match condition is specified, then matching +strategy determines if all conditions should match or any one +condition should match for the LB Rule to be considered a match. - +ALL indicates that both host_match and path_match must match for +this LBRule to be considered a match - ANY indicates that either +host_match or patch match may match for this LBRule to be +considered a match

      +
      • +
    +
    +
    +
    +MATCH_STRATEGY_ALL = 'ALL'
    +
    + +
    +
    +MATCH_STRATEGY_ANY = 'ANY'
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBRuleAction(type='LBRuleAction')
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Load balancer rule actions are used to manipulate application traffic. +Supported actions are LBSelectPoolAction

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:type (str) –

    Possible values are:

    + +
    +
    Type of load balancer rule action
    +
    +
    +
    +TYPE_LBSELECTPOOLACTION = 'LBSelectPoolAction'
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBRuleCondition(type='LBRuleCondition')
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Match conditions are used to match application traffic passing through load +balancers. Multiple match conditions can be specified in one load balancer +rule, each match condition defines a criterion for application traffic. If +more than one match condition is specified, match strategy determines if +all conditions should match or any one condition should match for the load +balancer rule to be considered a match.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:type (str) –

    Possible values are:

    + +
    +
    Type of load balancer rule condition
    +
    +
    +
    +TYPE_LBHTTPREQUESTHEADERCONDITION = 'LBHttpRequestHeaderCondition'
    +
    + +
    +
    +TYPE_LBHTTPREQUESTURICONDITION = 'LBHttpRequestUriCondition'
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBSelectPoolAction(pool_id=None, type='LBSelectPoolAction')
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    This action is used to select a pool for matched HTTP request messages. The +pool is specified by path. The matched HTTP request messages are forwarded +to the specified pool.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters: +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBServerSslProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, cipher_group_label=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • cipher_group_label (str or None) –

      Possible values are:

      + +
      +
      It is a label of cipher group which is mostly consumed by GUI.
      +
      • +
    +
    +
    +
    +CIPHER_GROUP_LABEL_BALANCED = 'BALANCED'
    +
    + +
    +
    +CIPHER_GROUP_LABEL_CUSTOM = 'CUSTOM'
    +
    + +
    +
    +CIPHER_GROUP_LABEL_HIGH_COMPATIBILITY = 'HIGH_COMPATIBILITY'
    +
    + +
    +
    +CIPHER_GROUP_LABEL_HIGH_SECURITY = 'HIGH_SECURITY'
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBServerSslProfileBinding(server_auth_ca_paths=None, ssl_profile_path=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • server_auth_ca_paths (list of str or None) – If server auth type is REQUIRED, server certificate must be signed +by one of the trusted Certificate Authorities (CAs), also referred +to as root CAs, whose self signed certificates are specified.
      • +
    • ssl_profile_path (str or None) – Server SSL profile defines reusable, application-independent server +side SSL properties.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBServerSslProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of LBServerSslProfile) – paginated list of load balancer server SSL profiles
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBService(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, access_log_enabled=None, connectivity_path=None, enabled=None, error_log_level=None, size=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • access_log_enabled (bool or None) – whether access log is enabled
      • +
    • connectivity_path (str or None) – LBS could be instantiated (or created) on Tier-1, etc. For now, +only Tier-1 object is supported.
      • +
    • enabled (bool or None) – whether the load balancer service is enabled
      • +
    • error_log_level (str or None) –

      Possible values are:

      + +

      Load balancer engine writes information about encountered issues of +different severity levels to the error log. This setting is used to +define the severity level of the error log.

      +
      • +
    • size (str or None) –

      Possible values are:

      + +
      +
      the size of load balancer service
      +
      • +
    +
    +
    +
    +ERROR_LOG_LEVEL_ALERT = 'ALERT'
    +
    + +
    +
    +ERROR_LOG_LEVEL_CRITICAL = 'CRITICAL'
    +
    + +
    +
    +ERROR_LOG_LEVEL_DEBUG = 'DEBUG'
    +
    + +
    +
    +ERROR_LOG_LEVEL_EMERGENCY = 'EMERGENCY'
    +
    + +
    +
    +ERROR_LOG_LEVEL_ERROR = 'ERROR'
    +
    + +
    +
    +ERROR_LOG_LEVEL_INFO = 'INFO'
    +
    + +
    +
    +ERROR_LOG_LEVEL_WARNING = 'WARNING'
    +
    + +
    +
    +SIZE_LARGE = 'LARGE'
    +
    + +
    +
    +SIZE_MEDIUM = 'MEDIUM'
    +
    + +
    +
    +SIZE_SMALL = 'SMALL'
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBServiceElement(element_id=None, elements=None, resource_name=None, resource_type=None, active_edge_tns=None, attached_router_id=None, runtime_status=None, size=None, standby_edge_tns=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Load Balancer service element, contains information about LoadBalancer +Service on an edge.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters: +
    +
    +
    +RESOURCE_TYPE_EDGENODEELEMENT = 'EdgeNodeElement'
    +
    + +
    +
    +RESOURCE_TYPE_GROUPELEMENT = 'GroupElement'
    +
    + +
    +
    +RESOURCE_TYPE_HOSTNODEELEMENT = 'HostNodeElement'
    +
    + +
    +
    +RESOURCE_TYPE_LBVIRTUALSERVERELEMENT = 'LBVirtualServerElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOADBALANCERSERVICEELEMENT = 'LoadBalancerServiceElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALROUTERPORTELEMENT = 'LogicalRouterPortElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALSWITCHELEMENT = 'LogicalSwitchElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALSWITCHPORTELEMENT = 'LogicalSwitchPortElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALT0ROUTERELEMENT = 'LogicalT0RouterElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALT1ROUTERELEMENT = 'LogicalT1RouterElement'
    +
    + +
    +
    +RESOURCE_TYPE_PROCESSELEMENT = 'ProcessElement'
    +
    + +
    +
    +RESOURCE_TYPE_VIRTUALNETWORKINTERFACEELEMENT = 'VirtualNetworkInterfaceElement'
    +
    + +
    +
    +RESOURCE_TYPE_VMELEMENT = 'VMElement'
    +
    + +
    +
    +RUNTIME_STATUS_DETACHED = 'DETACHED'
    +
    + +
    +
    +RUNTIME_STATUS_DISABLED = 'DISABLED'
    +
    + +
    +
    +RUNTIME_STATUS_DOWN = 'DOWN'
    +
    + +
    +
    +RUNTIME_STATUS_ERROR = 'ERROR'
    +
    + +
    +
    +RUNTIME_STATUS_NO_STANDBY = 'NO_STANDBY'
    +
    + +
    +
    +RUNTIME_STATUS_UNKNOWN = 'UNKNOWN'
    +
    + +
    +
    +RUNTIME_STATUS_UP = 'UP'
    +
    + +
    +
    +SIZE_LARGE = 'LARGE'
    +
    + +
    +
    +SIZE_MEDIUM = 'MEDIUM'
    +
    + +
    +
    +SIZE_SMALL = 'SMALL'
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBServiceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Paged Collection of LBServices

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of LBService) – LBService list results
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBSnatAutoMap(type='LBSnatAutoMap')
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:type (str) –

    Possible values are:

    + +

    Load balancers may need to perform SNAT to ensure reverse traffic +from the server can be received and processed by them. There are +two modes: LBSnatAutoMap uses the load balancer interface IP and an +ephemeral port as the source IP and port of the server side +connection. LBSnatDisabled disbles Source NAT. This is referred to +as no-SNAT or TRANSPARENT mode.

    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBSnatDisabled(type='LBSnatDisabled')
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:type (str) –

    Possible values are:

    + +

    Load balancers may need to perform SNAT to ensure reverse traffic +from the server can be received and processed by them. There are +two modes: LBSnatAutoMap uses the load balancer interface IP and an +ephemeral port as the source IP and port of the server side +connection. LBSnatDisabled disbles Source NAT. This is referred to +as no-SNAT or TRANSPARENT mode.

    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBSnatInfo(port_overload=None, snat_mode=None, source_ip_addresses=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Load balancer Virtual server pool Source Network Address Translation (SNAT) +information

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • port_overload (long or None) – Port to apply for source port during SNAT. format: int32 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • snat_mode (str or None) –

      Possible values are:

      + +
      +
      SNAT mode configured.
      +

      This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    • source_ip_addresses (list of str or None) – Source ip addresses to use during SNAT. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    +
    +
    +SNAT_MODE_AUTO_MAP = 'AUTO_MAP'
    +
    + +
    +
    +SNAT_MODE_IP_LIST = 'IP_LIST'
    +
    + +
    +
    +SNAT_MODE_TRANSPARENT = 'TRANSPARENT'
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBSnatTranslation(type='LBSnatTranslation')
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:type (str) –

    Possible values are:

    + +

    Load balancers may need to perform SNAT to ensure reverse traffic +from the server can be received and processed by them. There are +two modes: LBSnatAutoMap uses the load balancer interface IP and an +ephemeral port as the source IP and port of the server side +connection. LBSnatDisabled disbles Source NAT. This is referred to +as no-SNAT or TRANSPARENT mode.

    +
    +
    +
    +TYPE_LBSNATAUTOMAP = 'LBSnatAutoMap'
    +
    + +
    +
    +TYPE_LBSNATDISABLED = 'LBSnatDisabled'
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBSourceIpPersistenceProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LBSourceIpPersistenceProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, persistence_shared=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Some applications maintain state and require all relevant connections to be +sent to the same server as the application state is not synchronized among +servers. Persistence is enabled on a LBVirtualServer by binding a +persistence profile to it.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • persistence_shared (bool or None) – Persistence shared setting indicates that all LBVirtualServers that +consume this LBPersistenceProfile should share the same persistence +mechanism when enabled. Meaning, persistence entries of a client +accessing one virtual server will also affect the same client’s +connections to a different virtual server. For example, say there +are two virtual servers vip-ip1:80 and vip-ip1:8080 bound to the +same Group g1 consisting of two servers (s11:80 and s12:80). By +default, each virtual server will have its own persistence table or +cookie. So, in the earlier example, there will be two tables +(vip-ip1:80, p1) and (vip-ip1:8080, p1) or cookies. So, if a client +connects to vip1:80 and later connects to vip1:8080, the second +connection may be sent to a different server than the first. When +persistence_shared is enabled, then the second connection will +always connect to the same server as the original connection. For +COOKIE persistence type, the same cookie will be shared by multiple +virtual servers. For SOURCE_IP persistenct type, the persistence +table will be shared across virtual servers.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBSslProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Load balancer abstract SSL profile

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBTcpMonitorProfile(fall_count=None, interval=None, monitor_port=None, rise_count=None, timeout=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Active healthchecks are disabled by default and can be enabled for a server +pool by binding a health monitor to the Group through the LBRule object. +This represents active health monitoring over TCP. Active healthchecks are +initiated periodically, at a configurable interval, to each member of the +Group. Only if a healthcheck fails consecutively for a specified number of +times (fall_count) to a member will the member status be marked DOWN. Once +a member is DOWN, a specified number of consecutive successful healthchecks +(rise_count) will bring the member back to UP state. After a healthcheck is +initiated, if it does not complete within a certain period, then also the +healthcheck is considered to be unsuccessful. Completing a healthcheck +within timeout means establishing a connection (TCP or SSL), if applicable, +sending the request and receiving the response, all within the configured +timeout.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • fall_count (long or None) – Only if a healthcheck fails consecutively for a specified number of +times, given with fall_count, to a member will the member status be +marked DOWN. format: int64
      • +
    • interval (long or None) – Active healthchecks are initiated periodically, at a configurable +interval (in seconds), to each member of the Group. format: int64
      • +
    • monitor_port (long or None) – Typically, monitors perform healthchecks to Group members using the +member IP address and pool_port. However, in some cases, customers +prefer to run healthchecks against a different port than the pool +member port which handles actual application traffic. In such +cases, the port to run healthchecks against can be specified in the +monitor_port value. format: int32
      • +
    • rise_count (long or None) – Once a member is DOWN, a specified number of consecutive successful +healthchecks specified by rise_count will bring the member back to +UP state. format: int64
      • +
    • timeout (long or None) – Timeout specified in seconds. After a healthcheck is initiated, if +it does not complete within a certain period, then also the +healthcheck is considered to be unsuccessful. Completing a +healthcheck within timeout means establishing a connection (TCP or +SSL), if applicable, sending the request and receiving the +response, all within the configured timeout. format: int64
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      Load balancers monitor the health of backend servers to ensure +traffic is not black holed. In case of active healthchecks, load +balancer itself initiates new connections (or sends ICMP ping) to +the servers periodically to check their health, completely +independent of any data traffic. Currently, active health monitors +are supported for HTTP, HTTPS, TCP, UDP and ICMP protocols.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBUdpMonitorProfile(receive=None, send=None, fall_count=None, interval=None, monitor_port=None, rise_count=None, timeout=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Active healthchecks are disabled by default and can be enabled for a server +pool by binding a health monitor to the Group through the LBRule object. +This represents active health monitoring over UDP. Active healthchecks are +initiated periodically, at a configurable interval, to each member of the +Group. Only if a healthcheck fails consecutively for a specified number of +times (fall_count) to a member will the member status be marked DOWN. Once +a member is DOWN, a specified number of consecutive successful healthchecks +(rise_count) will bring the member back to UP state. After a healthcheck is +initiated, if it does not complete within a certain period, then also the +healthcheck is considered to be unsuccessful. Completing a healthcheck +within timeout means establishing a connection (TCP or SSL), if applicable, +sending the request and receiving the response, all within the configured +timeout.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • receive (str) – Expected data, can be anywhere in the response and it has to be a +string, regular expressions are not supported. UDP healthcheck is +considered failed if there is no server response within the timeout +period.
      • +
    • send (str) – The data to be sent to the monitored server.
      • +
    • fall_count (long or None) – Only if a healthcheck fails consecutively for a specified number of +times, given with fall_count, to a member will the member status be +marked DOWN. format: int64
      • +
    • interval (long or None) – Active healthchecks are initiated periodically, at a configurable +interval (in seconds), to each member of the Group. format: int64
      • +
    • monitor_port (long or None) – Typically, monitors perform healthchecks to Group members using the +member IP address and pool_port. However, in some cases, customers +prefer to run healthchecks against a different port than the pool +member port which handles actual application traffic. In such +cases, the port to run healthchecks against can be specified in the +monitor_port value. format: int32
      • +
    • rise_count (long or None) – Once a member is DOWN, a specified number of consecutive successful +healthchecks specified by rise_count will bring the member back to +UP state. format: int64
      • +
    • timeout (long or None) – Timeout specified in seconds. After a healthcheck is initiated, if +it does not complete within a certain period, then also the +healthcheck is considered to be unsuccessful. Completing a +healthcheck within timeout means establishing a connection (TCP or +SSL), if applicable, sending the request and receiving the +response, all within the configured timeout. format: int64
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      Load balancers monitor the health of backend servers to ensure +traffic is not black holed. In case of active healthchecks, load +balancer itself initiates new connections (or sends ICMP ping) to +the servers periodically to check their health, completely +independent of any data traffic. Currently, active health monitors +are supported for HTTP, HTTPS, TCP, UDP and ICMP protocols.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBVirtualServer(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, access_log_enabled=None, application_profile_path=None, client_ssl_profile_binding=None, ip_address=None, lb_persistence_profile_path=None, lb_service_path=None, pool_path=None, ports=None, rules=None, server_ssl_profile_binding=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    All the types of LBVirtualServer extend from this abstract class. This is +present for extensibility.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • access_log_enabled (bool or None) – If access log is enabled, all HTTP requests sent to an L7 virtual +server are logged to the access log file. Both successful requests +(backend server returns 2xx) and unsuccessful requests (backend +server returns 4xx or 5xx) are logged to access log, if enabled.
      • +
    • application_profile_path (str) – The application profile defines the application protocol +characteristics. It is used to influence how load balancing is +performed. Currently, LBFastTCPProfile, LBFastUDPProfile and +LBHttpProfile, etc are supported.
      • +
    • client_ssl_profile_binding (LBClientSslProfileBinding or None) – The setting is used when load balancer acts as an SSL server and +terminating the client SSL connection
      • +
    • ip_address (str) – Configures the IP address of the LBVirtualServer where it receives +all client connections and distributes them among the backend +servers. format: ip
      • +
    • lb_persistence_profile_path (str or None) – Path to optional object that enables persistence on a virtual +server allowing related client connections to be sent to the same +backend server. Persistence is disabled by default.
      • +
    • lb_service_path (str or None) – virtual servers can be associated to LBService(which is similar to +physical/virtual load balancer), Lb virtual servers, pools and +other entities could be defined independently, the LBService +identifier list here would be used to maintain the relationship of +LBService and other LB entities.
      • +
    • pool_path (str or None) – The server pool(LBPool) contains backend servers. Server pool +consists of one or more servers, also referred to as pool members, +that are similarly configured and are running the same application.
      • +
    • ports (list of str) – Ports contains a list of at least one port or port range such as +"80", "1234-1236". Each port element in the list +should be a single port or a single port range. format: +port-or-range
      • +
    • rules (list of LBRule or None) – Load balancer rules allow customization of load balancing behavior +using match/action rules. Currently, load balancer rules are +supported for only layer 7 virtual servers with LBHttpProfile.
      • +
    • server_ssl_profile_binding (LBServerSslProfileBinding or None) – The setting is used when load balancer acts as an SSL client and +establishing a connection to the backend server.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBVirtualServerElement(element_id=None, elements=None, resource_name=None, resource_type=None, runtime_status=None, server_ip=None, server_pool=None, server_port=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Load Balancer virtual server element information. It contains information +about the virtual server ip and the server pool.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters: +
    +
    +
    +RESOURCE_TYPE_EDGENODEELEMENT = 'EdgeNodeElement'
    +
    + +
    +
    +RESOURCE_TYPE_GROUPELEMENT = 'GroupElement'
    +
    + +
    +
    +RESOURCE_TYPE_HOSTNODEELEMENT = 'HostNodeElement'
    +
    + +
    +
    +RESOURCE_TYPE_LBVIRTUALSERVERELEMENT = 'LBVirtualServerElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOADBALANCERSERVICEELEMENT = 'LoadBalancerServiceElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALROUTERPORTELEMENT = 'LogicalRouterPortElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALSWITCHELEMENT = 'LogicalSwitchElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALSWITCHPORTELEMENT = 'LogicalSwitchPortElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALT0ROUTERELEMENT = 'LogicalT0RouterElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALT1ROUTERELEMENT = 'LogicalT1RouterElement'
    +
    + +
    +
    +RESOURCE_TYPE_PROCESSELEMENT = 'ProcessElement'
    +
    + +
    +
    +RESOURCE_TYPE_VIRTUALNETWORKINTERFACEELEMENT = 'VirtualNetworkInterfaceElement'
    +
    + +
    +
    +RESOURCE_TYPE_VMELEMENT = 'VMElement'
    +
    + +
    +
    +RUNTIME_STATUS_DETACHED = 'DETACHED'
    +
    + +
    +
    +RUNTIME_STATUS_DISABLED = 'DISABLED'
    +
    + +
    +
    +RUNTIME_STATUS_DOWN = 'DOWN'
    +
    + +
    +
    +RUNTIME_STATUS_PARTIALLY_DOWN = 'PARTIALLY_DOWN'
    +
    + +
    +
    +RUNTIME_STATUS_PARTIALLY_UP = 'PARTIALLY_UP'
    +
    + +
    +
    +RUNTIME_STATUS_UP = 'UP'
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBVirtualServerIpSetNsGroupMembers(members=None, membership_type=None, ns_group_id=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Virtual server pool members based on NsGruop of IPSet.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters: +
    +
    +
    +MEMBERSHIP_TYPE_LBVIRTUALSERVERIPSETNSGROUPMEMBERS = 'LBVirtualServerIpSetNsGroupMembers'
    +
    + +
    +
    +MEMBERSHIP_TYPE_LBVIRTUALSERVERPOOLSTATICMEMBERS = 'LBVirtualServerPoolStaticMembers'
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBVirtualServerListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Paged Collection of LBVirtualServers

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of LBVirtualServer) – LBVirtualServer list results
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBVirtualServerPool(pool_members_info=None, server_pool_algorithm=None, snat_info=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Virtual server pool information in a load balancer

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters: +
    +
    +
    +SERVER_POOL_ALGORITHM_IP_HASH = 'IP_HASH'
    +
    + +
    +
    +SERVER_POOL_ALGORITHM_LEAST_CONNECTION = 'LEAST_CONNECTION'
    +
    + +
    +
    +SERVER_POOL_ALGORITHM_ROUND_ROBIN = 'ROUND_ROBIN'
    +
    + +
    +
    +SERVER_POOL_ALGORITHM_WEIGHTED_LEAST_CONNECTION = 'WEIGHTED_LEAST_CONNECTION'
    +
    + +
    +
    +SERVER_POOL_ALGORITHM_WEIGHTED_ROUND_ROBIN = 'WEIGHTED_ROUND_ROBIN'
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBVirtualServerPoolMember(ip=None, member_status=None, name=None, port=None, weight=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Virtual server pool members information.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • ip (str or None) – IP address of the server pool member. format: ip +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • member_status (str or None) –

      Possible values are:

      + +
      +
      Server pool member runtime status
      +
      • +
    • name (str or None) – Name of the virtual server pool member +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • port (long or None) – Port on which this server pool member is listening. format: int32 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • weight (long or None) – Weight of this server pool member. format: int32 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    +
    +
    +MEMBER_STATUS_DISABLED = 'DISABLED'
    +
    + +
    +
    +MEMBER_STATUS_DOWN = 'DOWN'
    +
    + +
    +
    +MEMBER_STATUS_UNKNOWN = 'UNKNOWN'
    +
    + +
    +
    +MEMBER_STATUS_UP = 'UP'
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBVirtualServerPoolMembersInfo(members=None, membership_type=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Virtual server pool members information.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters: +
    +
    +
    +MEMBERSHIP_TYPE_LBVIRTUALSERVERIPSETNSGROUPMEMBERS = 'LBVirtualServerIpSetNsGroupMembers'
    +
    + +
    +
    +MEMBERSHIP_TYPE_LBVIRTUALSERVERPOOLSTATICMEMBERS = 'LBVirtualServerPoolStaticMembers'
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LBVirtualServerPoolStaticMembers(members=None, membership_type=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Virtual server pool static members.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters: +
    +
    +
    +MEMBERSHIP_TYPE_LBVIRTUALSERVERIPSETNSGROUPMEMBERS = 'LBVirtualServerIpSetNsGroupMembers'
    +
    + +
    +
    +MEMBERSHIP_TYPE_LBVIRTUALSERVERPOOLSTATICMEMBERS = 'LBVirtualServerPoolStaticMembers'
    +
    +
    @@ -11806,6 +39625,23 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • condition (str or None) – If the condition is met then the label will be applied. Examples of +expression syntax are provided under example_request section of +CreateWidgetConfiguration API.
      • +
    • hover (bool or None) – If true, displays the label only on hover
      • +
    • icons (list of Icon or None) – Icons to be applied at dashboard for the label
      • +
    • navigation (str or None) – Hyperlink of the specified UI page that provides details.
      • +
    • text (str) – Text to be displayed at the label.
      • +
    +
    @@ -11818,6 +39654,90 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • navigation (str or None) – Hyperlink of the specified UI page that provides details.
      • +
    • properties (list of PropertyItem) – An array of label-value properties.
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str) – Title of the widget.
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      Supported visualization types are LabelValueConfiguration, +DonutConfiguration, GridConfiguration, StatsConfiguration, +MultiWidgetConfiguration and ContainerConfiguration.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • datasources (list of Datasource or None) – The ‘datasources’ represent the sources from which data will be +fetched. Currently, only NSX-API is supported as a ‘default’ +datasource. An example of specifying ‘default’ datasource along +with the urls to fetch data from is given at ‘example_request’ +section of ‘CreateWidgetConfiguration’ API.
      • +
    • drilldown_id (str or None) – Id of drilldown widget, if any. Id should be a valid id of an +existing widget. A widget is considered as drilldown widget when it +is associated with any other widget and provides more detailed +information about any data item from the parent widget.
      • +
    • footer (Footer or None) –
      • +
    • is_drilldown (bool or None) – Set to true if this widget should be used as a drilldown.
      • +
    • shared (bool or None) – Please use the property ‘shared’ of View instead of this. The +widgets of a shared view are visible to other users.
      • +
    • weight (long or None) – Specify relavite weight in WidgetItem for placement in a view. +Please see WidgetItem for details. format: int32
      • +
    +
    @@ -11830,6 +39750,51 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    LOAD_BALANCE_ALGORITHM_DESTMAC = 'DESTMAC'
    @@ -11886,6 +39851,91 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • fall_count (long or None) – num of consecutive checks must fail before marking it down format: +int64
      • +
    • interval (long or None) – the frequency at which the system issues the monitor check (in +second) format: int64
      • +
    • monitor_port (str or None) – If the monitor port is specified, it would override pool member +port setting for healthcheck. A port range is not supported. +format: port-or-range
      • +
    • rise_count (long or None) – num of consecutive checks must pass before marking it up format: +int64
      • +
    • timeout (long or None) – the number of seconds the target has in which to respond to the +monitor request format: int64
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      Load balancers monitor the health of backend servers to ensure +traffic is not black holed. There are two types of healthchecks: +active and passive. Passive healthchecks depend on failures in +actual client traffic (e.g. RST from server in response to a client +connection) to detect that the server or the application is down. +In case of active healthchecks, load balancer itself initiates new +connections (or sends ICMP ping) to the servers periodically to +check their health, completely independent of any data traffic. +Currently, active health monitors are supported for HTTP, HTTPS, +TCP, UDP and ICMP protocols.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    +
    @@ -11897,6 +39947,81 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      An application profile can be bound to a virtual server to specify +the application protocol characteristics. It is used to influence +how load balancing is performed. Currently, three types of +application profiles are supported: LbFastTCPProfile, +LbFastUDPProfile and LbHttpProfile. LbFastTCPProfile or +LbFastUDPProfile is typically used when the application is using a +custom protocol or a standard protocol not supported by the load +balancer. It is also used in cases where the user only wants L4 +load balancing mainly because L4 load balancing has much higher +performance and scalability, and/or supports connection mirroring. +LbHttpProfile is used for both HTTP and HTTPS applications. Though +application rules, if bound to the virtual server, can be used to +accomplish the same goal, LbHttpProfile is intended to simplify +enabling certain common use cases.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    +
    RESOURCE_TYPE_LBFASTTCPPROFILE = 'LbFastTcpProfile'
    @@ -11923,17 +40048,310 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of vmware.vapi.struct.VapiStruct) – paginated list of load balancer application profiles +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +LbAppProfile. When methods return a value of this class as +a return value, the attribute will contain all the attributes +defined in LbAppProfile.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LbClientCertificateIssuerDnCondition(case_sensitive=None, issuer_dn=None, match_type=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Match condition for client certficate issuer DN

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters: +
    +
    +
    +MATCH_TYPE_CONTAINS = 'CONTAINS'
    +
    + +
    +
    +MATCH_TYPE_ENDS_WITH = 'ENDS_WITH'
    +
    + +
    +
    +MATCH_TYPE_EQUALS = 'EQUALS'
    +
    + +
    +
    +MATCH_TYPE_REGEX = 'REGEX'
    +
    + +
    +
    +MATCH_TYPE_STARTS_WITH = 'STARTS_WITH'
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LbClientCertificateSubjectDnCondition(case_sensitive=None, match_type=None, subject_dn=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Match condition for client certficate subject DN

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters: +
    +
    +
    +MATCH_TYPE_CONTAINS = 'CONTAINS'
    +
    + +
    +
    +MATCH_TYPE_ENDS_WITH = 'ENDS_WITH'
    +
    + +
    +
    +MATCH_TYPE_EQUALS = 'EQUALS'
    +
    + +
    +
    +MATCH_TYPE_REGEX = 'REGEX'
    +
    + +
    +
    +MATCH_TYPE_STARTS_WITH = 'STARTS_WITH'
    +
    +
    -class com.vmware.nsx_policy.model_client.LbClientSslProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, ciphers=None, is_secure=None, prefer_server_ciphers=None, protocols=None, session_cache_enabled=None, session_cache_timeout=None)
    +class com.vmware.nsx_policy.model_client.LbClientSslProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, cipher_group_label=None, ciphers=None, is_fips=None, is_secure=None, prefer_server_ciphers=None, protocols=None, session_cache_enabled=None, session_cache_timeout=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA = 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA'
    @@ -12089,6 +40507,26 @@ names.

    CIPHERS_RSA_WITH_AES_256_GCM_SHA384 = 'TLS_RSA_WITH_AES_256_GCM_SHA384'
    +
    +
    +CIPHER_GROUP_LABEL_BALANCED = 'BALANCED'
    +
    + +
    +
    +CIPHER_GROUP_LABEL_CUSTOM = 'CUSTOM'
    +
    + +
    +
    +CIPHER_GROUP_LABEL_HIGH_COMPATIBILITY = 'HIGH_COMPATIBILITY'
    +
    + +
    +
    +CIPHER_GROUP_LABEL_HIGH_SECURITY = 'HIGH_SECURITY'
    +
    +
    PROTOCOLS_SSL_V2 = 'SSL_V2'
    @@ -12125,6 +40563,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of LbClientSslProfile) – paginated list of load balancer client SSL profiles
      • +
    +
    @@ -12136,6 +40607,115 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • cookie_domain (str or None) – HTTP cookie domain could be configured, only available for insert +mode.
      • +
    • cookie_fallback (bool or None) – If fallback is true, once the cookie points to a server that is +down (i.e. admin state DISABLED or healthcheck state is DOWN), then +a new server is selected by default to handle that request. If +fallback is false, it will cause the request to be rejected if +cookie points to a server
      • +
    • cookie_garble (bool or None) – If garble is set to true, cookie value (server IP and port) would +be encrypted. If garble is set to false, cookie value would be +plain text.
      • +
    • cookie_mode (str or None) –

      Possible values are:

      + +
      +
      cookie persistence mode
      +
      • +
    • cookie_name (str) – cookie name
      • +
    • cookie_path (str or None) – HTTP cookie path could be set, only available for insert mode.
      • +
    • cookie_time (vmware.vapi.struct.VapiStruct or None) – Both session cookie and persistence cookie are supported, if not +specified, it’s a session cookie. It expires when the browser is +closed. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +LbCookieTime. When methods return a value of this class as +a return value, the attribute will contain all the attributes +defined in LbCookieTime.
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      Source-ip persistence ensures all connections from a client +(identified by IP address) are sent to the same backend server for +a specified period. Cookie persistence allows related client +connections, identified by the same cookie in HTTP requests, to be +redirected to the same server.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • persistence_shared (bool or None) – If persistence shared flag is not set in the cookie persistence +profile bound to a virtual server, it defaults to cookie +persistence that is private to each virtual server and is qualified +by the pool. This is accomplished by load balancer inserting a +cookie with name in the format +<name>.<virtual_server_id>.<pool_id>. If persistence shared flag is +set in the cookie persistence profile, in cookie insert mode, +cookie persistence could be shared across multiple virtual servers +that are bound to the same pools. The cookie name would be changed +to <name>.<profile-id>.<pool-id>. If persistence shared flag is not +set in the sourceIp persistence profile bound to a virtual server, +each virtual server that the profile is bound to maintains its own +private persistence table. If persistence shared flag is set in the +sourceIp persistence profile, all virtual servers the profile is +bound to share the same persistence table.
      • +
    +
    COOKIE_MODE_INSERT = 'INSERT'
    @@ -12162,6 +40742,22 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:type (str) –

    Possible values are:

    + +

    Both session cookie and persistence cookie are supported, Use +LbSessionCookieTime for session cookie time setting, Use +LbPersistenceCookieTime for persistence cookie time setting

    +
    TYPE_LBPERSISTENCECOOKIETIME = 'LbPersistenceCookieTime'
    @@ -12183,6 +40779,89 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • close_timeout (long or None) – It is used to specify how long a closing TCP connection (both FINs +received or a RST is received) should be kept for this application +before cleaning up the connection. format: int64
      • +
    • ha_flow_mirroring_enabled (bool or None) – If flow mirroring is enabled, all the flows to the bounded virtual +server are mirrored to the standby node.
      • +
    • idle_timeout (long or None) – It is used to configure how long an idle TCP connection in +ESTABLISHED state should be kept for this application before +cleaning up. format: int64
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      An application profile can be bound to a virtual server to specify +the application protocol characteristics. It is used to influence +how load balancing is performed. Currently, three types of +application profiles are supported: LbFastTCPProfile, +LbFastUDPProfile and LbHttpProfile. LbFastTCPProfile or +LbFastUDPProfile is typically used when the application is using a +custom protocol or a standard protocol not supported by the load +balancer. It is also used in cases where the user only wants L4 +load balancing mainly because L4 load balancing has much higher +performance and scalability, and/or supports connection mirroring. +LbHttpProfile is used for both HTTP and HTTPS applications. Though +application rules, if bound to the virtual server, can be used to +accomplish the same goal, LbHttpProfile is intended to simplify +enabling certain common use cases.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    +
    @@ -12194,6 +40873,90 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • flow_mirroring_enabled (bool or None) – If flow mirroring is enabled, all the flows to the bounded virtual +server are mirrored to the standby node.
      • +
    • idle_timeout (long or None) – Though UDP is a connectionless protocol, for the purposes of load +balancing, all UDP packets with the same flow signature (source and +destination IP/ports and IP protocol) received within the idle +timeout period are considered to belong to the same connection and +are sent to the same backend server. If no packets are received for +idle timeout period, the connection (association between flow +signature and the selected server) is cleaned up. format: int64
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      An application profile can be bound to a virtual server to specify +the application protocol characteristics. It is used to influence +how load balancing is performed. Currently, three types of +application profiles are supported: LbFastTCPProfile, +LbFastUDPProfile and LbHttpProfile. LbFastTCPProfile or +LbFastUDPProfile is typically used when the application is using a +custom protocol or a standard protocol not supported by the load +balancer. It is also used in cases where the user only wants L4 +load balancing mainly because L4 load balancing has much higher +performance and scalability, and/or supports connection mirroring. +LbHttpProfile is used for both HTTP and HTTPS applications. Though +application rules, if bound to the virtual server, can be used to +accomplish the same goal, LbHttpProfile is intended to simplify +enabling certain common use cases.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    +
    @@ -12205,6 +40968,124 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • request_body (str or None) – String to send as part of HTTP health check request body. Valid +only for certain HTTP methods like POST.
      • +
    • request_headers (list of LbHttpRequestHeader or None) – Array of HTTP request headers
      • +
    • request_method (str or None) –

      Possible values are:

      + +
      +
      the health check method for HTTP monitor type
      +
      • +
    • request_url (str or None) – URL used for HTTP monitor
      • +
    • request_version (str or None) –

      Possible values are:

      +
        +
      • LbHttpMonitor.REQUEST_VERSION__1_0
        • +
      • LbHttpMonitor.REQUEST_VERSION__1_1
        • +
      • LbHttpMonitor.REQUEST_VERSION__2_0
        • +
      +
      +
      HTTP request version
      +
      • +
    • response_body (str or None) – If HTTP response body match string (regular expressions not +supported) is specified (using LbHttpMonitor.response_body) then +the healthcheck HTTP response body is matched against the specified +string and server is considered healthy only if there is a match. +If the response body string is not specified, HTTP healthcheck is +considered successful if the HTTP response status code is 2xx, but +it can be configured to accept other status codes as successful.
      • +
    • response_status_codes (list of long or None) – The HTTP response status code should be a valid HTTP status code. +format: int32
      • +
    • fall_count (long or None) – num of consecutive checks must fail before marking it down format: +int64
      • +
    • interval (long or None) – the frequency at which the system issues the monitor check (in +second) format: int64
      • +
    • monitor_port (str or None) – If the monitor port is specified, it would override pool member +port setting for healthcheck. A port range is not supported. +format: port-or-range
      • +
    • rise_count (long or None) – num of consecutive checks must pass before marking it up format: +int64
      • +
    • timeout (long or None) – the number of seconds the target has in which to respond to the +monitor request format: int64
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      Load balancers monitor the health of backend servers to ensure +traffic is not black holed. There are two types of healthchecks: +active and passive. Passive healthchecks depend on failures in +actual client traffic (e.g. RST from server in response to a client +connection) to detect that the server or the application is down. +In case of active healthchecks, load balancer itself initiates new +connections (or sends ICMP ping) to the servers periodically to +check their health, completely independent of any data traffic. +Currently, active health monitors are supported for HTTP, HTTPS, +TCP, UDP and ICMP protocols.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    +
    REQUEST_METHOD_GET = 'GET'
    @@ -12256,6 +41137,108 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • http_redirect_to (str or None) – If a website is temporarily down or has moved, incoming requests +for that virtual server can be temporarily redirected to a URL
      • +
    • http_redirect_to_https (bool or None) – Certain secure applications may want to force communication over +SSL, but instead of rejecting non-SSL connections, they may choose +to redirect the client automatically to use SSL.
      • +
    • idle_timeout (long or None) – It is used to specify the HTTP application idle timeout, it means +that how long the load balancer will keep the connection idle to +wait for the client to send the next keep-alive request. It is not +a TCP socket setting. format: int64
      • +
    • ntlm (bool or None) – NTLM is an authentication protocol that can be used over HTTP. If +the flag is set to true, LB will use NTLM challenge/response +methodology.
      • +
    • request_body_size (long or None) – If it is not specified, it means that request body size is +unlimited. format: int64
      • +
    • request_header_size (long or None) – A request with header larger than request_header_size will be +processed as best effort whereas a request with header below this +specified size is guaranteed to be processed. format: int64
      • +
    • response_timeout (long or None) – If server doesn’t send any packet within this time, the connection +is closed. format: int64
      • +
    • x_forwarded_for (str or None) –

      Possible values are:

      + +
      +
      insert or replace x_forwarded_for
      +
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      An application profile can be bound to a virtual server to specify +the application protocol characteristics. It is used to influence +how load balancing is performed. Currently, three types of +application profiles are supported: LbFastTCPProfile, +LbFastUDPProfile and LbHttpProfile. LbFastTCPProfile or +LbFastUDPProfile is typically used when the application is using a +custom protocol or a standard protocol not supported by the load +balancer. It is also used in cases where the user only wants L4 +load balancing mainly because L4 load balancing has much higher +performance and scalability, and/or supports connection mirroring. +LbHttpProfile is used for both HTTP and HTTPS applications. Though +application rules, if bound to the virtual server, can be used to +accomplish the same goal, LbHttpProfile is intended to simplify +enabling certain common use cases.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    +
    XFORWARDED_FOR_INSERT = 'INSERT'
    @@ -12291,6 +41274,34 @@ on the same host.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    @@ -12308,6 +41319,34 @@ LbHttpRejectAction does not support variables.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    @@ -12323,6 +41362,49 @@ HTTP requests.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    MATCH_TYPE_CONTAINS = 'CONTAINS'
    @@ -12362,6 +41444,50 @@ to compare cookie value.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    MATCH_TYPE_CONTAINS = 'CONTAINS'
    @@ -12398,6 +41524,18 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • header_name (str) – Name of HTTP request header
      • +
    • header_value (str) – Value of HTTP request header
      • +
    +
    @@ -12417,6 +41555,50 @@ field does not support match types.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    MATCH_TYPE_CONTAINS = 'CONTAINS'
    @@ -12444,6 +41626,48 @@ names.

    +
    +
    +class com.vmware.nsx_policy.model_client.LbHttpRequestHeaderDeleteAction(header_name=None, type='LbHttpRequestHeaderDeleteAction')
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    This action is used to delete header fields of HTTP request messages at +HTTP_REQUEST_REWRITE phase. One action can be used to delete all headers +with same header name. To delete headers with different header names, +multiple actions must be defined.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters: +
    +
    +
    class com.vmware.nsx_policy.model_client.LbHttpRequestHeaderRewriteAction(header_name=None, header_value=None, type='LbHttpRequestHeaderRewriteAction')
    @@ -12458,6 +41682,34 @@ header_value field, header_name field does not support variables.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    @@ -12474,6 +41726,47 @@ condition.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    METHOD_GET = 'GET'
    @@ -12521,6 +41814,49 @@ fields which support variables.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    MATCH_TYPE_CONTAINS = 'CONTAINS'
    @@ -12580,6 +41916,49 @@ set the uri field of LbHttpRequestUriRewriteAction as:

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    MATCH_TYPE_CONTAINS = 'CONTAINS'
    @@ -12626,6 +42005,35 @@ this action.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    @@ -12639,6 +42047,45 @@ request messages.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    VERSION_1_0 = 'HTTP_VERSION_1_0'
    @@ -12673,6 +42120,50 @@ responses. The header_name field does not support match types.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    MATCH_TYPE_CONTAINS = 'CONTAINS'
    @@ -12700,6 +42191,48 @@ names.

    +
    +
    +class com.vmware.nsx_policy.model_client.LbHttpResponseHeaderDeleteAction(header_name=None, type='LbHttpResponseHeaderDeleteAction')
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    This action is used to delete header fields of HTTP response messages at +HTTP_RESPONSE_REWRITE phase. One action can be used to delete allgi headers +with same header name. To delete headers with different header names, +multiple actions must be defined

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters: +
    +
    +
    class com.vmware.nsx_policy.model_client.LbHttpResponseHeaderRewriteAction(header_name=None, header_value=None, type='LbHttpResponseHeaderRewriteAction')
    @@ -12715,17 +42248,744 @@ variables.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LbHttpSslCondition(client_certificate_issuer_dn=None, client_certificate_subject_dn=None, client_supported_ssl_ciphers=None, session_reused=None, used_protocol=None, used_ssl_cipher=None, inverse=None, type='LbHttpSslCondition')
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    This condition is used to match SSL handshake and SSL connection at all +phases.If multiple properties are configured, the rule is considered a +match when all the configured properties are matched.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters: +
    +
    +
    +CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA = 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA'
    +
    + +
    +
    +CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256'
    +
    + +
    +
    +CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256'
    +
    + +
    +
    +CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA = 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA'
    +
    + +
    +
    +CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384'
    +
    + +
    +
    +CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384'
    +
    + +
    +
    +CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHA = 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA'
    +
    + +
    +
    +CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256'
    +
    + +
    +
    +CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256'
    +
    + +
    +
    +CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHA = 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA'
    +
    + +
    +
    +CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384'
    +
    + +
    +
    +CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384'
    +
    + +
    +
    +CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHA = 'TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA'
    +
    + +
    +
    +CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256'
    +
    + +
    +
    +CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256'
    +
    + +
    +
    +CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHA = 'TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA'
    +
    + +
    +
    +CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384'
    +
    + +
    +
    +CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384'
    +
    + +
    +
    +CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHA = 'TLS_ECDH_RSA_WITH_AES_128_CBC_SHA'
    +
    + +
    +
    +CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256'
    +
    + +
    +
    +CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_RSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256'
    +
    + +
    +
    +CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHA = 'TLS_ECDH_RSA_WITH_AES_256_CBC_SHA'
    +
    + +
    +
    +CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384'
    +
    + +
    +
    +CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_RSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384'
    +
    + +
    +
    +CLIENT_SUPPORTED_SSL_CIPHERS_RSA_WITH_3DES_EDE_CBC_SHA = 'TLS_RSA_WITH_3DES_EDE_CBC_SHA'
    +
    + +
    +
    +CLIENT_SUPPORTED_SSL_CIPHERS_RSA_WITH_AES_128_CBC_SHA = 'TLS_RSA_WITH_AES_128_CBC_SHA'
    +
    + +
    +
    +CLIENT_SUPPORTED_SSL_CIPHERS_RSA_WITH_AES_128_CBC_SHA256 = 'TLS_RSA_WITH_AES_128_CBC_SHA256'
    +
    + +
    +
    +CLIENT_SUPPORTED_SSL_CIPHERS_RSA_WITH_AES_128_GCM_SHA256 = 'TLS_RSA_WITH_AES_128_GCM_SHA256'
    +
    + +
    +
    +CLIENT_SUPPORTED_SSL_CIPHERS_RSA_WITH_AES_256_CBC_SHA = 'TLS_RSA_WITH_AES_256_CBC_SHA'
    +
    + +
    +
    +CLIENT_SUPPORTED_SSL_CIPHERS_RSA_WITH_AES_256_CBC_SHA256 = 'TLS_RSA_WITH_AES_256_CBC_SHA256'
    +
    + +
    +
    +CLIENT_SUPPORTED_SSL_CIPHERS_RSA_WITH_AES_256_GCM_SHA384 = 'TLS_RSA_WITH_AES_256_GCM_SHA384'
    +
    + +
    +
    +SESSION_REUSED_IGNORE = 'IGNORE'
    +
    + +
    +
    +SESSION_REUSED_NEW = 'NEW'
    +
    + +
    +
    +SESSION_REUSED_REUSED = 'REUSED'
    +
    + +
    +
    +USED_PROTOCOL_SSL_V2 = 'SSL_V2'
    +
    + +
    +
    +USED_PROTOCOL_SSL_V3 = 'SSL_V3'
    +
    + +
    +
    +USED_PROTOCOL_TLS_V1 = 'TLS_V1'
    +
    + +
    +
    +USED_PROTOCOL_TLS_V1_1 = 'TLS_V1_1'
    +
    + +
    +
    +USED_PROTOCOL_TLS_V1_2 = 'TLS_V1_2'
    +
    + +
    +
    +USED_SSL_CIPHER_ECDHE_ECDSA_WITH_AES_128_CBC_SHA = 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA'
    +
    + +
    +
    +USED_SSL_CIPHER_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256'
    +
    + +
    +
    +USED_SSL_CIPHER_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256'
    +
    + +
    +
    +USED_SSL_CIPHER_ECDHE_ECDSA_WITH_AES_256_CBC_SHA = 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA'
    +
    + +
    +
    +USED_SSL_CIPHER_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384'
    +
    + +
    +
    +USED_SSL_CIPHER_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384'
    +
    + +
    +
    +USED_SSL_CIPHER_ECDHE_RSA_WITH_AES_128_CBC_SHA = 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA'
    +
    + +
    +
    +USED_SSL_CIPHER_ECDHE_RSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256'
    +
    + +
    +
    +USED_SSL_CIPHER_ECDHE_RSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256'
    +
    + +
    +
    +USED_SSL_CIPHER_ECDHE_RSA_WITH_AES_256_CBC_SHA = 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA'
    +
    + +
    +
    +USED_SSL_CIPHER_ECDHE_RSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384'
    +
    + +
    +
    +USED_SSL_CIPHER_ECDHE_RSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384'
    +
    + +
    +
    +USED_SSL_CIPHER_ECDH_ECDSA_WITH_AES_128_CBC_SHA = 'TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA'
    +
    + +
    +
    +USED_SSL_CIPHER_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256'
    +
    + +
    +
    +USED_SSL_CIPHER_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256'
    +
    + +
    +
    +USED_SSL_CIPHER_ECDH_ECDSA_WITH_AES_256_CBC_SHA = 'TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA'
    +
    + +
    +
    +USED_SSL_CIPHER_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384'
    +
    + +
    +
    +USED_SSL_CIPHER_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384'
    +
    + +
    +
    +USED_SSL_CIPHER_ECDH_RSA_WITH_AES_128_CBC_SHA = 'TLS_ECDH_RSA_WITH_AES_128_CBC_SHA'
    +
    + +
    +
    +USED_SSL_CIPHER_ECDH_RSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256'
    +
    + +
    +
    +USED_SSL_CIPHER_ECDH_RSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256'
    +
    + +
    +
    +USED_SSL_CIPHER_ECDH_RSA_WITH_AES_256_CBC_SHA = 'TLS_ECDH_RSA_WITH_AES_256_CBC_SHA'
    +
    + +
    +
    +USED_SSL_CIPHER_ECDH_RSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384'
    +
    + +
    +
    +USED_SSL_CIPHER_ECDH_RSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384'
    +
    + +
    +
    +USED_SSL_CIPHER_RSA_WITH_3DES_EDE_CBC_SHA = 'TLS_RSA_WITH_3DES_EDE_CBC_SHA'
    +
    + +
    +
    +USED_SSL_CIPHER_RSA_WITH_AES_128_CBC_SHA = 'TLS_RSA_WITH_AES_128_CBC_SHA'
    +
    + +
    +
    +USED_SSL_CIPHER_RSA_WITH_AES_128_CBC_SHA256 = 'TLS_RSA_WITH_AES_128_CBC_SHA256'
    +
    + +
    +
    +USED_SSL_CIPHER_RSA_WITH_AES_128_GCM_SHA256 = 'TLS_RSA_WITH_AES_128_GCM_SHA256'
    +
    + +
    +
    +USED_SSL_CIPHER_RSA_WITH_AES_256_CBC_SHA = 'TLS_RSA_WITH_AES_256_CBC_SHA'
    +
    + +
    +
    +USED_SSL_CIPHER_RSA_WITH_AES_256_CBC_SHA256 = 'TLS_RSA_WITH_AES_256_CBC_SHA256'
    +
    + +
    +
    +USED_SSL_CIPHER_RSA_WITH_AES_256_GCM_SHA384 = 'TLS_RSA_WITH_AES_256_GCM_SHA384'
    +
    +
    -class com.vmware.nsx_policy.model_client.LbHttpsMonitor(certificate_chain_depth=None, ciphers=None, client_certificate_id=None, is_secure=None, protocols=None, request_body=None, request_headers=None, request_method=None, request_url=None, request_version=None, response_body=None, response_status_codes=None, server_auth=None, server_auth_ca_ids=None, server_auth_crl_ids=None, fall_count=None, interval=None, monitor_port=None, rise_count=None, timeout=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None)
    +class com.vmware.nsx_policy.model_client.LbHttpsMonitor(certificate_chain_depth=None, cipher_group_label=None, ciphers=None, client_certificate_id=None, is_fips=None, is_secure=None, protocols=None, request_body=None, request_headers=None, request_method=None, request_url=None, request_version=None, response_body=None, response_status_codes=None, server_auth=None, server_auth_ca_ids=None, server_auth_crl_ids=None, fall_count=None, interval=None, monitor_port=None, rise_count=None, timeout=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA = 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA'
    @@ -12881,6 +43141,26 @@ names.

    CIPHERS_RSA_WITH_AES_256_GCM_SHA384 = 'TLS_RSA_WITH_AES_256_GCM_SHA384'
    +
    +
    +CIPHER_GROUP_LABEL_BALANCED = 'BALANCED'
    +
    + +
    +
    +CIPHER_GROUP_LABEL_CUSTOM = 'CUSTOM'
    +
    + +
    +
    +CIPHER_GROUP_LABEL_HIGH_COMPATIBILITY = 'HIGH_COMPATIBILITY'
    +
    + +
    +
    +CIPHER_GROUP_LABEL_HIGH_SECURITY = 'HIGH_SECURITY'
    +
    +
    PROTOCOLS_SSL_V2 = 'SSL_V2'
    @@ -12967,6 +43247,92 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • data_length (long or None) – The data size(in byte) of the ICMP healthcheck packet format: int64
      • +
    • fall_count (long or None) – num of consecutive checks must fail before marking it down format: +int64
      • +
    • interval (long or None) – the frequency at which the system issues the monitor check (in +second) format: int64
      • +
    • monitor_port (str or None) – If the monitor port is specified, it would override pool member +port setting for healthcheck. A port range is not supported. +format: port-or-range
      • +
    • rise_count (long or None) – num of consecutive checks must pass before marking it up format: +int64
      • +
    • timeout (long or None) – the number of seconds the target has in which to respond to the +monitor request format: int64
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      Load balancers monitor the health of backend servers to ensure +traffic is not black holed. There are two types of healthchecks: +active and passive. Passive healthchecks depend on failures in +actual client traffic (e.g. RST from server in response to a client +connection) to detect that the server or the application is down. +In case of active healthchecks, load balancer itself initiates new +connections (or sends ICMP ping) to the servers periodically to +check their health, completely independent of any data traffic. +Currently, active health monitors are supported for HTTP, HTTPS, +TCP, UDP and ICMP protocols.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    +
    @@ -12982,6 +43348,37 @@ like 10.1.1.101-10.1.1.160. Both IPv4 and IPv6 addresses are supported.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    @@ -12993,6 +43390,80 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      Load balancers monitor the health of backend servers to ensure +traffic is not black holed. There are two types of healthchecks: +active and passive. Passive healthchecks depend on failures in +actual client traffic (e.g. RST from server in response to a client +connection) to detect that the server or the application is down. +In case of active healthchecks, load balancer itself initiates new +connections (or sends ICMP ping) to the servers periodically to +check their health, completely independent of any data traffic. +Currently, active health monitors are supported for HTTP, HTTPS, +TCP, UDP and ICMP protocols.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    +
    RESOURCE_TYPE_LBHTTPMONITOR = 'LbHttpMonitor'
    @@ -13034,6 +43505,44 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of vmware.vapi.struct.VapiStruct) – paginated list of load balancer monitors +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +LbMonitor. When methods return a value of this class as a +return value, the attribute will contain all the attributes defined +in LbMonitor.
      • +
    +
    @@ -13045,6 +43554,85 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • max_fails (long or None) – When the consecutive failures reach this value, then the member is +considered temporarily unavailable for a configurable period +format: int64
      • +
    • timeout (long or None) – After this timeout period, the member is tried again for a new +connection to see if it is available. format: int64
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      Load balancers monitor the health of backend servers to ensure +traffic is not black holed. There are two types of healthchecks: +active and passive. Passive healthchecks depend on failures in +actual client traffic (e.g. RST from server in response to a client +connection) to detect that the server or the application is down. +In case of active healthchecks, load balancer itself initiates new +connections (or sends ICMP ping) to the servers periodically to +check their health, completely independent of any data traffic. +Currently, active health monitors are supported for HTTP, HTTPS, +TCP, UDP and ICMP protocols.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    +
    @@ -13056,6 +43644,27 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • cookie_max_idle (long) – HTTP cookie max-age to expire cookie, only available for insert +mode. format: int64
      • +
    • type (str) –

      Possible values are:

      + +

      Both session cookie and persistence cookie are supported, Use +LbSessionCookieTime for session cookie time setting, Use +LbPersistenceCookieTime for persistence cookie time setting

      +
      • +
    +
    @@ -13067,6 +43676,86 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      Source-ip persistence ensures all connections from a client +(identified by IP address) are sent to the same backend server for +a specified period. Cookie persistence allows related client +connections, identified by the same cookie in HTTP requests, to be +redirected to the same server.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • persistence_shared (bool or None) – If persistence shared flag is not set in the cookie persistence +profile bound to a virtual server, it defaults to cookie +persistence that is private to each virtual server and is qualified +by the pool. This is accomplished by load balancer inserting a +cookie with name in the format +<name>.<virtual_server_id>.<pool_id>. If persistence shared flag is +set in the cookie persistence profile, in cookie insert mode, +cookie persistence could be shared across multiple virtual servers +that are bound to the same pools. The cookie name would be changed +to <name>.<profile-id>.<pool-id>. If persistence shared flag is not +set in the sourceIp persistence profile bound to a virtual server, +each virtual server that the profile is bound to maintains its own +private persistence table. If persistence shared flag is set in the +sourceIp persistence profile, all virtual servers the profile is +bound to share the same persistence table.
      • +
    +
    RESOURCE_TYPE_LBCOOKIEPERSISTENCEPROFILE = 'LbCookiePersistenceProfile'
    @@ -13088,6 +43777,44 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of vmware.vapi.struct.VapiStruct) – paginated list of load balancer persistence profiles +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +LbPersistenceProfile. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in LbPersistenceProfile.
      • +
    +
    @@ -13099,6 +43826,112 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • active_monitor_ids (list of str or None) – In case of active healthchecks, load balancer itself initiates new +connections (or sends ICMP ping) to the servers periodically to +check their health, completely independent of any data traffic. +Active healthchecks are disabled by default and can be enabled for +a server pool by binding a health monitor to the pool. Currently, +only one active health monitor can be configured per server pool.
      • +
    • algorithm (str or None) –

      Possible values are:

      + +

      Load balancing algorithm, configurable per pool controls how the +incoming connections are distributed among the members.

      +
      • +
    • member_group (PoolMemberGroup or None) – Load balancer pool support grouping object as dynamic pool members. +When member group is defined, members setting should not be +specified.
      • +
    • members (list of PoolMember or None) – Server pool consists of one or more pool members. Each pool member +is identified, typically, by an IP address and a port.
      • +
    • min_active_members (long or None) – A pool is considered active if there are at least certain minimum +number of members. format: int64
      • +
    • passive_monitor_id (str or None) – Passive healthchecks are disabled by default and can be enabled by +attaching a passive health monitor to a server pool. Each time a +client connection to a pool member fails, its failed count is +incremented. For pools bound to L7 virtual servers, a connection is +considered to be failed and failed count is incremented if any TCP +connection errors (e.g. TCP RST or failure to send data) or SSL +handshake failures occur. For pools bound to L4 virtual servers, if +no response is received to a TCP SYN sent to the pool member or if +a TCP RST is received in response to a TCP SYN, then the pool +member is considered to have failed and the failed count is +incremented.
      • +
    • snat_translation (vmware.vapi.struct.VapiStruct or None) – Depending on the topology, Source NAT (SNAT) may be required to +ensure traffic from the server destined to the client is received +by the load balancer. SNAT can be enabled per pool. If SNAT is not +enabled for a pool, then load balancer uses the client IP and port +(spoofing) while establishing connections to the servers. This is +referred to as no-SNAT or TRANSPARENT mode. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +LbSnatTranslation. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in LbSnatTranslation.
      • +
    • tcp_multiplexing_enabled (bool or None) – TCP multiplexing allows the same TCP connection between load +balancer and the backend server to be used for sending multiple +client requests from different client TCP connections.
      • +
    • tcp_multiplexing_number (long or None) – The maximum number of TCP connections per pool that are idly kept +alive for sending future client requests. format: int64
      • +
    +
    ALGORITHM_IP_HASH = 'IP_HASH'
    @@ -13135,6 +43968,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of LbPool) – paginated list of pools
      • +
    +
    @@ -13146,6 +44012,20 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • ip_address (str) – Pool member IP address format: ip
      • +
    • port (str or None) – The port is configured in pool member. For virtual server port +range case, pool member port must be null. format: port-or-range
      • +
    • statistics (LbStatisticsCounter) – Pool member statistics counter
      • +
    +
    @@ -13157,6 +44037,41 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • failure_cause (str or None) – The healthcheck failure cause when status is DOWN
      • +
    • ip_address (str) – Pool member IP address format: ip
      • +
    • last_check_time (long or None) – Timestamp in milliseconds since epoch format: int64
      • +
    • last_state_change_time (long or None) – Timestamp in milliseconds since epoch format: int64
      • +
    • port (str or None) – The port is configured in pool member. For virtual server port +range case, pool member port must be null. format: port-or-range
      • +
    • status (str) –

      Possible values are:

      + +

      UP means that pool member is enabled and monitors have marked the +pool member as UP. If the pool member has no monitor configured, it +would be treated as UP. DOWN means that pool member is enabled and +monitors have marked the pool member as DOWN. DISABLED means that +admin state of pool member is set to DISABLED. GRACEFUL_DISABLED +means that admin state of pool member is set to GRACEFUL_DISABLED. +UNUSED means that the pool member is not used when the IP list size +of member group exceeds the maximum setting. The remaining IP +addresses would not be used as available backend servers, hence +mark the status as UNUSED.

      +
      • +
    +
    STATUS_DISABLED = 'DISABLED'
    @@ -13172,6 +44087,11 @@ names.

    STATUS_GRACEFUL_DISABLED = 'GRACEFUL_DISABLED'
    +
    +
    +STATUS_UNUSED = 'UNUSED'
    +
    +
    STATUS_UP = 'UP'
    @@ -13188,6 +44108,20 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • last_update_timestamp (long or None) – Timestamp when the data was last updated format: int64
      • +
    • members (list of LbPoolMemberStatistics or None) – Statistics of load balancer pool members
      • +
    • pool_id (str) – Load balancer pool identifier
      • +
    • statistics (LbStatisticsCounter) – Virtual server statistics counter
      • +
    +
    @@ -13199,6 +44133,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of LbPoolStatistics) – paginated statistics list of pools
      • +
    +
    @@ -13210,6 +44177,42 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • last_update_timestamp (long or None) – Timestamp when the data was last updated format: int64
      • +
    • members (list of LbPoolMemberStatus or None) – Status of load balancer pool members
      • +
    • pool_id (str) – Load balancer pool identifier
      • +
    • status (str or None) –

      Possible values are:

      + +

      UP means that all primary members are in UP status. PARTIALLY_UP +means that some(not all) primary members are in UP status, the +number of these active members is larger or equal to certain +number(min_active_members) which is defined in LbPool. When there +are no backup members which are in the UP status, the +number(min_active_members) would be ignored. PRIMARY_DOWN means +that less than certain(min_active_members) primary members are in +UP status but backup members are in UP status, connections to this +pool would be dispatched to backup members. DOWN means that all +primary and backup members are DOWN. DETACHED means that the pool +is not bound to any virtual server. UNKOWN means that no status +reported from transport-nodes. The associated load balancer service +may be working(or not working).

      +
      • +
    +
    STATUS_DETACHED = 'DETACHED'
    @@ -13230,6 +44233,11 @@ names.

    STATUS_PRIMARY_DOWN = 'PRIMARY_DOWN'
    +
    +
    +STATUS_UNKNOWN = 'UNKNOWN'
    +
    +
    STATUS_UP = 'UP'
    @@ -13246,6 +44254,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of LbPoolStatus) – paginated status list of pools
      • +
    +
    @@ -13263,6 +44304,115 @@ services.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • actions (list of vmware.vapi.struct.VapiStruct) – A list of actions to be executed at specified phase when load +balancer rule matches. The actions are used to manipulate +application traffic, such as rewrite URI of HTTP messages, redirect +HTTP messages, etc. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +LbRuleAction. When methods return a value of this class as +a return value, the attribute will contain all the attributes +defined in LbRuleAction.
      • +
    • match_conditions (list of vmware.vapi.struct.VapiStruct or None) – A list of match conditions used to match application traffic. +Multiple match conditions can be specified in one load balancer +rule, each match condition defines a criterion to match application +traffic. If no match conditions are specified, then the load +balancer rule will always match and it is used typically to define +default rules. If more than one match condition is specified, then +match strategy determines if all conditions should match or any one +condition should match for the load balancer rule to considered a +match. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +LbRuleCondition. When methods return a value of this class +as a return value, the attribute will contain all the attributes +defined in LbRuleCondition.
      • +
    • match_strategy (str) –

      Possible values are:

      + +

      Strategy to define how load balancer rule is considered a match +when multiple match conditions are specified in one rule. If +match_stragety is set to ALL, then load balancer rule is considered +a match only if all the conditions match. If match_strategy is set +to ANY, then load balancer rule is considered a match if any one of +the conditions match.

      +
      • +
    • phase (str) –

      Possible values are:

      + +

      Each load balancer rule is used at a specific phase of load +balancer processing. Currently three phases are supported, +HTTP_REQUEST_REWRITE, HTTP_FORWARDING and HTTP_RESPONSE_REWRITE. +When an HTTP request message is received by load balancer, all +HTTP_REQUEST_REWRITE rules, if present are executed in the order +they are applied to virtual server. And then if HTTP_FORWARDING +rules present, only first matching rule’s action is executed, +remaining rules are not checked. HTTP_FORWARDING rules can have +only one action. If the request is forwarded to a backend server +and the response goes back to load balancer, all +HTTP_RESPONSE_REWRITE rules, if present, are executed in the order +they are applied to the virtual server.

      +
      • +
    +
    MATCH_STRATEGY_ALL = 'ALL'
    @@ -13298,10 +44448,11 @@ names.

    Currently load balancer rules can be used at three load balancer processing phases. Each phase has its own supported type of actions. Supported actions in HTTP_REQUST_REWRITE phase are: LbHttpRequestUriRewriteAction -LbHttpRequestHeaderRewriteAction Supported actions in HTTP_FORWARDING phase -are: LbHttpRejectAction LbHttpRedirectAction LbSelectPoolAction -LbSelectServerAction Supported action in HTTP_RESPONSE_REWRITE phase is: -LbHttpResponseHeaderRewriteAction If the match type of an LbRuleCondition +LbHttpRequestHeaderRewriteAction LbHttpRequestHeaderDeleteAction +LbVariableAssignmentAction Supported actions in HTTP_FORWARDING phase are: +LbHttpRejectAction LbHttpRedirectAction LbSelectPoolAction Supported action +in HTTP_RESPONSE_REWRITE phase is: LbHttpResponseHeaderRewriteAction +LbHttpResponseHeaderDeleteAction If the match type of an LbRuleCondition field is specified as REGEX and named capturing groups are used in the specified regular expression. The groups can be used as variables in LbRuleAction fields. For example, define a rule with @@ -13340,6 +44491,29 @@ Administrator’s Guide.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:type (str) –

    Possible values are:

    + +
    +
    Type of load balancer rule action
    +
    TYPE_LBHTTPREDIRECTACTION = 'LbHttpRedirectAction'
    @@ -13350,6 +44524,11 @@ names.

    TYPE_LBHTTPREJECTACTION = 'LbHttpRejectAction'
    +
    +
    +TYPE_LBHTTPREQUESTHEADERDELETEACTION = 'LbHttpRequestHeaderDeleteAction'
    +
    +
    TYPE_LBHTTPREQUESTHEADERREWRITEACTION = 'LbHttpRequestHeaderRewriteAction'
    @@ -13360,6 +44539,11 @@ names.

    TYPE_LBHTTPREQUESTURIREWRITEACTION = 'LbHttpRequestUriRewriteAction'
    +
    +
    +TYPE_LBHTTPRESPONSEHEADERDELETEACTION = 'LbHttpResponseHeaderDeleteAction'
    +
    +
    TYPE_LBHTTPRESPONSEHEADERREWRITEACTION = 'LbHttpResponseHeaderRewriteAction'
    @@ -13375,6 +44559,11 @@ names.

    TYPE_LBSELECTSERVERACTION = 'LbSelectServerAction'
    +
    +
    +TYPE_LBVARIABLEASSIGNMENTACTION = 'LbVariableAssignmentAction'
    +
    +
    @@ -13397,21 +44586,53 @@ LbHttpRequestMethodCondition LbHttpRequestUriCondition LbHttpRequestUriArgumentsCondition LbHttpRequestVersionCondition LbHttpRequestHeaderCondition LbHttpRequestCookieCondition LbHttpRequestBodyCondition LbTcpHeaderCondition LbIpHeaderCondition -Supported match conditions in HTTP_FORWARDING phase are: -LbHttpRequestMethodCondition LbHttpRequestUriCondition -LbHttpRequestVersionCondition LbHttpRequestHeaderCondition -LbHttpRequestCookieCondition LbHttpRequestBodyCondition -LbTcpHeaderCondition LbIpHeaderCondition Supported match condition in +LbVariableCondition LbHttpSslCondition Supported match conditions in +HTTP_FORWARDING phase are: LbHttpRequestMethodCondition +LbHttpRequestUriCondition LbHttpRequestVersionCondition +LbHttpRequestHeaderCondition LbHttpRequestCookieCondition +LbHttpRequestBodyCondition LbTcpHeaderCondition LbIpHeaderCondition +LbVariableCondition LbHttpSslCondition Supported match condition in HTTP_RESPONSE_REWRITE phase is: LbHttpResponseHeaderCondition LbHttpRequestMethodCondition LbHttpRequestUriCondition LbHttpRequestUriArgumentsCondition LbHttpRequestVersionCondition LbHttpRequestHeaderCondition LbHttpRequestCookieCondition -LbTcpHeaderCondition LbIpHeaderCondition

    +LbTcpHeaderCondition LbIpHeaderCondition LbVariableCondition +LbHttpSslCondition

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    TYPE_LBHTTPREQUESTBODYCONDITION = 'LbHttpRequestBodyCondition'
    @@ -13452,6 +44673,11 @@ names.

    TYPE_LBHTTPRESPONSEHEADERCONDITION = 'LbHttpResponseHeaderCondition'
    +
    +
    +TYPE_LBHTTPSSLCONDITION = 'LbHttpSslCondition'
    +
    +
    TYPE_LBIPHEADERCONDITION = 'LbIpHeaderCondition'
    @@ -13462,6 +44688,11 @@ names.

    TYPE_LBTCPHEADERCONDITION = 'LbTcpHeaderCondition'
    +
    +
    +TYPE_LBVARIABLECONDITION = 'LbVariableCondition'
    +
    +
    @@ -13473,6 +44704,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of LbRule) – paginated list of LB rules
      • +
    +
    @@ -13487,32 +44751,172 @@ to the specified pool.

    The arguments are used to initialize data attributes with the same names.

    -
    - -
    -
    -class com.vmware.nsx_policy.model_client.LbSelectServerAction(ip=None, pool_id=None, port=None, type='LbSelectServerAction')
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    This action is used to select a backend server for matched HTTP request -messages. Matched HTTP request messages are forwarded to the specified -backend server. The ip and port fields must be specified as single values, -IP range and port range are not supported.

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    + +++ + + + +
    Parameters: +
    -class com.vmware.nsx_policy.model_client.LbServerSslProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, ciphers=None, is_secure=None, protocols=None, session_cache_enabled=None)
    +class com.vmware.nsx_policy.model_client.LbServerSslProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, cipher_group_label=None, ciphers=None, is_fips=None, is_secure=None, protocols=None, session_cache_enabled=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA = 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA'
    @@ -13668,6 +45072,26 @@ names.

    CIPHERS_RSA_WITH_AES_256_GCM_SHA384 = 'TLS_RSA_WITH_AES_256_GCM_SHA384'
    +
    +
    +CIPHER_GROUP_LABEL_BALANCED = 'BALANCED'
    +
    + +
    +
    +CIPHER_GROUP_LABEL_CUSTOM = 'CUSTOM'
    +
    + +
    +
    +CIPHER_GROUP_LABEL_HIGH_COMPATIBILITY = 'HIGH_COMPATIBILITY'
    +
    + +
    +
    +CIPHER_GROUP_LABEL_HIGH_SECURITY = 'HIGH_SECURITY'
    +
    +
    PROTOCOLS_SSL_V2 = 'SSL_V2'
    @@ -13704,6 +45128,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of LbServerSslProfile) – paginated list of load balancer server SSL profiles
      • +
    +
    @@ -13715,6 +45172,96 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • access_log_enabled (bool or None) – whether access log is enabled
      • +
    • attachment (ResourceReference or None) – LBS could be instantiated (or created) on the Logical router, etc. +Typically, it could be applied to Tier1 LogicalRouter. It can be +attached to Tier0 LogicalRouter either in non-multi-tenant +environments or to provide load balancing for infrastructure +services offered by the provider.
      • +
    • enabled (bool or None) – whether the load balancer service is enabled
      • +
    • error_log_level (str or None) –

      Possible values are:

      + +

      Load balancer engine writes information about encountered issues of +different severity levels to the error log. This setting is used to +define the severity level of the error log.

      +
      • +
    • size (str or None) –

      Possible values are:

      + +
      +
      the size of load balancer service
      +
      • +
    • virtual_server_ids (list of str or None) – virtual servers can be associated to LbService(which is similar to +physical/virtual load balancer), Lb virtual servers, pools and +other entities could be defined independently, the virtual server +identifier list here would be used to maintain the relationship of +LbService and other Lb entities.
      • +
    +
    ERROR_LOG_LEVEL_ALERT = 'ALERT'
    @@ -13776,6 +45323,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of LbService) – paginated list of load balancer services
      • +
    +
    @@ -13787,6 +45367,33 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • cookie_max_idle (long or None) – Instead of using HTTP Cookie max-age and relying on client to +expire the cookie, max idle time and/or max lifetime of the cookie +can be used. Max idle time, if configured, specifies the maximum +interval the cookie is valid for from the last time it was seen in +a request. It is available for insert mode. format: int64
      • +
    • cookie_max_life (long or None) – Max life time, if configured, specifies the maximum interval the +cookie is valid for from the first time the cookie was seen in a +request. It is available for insert mode. format: int64
      • +
    • type (str) –

      Possible values are:

      + +

      Both session cookie and persistence cookie are supported, Use +LbSessionCookieTime for session cookie time setting, Use +LbPersistenceCookieTime for persistence cookie time setting

      +
      • +
    +
    @@ -13798,6 +45405,35 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • port_overload (long or None) – Both SNAT automap and SNAT IP list modes support port overloading +which allows the same SNAT IP and port to be used for multiple +backend connections as long as the tuple (source IP, source port, +destination IP, destination port, IP protocol) after SNAT is +performed is unique. The valid number is 1, 2, 4, 8, 16, 32. +format: int64
      • +
    • type (str) –

      Possible values are:

      + +

      Load balancers may need to perform SNAT to ensure reverse traffic +from the server can be received and processed by them. There are +two modes: LbSnatAutoMap uses the load balancer interface IP and an +ephemeral port as the source IP and port of the server side +connection. LbSnatIpPool allows user to specify one or more IP +addresses along with their subnet masks that should be used for +SNAT while connecting to any of the servers in the pool.

      +
      • +
    +
    @@ -13809,6 +45445,20 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • ip_address (str) – Ip address or ip range such as 1.1.1.1 or 1.1.1.101-1.1.1.160 +format: address-or-block-or-range
      • +
    • prefix_length (long or None) – Subnet prefix length should be not specified if there is only one +single IP address or IP range. format: int64
      • +
    +
    @@ -13820,6 +45470,37 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • ip_addresses (list of LbSnatIpElement) – If an IP range is specified, the range may contain no more than 64 +IP addresses.
      • +
    • port_overload (long or None) – Both SNAT automap and SNAT IP list modes support port overloading +which allows the same SNAT IP and port to be used for multiple +backend connections as long as the tuple (source IP, source port, +destination IP, destination port, IP protocol) after SNAT is +performed is unique. The valid number is 1, 2, 4, 8, 16, 32. +format: int64
      • +
    • type (str) –

      Possible values are:

      + +

      Load balancers may need to perform SNAT to ensure reverse traffic +from the server can be received and processed by them. There are +two modes: LbSnatAutoMap uses the load balancer interface IP and an +ephemeral port as the source IP and port of the server side +connection. LbSnatIpPool allows user to specify one or more IP +addresses along with their subnet masks that should be used for +SNAT while connecting to any of the servers in the pool.

      +
      • +
    +
    @@ -13831,6 +45512,35 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • port_overload (long or None) – Both SNAT automap and SNAT IP list modes support port overloading +which allows the same SNAT IP and port to be used for multiple +backend connections as long as the tuple (source IP, source port, +destination IP, destination port, IP protocol) after SNAT is +performed is unique. The valid number is 1, 2, 4, 8, 16, 32. +format: int64
      • +
    • type (str) –

      Possible values are:

      + +

      Load balancers may need to perform SNAT to ensure reverse traffic +from the server can be received and processed by them. There are +two modes: LbSnatAutoMap uses the load balancer interface IP and an +ephemeral port as the source IP and port of the server side +connection. LbSnatIpPool allows user to specify one or more IP +addresses along with their subnet masks that should be used for +SNAT while connecting to any of the servers in the pool.

      +
      • +
    +
    TYPE_LBSNATAUTOMAP = 'LbSnatAutoMap'
    @@ -13852,6 +45562,98 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • ha_persistence_mirroring_enabled (bool or None) – Persistence entries are not synchronized to the HA peer by default.
      • +
    • purge (str or None) –

      Possible values are:

      + +
      +
      persistence purge setting
      +
      • +
    • timeout (long or None) – When all connections complete (reference count reaches 0), +persistence entry timer is started with the expiration time. +format: int64
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      Source-ip persistence ensures all connections from a client +(identified by IP address) are sent to the same backend server for +a specified period. Cookie persistence allows related client +connections, identified by the same cookie in HTTP requests, to be +redirected to the same server.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • persistence_shared (bool or None) – If persistence shared flag is not set in the cookie persistence +profile bound to a virtual server, it defaults to cookie +persistence that is private to each virtual server and is qualified +by the pool. This is accomplished by load balancer inserting a +cookie with name in the format +<name>.<virtual_server_id>.<pool_id>. If persistence shared flag is +set in the cookie persistence profile, in cookie insert mode, +cookie persistence could be shared across multiple virtual servers +that are bound to the same pools. The cookie name would be changed +to <name>.<profile-id>.<pool-id>. If persistence shared flag is not +set in the sourceIp persistence profile bound to a virtual server, +each virtual server that the profile is bound to maintains its own +private persistence table. If persistence shared flag is set in the +sourceIp persistence profile, all virtual servers the profile is +bound to share the same persistence table.
      • +
    +
    PURGE_FULL = 'FULL'
    @@ -13873,11 +45675,45 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • ciphers (list of LbSslCipherInfo) – List of SSL ciphers
      • +
    • protocols (list of LbSslProtocolInfo) – List of SSL protocols
      • +
    +
    -class com.vmware.nsx_policy.model_client.LbSslCipherInfo(cipher=None, is_default=None, is_secure=None)
    +class com.vmware.nsx_policy.model_client.LbSslCipherInfo(cipher=None, cipher_group_labels=None, is_default=None, is_secure=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    SSL cipher

    @@ -13885,6 +45721,65 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    CIPHER_ECDHE_ECDSA_WITH_AES_128_CBC_SHA = 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA'
    @@ -14005,6 +45900,26 @@ names.

    CIPHER_ECDH_RSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384'
    +
    +
    +CIPHER_GROUP_LABELS_BALANCED = 'BALANCED'
    +
    + +
    +
    +CIPHER_GROUP_LABELS_CUSTOM = 'CUSTOM'
    +
    + +
    +
    +CIPHER_GROUP_LABELS_HIGH_COMPATIBILITY = 'HIGH_COMPATIBILITY'
    +
    + +
    +
    +CIPHER_GROUP_LABELS_HIGH_SECURITY = 'HIGH_SECURITY'
    +
    +
    CIPHER_RSA_WITH_3DES_EDE_CBC_SHA = 'TLS_RSA_WITH_3DES_EDE_CBC_SHA'
    @@ -14052,6 +45967,61 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    +
    @@ -14063,6 +46033,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of LbSslProfile) – paginated list of load balancer SSL profiles
      • +
    +
    @@ -14075,6 +46078,29 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    PROTOCOL_SSL_V2 = 'SSL_V2'
    @@ -14111,6 +46137,37 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • bytes_in (long) – Number of bytes in format: int64
      • +
    • bytes_in_rate (float or None) – The average number of inbound bytes per second, the number is +averaged over the last 5 one-second intervals.
      • +
    • bytes_out (long) – Number of bytes out format: int64
      • +
    • bytes_out_rate (float or None) – The average number of outbound bytes per second, the number is +averaged over the last 5 one-second intervals.
      • +
    • current_session_rate (float or None) – The average number of current sessions per second, the number is +averaged over the last 5 one-second intervals.
      • +
    • current_sessions (long) – Number of current sessions format: int64
      • +
    • http_request_rate (float or None) – The average number of http requests per second, the number is +averaged over the last 5 one-second intervals.
      • +
    • http_requests (long or None) – The total number of http requests. format: int64
      • +
    • max_sessions (long) – Number of maximum sessions format: int64
      • +
    • packets_in (long or None) – Number of packets in format: int64
      • +
    • packets_in_rate (float or None) – The average number of inbound packets per second, the number is +averaged over the last 5 one-second intervals.
      • +
    • packets_out (long or None) – Number of packets out format: int64
      • +
    • packets_out_rate (float or None) – The average number of outbound packets per second, the number is +averaged over the last 5 one-second intervals.
      • +
    • source_ip_persistence_entry_size (long or None) – Number of source IP persistence entries format: int64
      • +
    • total_sessions (long) – Number of total sessions format: int64
      • +
    +
    @@ -14125,6 +46182,37 @@ a single port number like 80, or a port range like 1024-1030.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    @@ -14136,6 +46224,96 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • receive (str or None) – Expected data, if specified, can be anywhere in the response and it +has to be a string, regular expressions are not supported.
      • +
    • send (str or None) – If both send and receive are not specified, then just a TCP +connection is established (3-way handshake) to validate server is +healthy, no data is sent.
      • +
    • fall_count (long or None) – num of consecutive checks must fail before marking it down format: +int64
      • +
    • interval (long or None) – the frequency at which the system issues the monitor check (in +second) format: int64
      • +
    • monitor_port (str or None) – If the monitor port is specified, it would override pool member +port setting for healthcheck. A port range is not supported. +format: port-or-range
      • +
    • rise_count (long or None) – num of consecutive checks must pass before marking it up format: +int64
      • +
    • timeout (long or None) – the number of seconds the target has in which to respond to the +monitor request format: int64
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      Load balancers monitor the health of backend servers to ensure +traffic is not black holed. There are two types of healthchecks: +active and passive. Passive healthchecks depend on failures in +actual client traffic (e.g. RST from server in response to a client +connection) to detect that the server or the application is down. +In case of active healthchecks, load balancer itself initiates new +connections (or sends ICMP ping) to the servers periodically to +check their health, completely independent of any data traffic. +Currently, active health monitors are supported for HTTP, HTTPS, +TCP, UDP and ICMP protocols.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    +
    @@ -14155,6 +46333,70 @@ server-side (LbVirtualServer.server_tcp_profile_id).

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • fin_wait2_timeout (long or None) – If the field is not specified, the load balancer will use the +default setting per load balancer service flavor. format: int64
      • +
    • max_syn_retransmissions (long or None) – If the field is not specified, the load balancer will use the +default setting per load balancer service flavor. format: int64
      • +
    • nagle_algorithm_enabled (bool or None) – Setting this option to enable or disable Nagle’s algorithm.
      • +
    • receive_window_size (long or None) – If the field is not specified, the load balancer will use the +default setting per load balancer service flavor. format: int64
      • +
    • transmit_window_size (long or None) – If the field is not specified, the load balancer will use the +default setting per load balancer service flavor. format: int64
      • +
    +
    @@ -14166,6 +46408,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of LbTcpProfile) – Paginated list of load balancer TCP profiles
      • +
    +
    @@ -14177,6 +46452,223 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • receive (str) – Expected data, can be anywhere in the response and it has to be a +string, regular expressions are not supported. UDP healthcheck is +considered failed if there is no server response within the timeout +period.
      • +
    • send (str) – The data to be sent to the monitored server.
      • +
    • fall_count (long or None) – num of consecutive checks must fail before marking it down format: +int64
      • +
    • interval (long or None) – the frequency at which the system issues the monitor check (in +second) format: int64
      • +
    • monitor_port (str or None) – If the monitor port is specified, it would override pool member +port setting for healthcheck. A port range is not supported. +format: port-or-range
      • +
    • rise_count (long or None) – num of consecutive checks must pass before marking it up format: +int64
      • +
    • timeout (long or None) – the number of seconds the target has in which to respond to the +monitor request format: int64
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      Load balancers monitor the health of backend servers to ensure +traffic is not black holed. There are two types of healthchecks: +active and passive. Passive healthchecks depend on failures in +actual client traffic (e.g. RST from server in response to a client +connection) to detect that the server or the application is down. +In case of active healthchecks, load balancer itself initiates new +connections (or sends ICMP ping) to the servers periodically to +check their health, completely independent of any data traffic. +Currently, active health monitors are supported for HTTP, HTTPS, +TCP, UDP and ICMP protocols.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LbVariableAssignmentAction(variable_name=None, variable_value=None, type='LbVariableAssignmentAction')
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    This action is used to create a new variable and assign value to it. One +action can be used to create one variable. To create multiple variables, +multiple actions must be defined. The variables can be used by +LbVariableCondition, etc.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters: +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LbVariableCondition(case_sensitive=None, match_type=None, variable_name=None, variable_value=None, inverse=None, type='LbVariableCondition')
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    This condition is used to match variable’s name and value at all phases. +The variables could be captured from REGEX or assigned by +LbVariableAssignmentAction or system embedded variable. Varialbe_name and +variable_value should be matched at the same time.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters: +
    +
    +
    +MATCH_TYPE_CONTAINS = 'CONTAINS'
    +
    + +
    +
    +MATCH_TYPE_ENDS_WITH = 'ENDS_WITH'
    +
    + +
    +
    +MATCH_TYPE_EQUALS = 'EQUALS'
    +
    + +
    +
    +MATCH_TYPE_REGEX = 'REGEX'
    +
    + +
    +
    +MATCH_TYPE_STARTS_WITH = 'STARTS_WITH'
    +
    +
    @@ -14188,6 +46680,130 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • access_log_enabled (bool or None) – Whether access log is enabled
      • +
    • application_profile_id (str) – The application profile defines the application protocol +characteristics. It is used to influence how load balancing is +performed. Currently, LbFastTCPProfile, LbFastUDPProfile and +LbHttpProfile, etc are supported.
      • +
    • client_ssl_profile_binding (ClientSslProfileBinding or None) – The setting is used when load balancer acts as an SSL server and +terminating the client SSL connection
      • +
    • client_tcp_profile_id (str or None) – Only L7 virtual server could be configured with customized client +side TCP profile.
      • +
    • default_pool_member_port (str or None) – This is a deprecated property, please use +‘default_pool_member_ports’ instead. If default_pool_member_port is +configured and default_pool_member_ports are not specified, both +default_pool_member_port and default_pool_member_ports in response +payload would return the same port value. If both are specified, +default_pool_member_ports setting would take effect with higher +priority. format: port-or-range
      • +
    • default_pool_member_ports (list of str or None) – If default_pool_member_ports are configured, both +default_pool_member_port and default_pool_member_ports in the +response payload would include port settings, notice that the value +of default_pool_member_port is the first element of +default_pool_member_ports. format: port-or-range
      • +
    • enabled (bool or None) – whether the virtual server is enabled
      • +
    • ip_address (str) – virtual server IP address format: ip
      • +
    • ip_protocol (str or None) –

      Possible values are:

      + +
      +
      Assigned Internet Protocol in IP header, TCP, UDP are supported.
      +
      • +
    • max_concurrent_connections (long or None) – To ensure one virtual server does not over consume resources, +affecting other applications hosted on the same LBS, connections to +a virtual server can be capped. If it is not specified, it means +that connections are unlimited. format: int64
      • +
    • max_new_connection_rate (long or None) – To ensure one virtual server does not over consume resources, +connections to a member can be rate limited. If it is not +specified, it means that connection rate is unlimited. format: +int64
      • +
    • persistence_profile_id (str or None) – Persistence profile is used to allow related client connections to +be sent to the same backend server.
      • +
    • pool_id (str or None) – The server pool(LbPool) contains backend servers. Server pool +consists of one or more servers, also referred to as pool members, +that are similarly configured and are running the same application.
      • +
    • port (str or None) – This is a deprecated property, please use ‘ports’ instead. Port +setting could be single port for both L7 mode and L4 mode. For L4 +mode, a single port range is also supported. The port setting could +be a single port or port range such as "80", +"1234-1236". If port is configured and ports are not +specified, both port and ports in response payload would return the +same port value. If both port and ports are configured, ports +setting would take effect with higher priority. format: +port-or-range
      • +
    • ports (list of str or None) – Port setting could be a single port for both L7 mode and L4 mode. +For L4 mode, multiple ports or port ranges are also supported such +as "80", "443", "1234-1236". If ports is +configured, both port and ports in the response payload would +include port settings, notice that the port field value is the +first element of ports. format: port-or-range
      • +
    • rule_ids (list of str or None) – Load balancer rules allow customization of load balancing behavior +using match/action rules. Currently, load balancer rules are +supported for only layer 7 virtual servers with LbHttpProfile.
      • +
    • server_ssl_profile_binding (ServerSslProfileBinding or None) – The setting is used when load balancer acts as an SSL client and +establishing a connection to the backend server.
      • +
    • server_tcp_profile_id (str or None) – Only L7 virtual server could be configured with customized server +side TCP profile.
      • +
    • sorry_pool_id (str or None) – When load balancer can not select a backend server to serve the +request in default pool or pool in rules, the request would be +served by sorry server pool.
      • +
    +
    IP_PROTOCOL_TCP = 'TCP'
    @@ -14209,6 +46825,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of LbVirtualServer) – paginated list of virtual servers
      • +
    +
    @@ -14220,6 +46869,19 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • last_update_timestamp (long or None) – Timestamp when the data was last updated format: int64
      • +
    • statistics (LbStatisticsCounter) – Virtual server statistics counter
      • +
    • virtual_server_id (str) – load balancer virtual server identifier
      • +
    +
    @@ -14231,6 +46893,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of LbVirtualServerStatistics) – paginated statistics list of virtual servers
      • +
    +
    @@ -14242,6 +46937,45 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • last_update_timestamp (long or None) – Timestamp when the data was last updated. format: int64
      • +
    • status (str or None) –

      Possible values are:

      + +

      UP means that all primary members in default pool are in UP status. +For L7 virtual server, if there is no default pool, the virtual +server would be treated as UP. PARTIALLY_UP means that some(not +all) primary members in default pool are in UP status. The size of +these active primary members should be larger than or equal to the +certain number(min_active_members) which is defined in LbPool. When +there are no backup members which are in the UP status, the +number(min_active_members) would be ignored. PRIMARY_DOWN means +that less than certain(min_active_members) primary members in +default pool are in UP status but backup members are in UP status, +the connections would be dispatched to backup members. DOWN means +that all primary and backup members are in DOWN status. DETACHED +means that the virtual server is not bound to any service. DISABLED +means that the admin state of the virtual server is disabled. +UNKOWN means that no status reported from transport-nodes. The +associated load balancer service may be working(or not working).

      +
      • +
    • virtual_server_id (str) – load balancer virtual server identifier
      • +
    +
    STATUS_DETACHED = 'DETACHED'
    @@ -14267,6 +47001,11 @@ names.

    STATUS_PRIMARY_DOWN = 'PRIMARY_DOWN'
    +
    +
    +STATUS_UNKNOWN = 'UNKNOWN'
    +
    +
    STATUS_UP = 'UP'
    @@ -14283,6 +47022,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of LbVirtualServerStatus) – paginated status list of virtual servers
      • +
    +
    @@ -14295,6 +47067,63 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • capacity_type (str or None) –

      Possible values are:

      + +
      +
      license metric
      +

      This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    • description (str or None) – license edition +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • expiry (long or None) – date that license expires format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • features (str or None) – semicolon delimited feature list +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • is_eval (bool or None) – true for evalution license +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • is_expired (bool or None) – whether the license has expired +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • is_mh (bool or None) – multi-hypervisor support +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • license_key (str or None) – license key
      • +
    • product_name (str or None) – product name +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • product_version (str or None) – product version +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • quantity (long or None) – license capacity; 0 for unlimited format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    CAPACITY_TYPE_CPU = 'CPU'
    @@ -14322,6 +47151,41 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of License or None) – Licenses Results +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -14334,6 +47198,38 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -14346,6 +47242,260 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • send_enabled (bool) – Enabled or disabled sending LLDP packets
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • required_capabilities (list of str or None) –
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LoadBalancerAllocationPool(allocation_size=None, allocation_pool_type='LoadBalancerAllocationPool')
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters: +
    +
    +
    +ALLOCATION_SIZE_LARGE = 'LARGE'
    +
    + +
    +
    +ALLOCATION_SIZE_MEDIUM = 'MEDIUM'
    +
    + +
    +
    +ALLOCATION_SIZE_SMALL = 'SMALL'
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LocaleServices(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Site specific configuration of Tier0 in multi-site scenario

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LocaleServicesListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Paged collection of LocaleServices

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of LocaleServices) – LocaleServices results
      • +
    +
    @@ -14357,6 +47507,66 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • attached_logical_port_id (str or None) – id of attached logical port +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • dhcp_profile_id (str) – dhcp profile uuid
      • +
    • ipv4_dhcp_server (IPv4DhcpServer) – dhcp server for ipv4 addresses
      • +
    +
    @@ -14368,6 +47578,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of LogicalDhcpServer) – paginated list of dhcp servers
      • +
    +
    @@ -14379,6 +47622,86 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • address_bindings (list of PacketAddressClassifier or None) – Address bindings for logical port
      • +
    • admin_state (str) –

      Possible values are:

      + +
      +
      Represents Desired state of the logical port
      +
      • +
    • attachment (LogicalPortAttachment or None) – Logical port attachment
      • +
    • extra_configs (list of ExtraConfig or None) – This property could be used for vendor specific configuration in +key value string pairs. Logical port setting will override logical +switch setting if the same key was set on both logical switch and +logical port.
      • +
    • init_state (str or None) –

      Possible values are:

      + +

      Set initial state when a new logical port is created. +‘UNBLOCKED_VLAN’ means new port will be unblocked on traffic in +creation, also VLAN will be set with corresponding logical switch +setting.

      +
      • +
    • logical_switch_id (str) – Id of the Logical switch that this port belongs to.
      • +
    • switching_profile_ids (list of SwitchingProfileTypeIdEntry or None) –
      • +
    +
    ADMIN_STATE_DOWN = 'DOWN'
    @@ -14406,6 +47729,35 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    ATTACHMENT_TYPE_BRIDGEENDPOINT = 'BRIDGEENDPOINT'
    @@ -14448,6 +47800,41 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of LogicalPort or None) – LogicalPort Results +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -14459,6 +47846,22 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • file_name (str or None) – File name set by HTTP server if API returns CSV result as a file.
      • +
    • last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has +never updated the data. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of LogicalPortMacTableCsvEntry or None) –
      • +
    +
    @@ -14470,6 +47873,49 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has +never updated the data. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • logical_port_id (str or None) – The id of the logical port +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of LogicalPortMacTableEntry or None) –
      • +
    • transport_node_id (str or None) – Transport node identifier +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -14481,6 +47927,25 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    MAC_TYPE_LEARNED = 'LEARNED'
    @@ -14502,6 +47967,25 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    MAC_TYPE_LEARNED = 'LEARNED'
    @@ -14523,6 +48007,26 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    @@ -14534,17 +48038,140 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    -class com.vmware.nsx_policy.model_client.LogicalRouter(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, advanced_config=None, edge_cluster_id=None, failover_mode=None, firewall_sections=None, high_availability_mode=None, preferred_edge_cluster_member_index=None, router_type=None)
    +class com.vmware.nsx_policy.model_client.LogicalRouter(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, advanced_config=None, allocation_profile=None, edge_cluster_id=None, edge_cluster_member_indices=None, failover_mode=None, firewall_sections=None, high_availability_mode=None, preferred_edge_cluster_member_index=None, router_type=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • advanced_config (LogicalRouterConfig or None) – Contains config properties for tier0 routers
      • +
    • allocation_profile (EdgeClusterMemberAllocationProfile or None) – Configurations options to auto allocate edge cluster members for +logical router. Auto allocation is supported only for TIER1 and +pick least utilized member post current assignment for next +allocation.
      • +
    • edge_cluster_id (str or None) – Used for tier0 routers
      • +
    • edge_cluster_member_indices (list of long or None) – For stateful services, the logical router should be associated with +edge cluster. For TIER 1 logical router, for manual placement of +service router within the cluster, edge cluster member indices +needs to be provided else same will be auto-allocated. You can +provide maximum two indices for HA ACTIVE_STANDBY. For TIER0 +logical router this property is no use and placement is derived +from logical router uplink or loopback port. format: int64
      • +
    • failover_mode (str or None) –

      Possible values are:

      + +

      Determines the behavior when a logical router instance restarts +after a failure. If set to PREEMPTIVE, the preferred node will take +over, even if it causes another failure. If set to NON_PREEMPTIVE, +then the instance that restarted will remain secondary. This +property must not be populated unless the high_availability_mode +property is set to ACTIVE_STANDBY. If high_availability_mode +property is set to ACTIVE_STANDBY and this property is not +specified then default will be NON_PREEMPTIVE.

      +
      • +
    • firewall_sections (list of ResourceReference or None) – List of Firewall sections related to Logical Router. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • high_availability_mode (str or None) –

      Possible values are:

      + +
      +
      High availability mode
      +
      • +
    • preferred_edge_cluster_member_index (long or None) – Used for tier0 routers only format: int64
      • +
    • router_type (str) –

      Possible values are:

      + +
      +
      Type of Logical Router
      +
      • +
    +
    FAILOVER_MODE_NON_PREEMPTIVE = 'NON_PREEMPTIVE'
    @@ -14591,6 +48218,104 @@ this port.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • enable_netx (bool or None) – Port is exclusively used for N-S service insertion
      • +
    • linked_logical_switch_port_id (ResourceReference or None) – Reference to the logical switch port to connect to
      • +
    • subnets (list of IPSubnet) – Logical router port subnets
      • +
    • urpf_mode (str or None) –

      Possible values are:

      + +
      +
      Unicast Reverse Path Forwarding mode
      +
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      LogicalRouterUpLinkPort is allowed only on TIER0 logical router. It +is the north facing port of the logical router. +LogicalRouterLinkPortOnTIER0 is allowed only on TIER0 logical +router. This is the port where the LogicalRouterLinkPortOnTIER1 of +TIER1 logical router connects to. LogicalRouterLinkPortOnTIER1 is +allowed only on TIER1 logical router. This is the port using which +the user connected to TIER1 logical router for upwards connectivity +via TIER0 logical router. Connect this port to the +LogicalRouterLinkPortOnTIER0 of the TIER0 logical router. +LogicalRouterDownLinkPort is for the connected subnets on the +logical router. LogicalRouterLoopbackPort is a loopback port for +logical router component which is placed on chosen edge cluster +member. LogicalRouterIPTunnelPort is a IPSec VPN tunnel port +created on logical router when route based VPN session configured. +LogicalRouterCentralizedServicePort is allowed only on +Active/Standby TIER0 and TIER1 logical router. Port can be +connected to VLAN or overlay logical switch. Unlike downlink port +it does not participate in distributed routing and hosted on all +edge cluster members associated with logical router. Stateful +services can be applied on this port.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • logical_router_id (str) – Identifier for logical router on which this port is created
      • +
    • service_bindings (list of ServiceBinding or None) – Service Bindings
      • +
    +
    URPF_MODE_NONE = 'NONE'
    @@ -14612,18 +48337,30 @@ names.

    The arguments are used to initialize data attributes with the same names.

    -
    - -
    -
    -class com.vmware.nsx_policy.model_client.LogicalRouterDeleteRequestParameters(force=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    LogicalRouter delete request parameters

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    + +++ + + + +
    Parameters:
      +
    • external_transit_networks (list of str or None) – CIDR block defining tier0 to tier1 links format: ipv4-cidr-block
      • +
    • ha_vip_configs (list of HaVipConfig or None) – This configuration can be defined only for Active-Standby +LogicalRouter to provide | redundancy. For mulitple uplink ports, +multiple HaVipConfigs must be defined | and each config will pair +exactly two uplink ports. The VIP will move and will | always be +owned by the Active node. Note - when HaVipConfig[s] are defined, | +configuring dynamic-routing is disallowed.
      • +
    • internal_transit_network (str or None) – CIDR block defining Service router to distributed router links +format: ipv4-cidr-block
      • +
    • transport_zone_id (str or None) – Transport zone of the logical router. If specified then all +downlink switches should belong to this transport zone and an error +will be thrown if transport zone of the downlink switch doesn’t +match with this transport zone. All internal and external transit +switches will be created in this transport zone.
      • +
    +
    @@ -14635,6 +48372,106 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • linked_logical_switch_port_id (ResourceReference or None) – Reference to the logical switch port to connect to
      • +
    • mac_address (str or None) – MAC address +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • subnets (list of IPSubnet) – Logical router port subnets
      • +
    • urpf_mode (str or None) –

      Possible values are:

      + +
      +
      Unicast Reverse Path Forwarding mode
      +
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      LogicalRouterUpLinkPort is allowed only on TIER0 logical router. It +is the north facing port of the logical router. +LogicalRouterLinkPortOnTIER0 is allowed only on TIER0 logical +router. This is the port where the LogicalRouterLinkPortOnTIER1 of +TIER1 logical router connects to. LogicalRouterLinkPortOnTIER1 is +allowed only on TIER1 logical router. This is the port using which +the user connected to TIER1 logical router for upwards connectivity +via TIER0 logical router. Connect this port to the +LogicalRouterLinkPortOnTIER0 of the TIER0 logical router. +LogicalRouterDownLinkPort is for the connected subnets on the +logical router. LogicalRouterLoopbackPort is a loopback port for +logical router component which is placed on chosen edge cluster +member. LogicalRouterIPTunnelPort is a IPSec VPN tunnel port +created on logical router when route based VPN session configured. +LogicalRouterCentralizedServicePort is allowed only on +Active/Standby TIER0 and TIER1 logical router. Port can be +connected to VLAN or overlay logical switch. Unlike downlink port +it does not participate in distributed routing and hosted on all +edge cluster members associated with logical router. Stateful +services can be applied on this port.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • logical_router_id (str) – Identifier for logical router on which this port is created
      • +
    • service_bindings (list of ServiceBinding or None) – Service Bindings
      • +
    +
    URPF_MODE_NONE = 'NONE'
    @@ -14657,6 +48494,109 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • admin_state (str or None) –

      Possible values are:

      + +
      +
      Admin state of port.
      +

      This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    • subnets (list of IPSubnet or None) – Tunnel port subnets. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • vpn_session_id (str or None) – Associated VPN session identifier. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      LogicalRouterUpLinkPort is allowed only on TIER0 logical router. It +is the north facing port of the logical router. +LogicalRouterLinkPortOnTIER0 is allowed only on TIER0 logical +router. This is the port where the LogicalRouterLinkPortOnTIER1 of +TIER1 logical router connects to. LogicalRouterLinkPortOnTIER1 is +allowed only on TIER1 logical router. This is the port using which +the user connected to TIER1 logical router for upwards connectivity +via TIER0 logical router. Connect this port to the +LogicalRouterLinkPortOnTIER0 of the TIER0 logical router. +LogicalRouterDownLinkPort is for the connected subnets on the +logical router. LogicalRouterLoopbackPort is a loopback port for +logical router component which is placed on chosen edge cluster +member. LogicalRouterIPTunnelPort is a IPSec VPN tunnel port +created on logical router when route based VPN session configured. +LogicalRouterCentralizedServicePort is allowed only on +Active/Standby TIER0 and TIER1 logical router. Port can be +connected to VLAN or overlay logical switch. Unlike downlink port +it does not participate in distributed routing and hosted on all +edge cluster members associated with logical router. Stateful +services can be applied on this port.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • logical_router_id (str) – Identifier for logical router on which this port is created
      • +
    • service_bindings (list of ServiceBinding or None) – Service Bindings
      • +
    +
    ADMIN_STATE_DOWN = 'DOWN'
    @@ -14681,6 +48621,103 @@ LogicalRouterLinkPortOnTIER1 on TIER1 logical router.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • linked_logical_router_port_id (str or None) – Identifier of connected LogicalRouterLinkPortOnTIER1 of TIER1 +logical router +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • mac_address (str or None) – MAC address +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • subnets (list of IPSubnet or None) – Logical router port subnets +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      LogicalRouterUpLinkPort is allowed only on TIER0 logical router. It +is the north facing port of the logical router. +LogicalRouterLinkPortOnTIER0 is allowed only on TIER0 logical +router. This is the port where the LogicalRouterLinkPortOnTIER1 of +TIER1 logical router connects to. LogicalRouterLinkPortOnTIER1 is +allowed only on TIER1 logical router. This is the port using which +the user connected to TIER1 logical router for upwards connectivity +via TIER0 logical router. Connect this port to the +LogicalRouterLinkPortOnTIER0 of the TIER0 logical router. +LogicalRouterDownLinkPort is for the connected subnets on the +logical router. LogicalRouterLoopbackPort is a loopback port for +logical router component which is placed on chosen edge cluster +member. LogicalRouterIPTunnelPort is a IPSec VPN tunnel port +created on logical router when route based VPN session configured. +LogicalRouterCentralizedServicePort is allowed only on +Active/Standby TIER0 and TIER1 logical router. Port can be +connected to VLAN or overlay logical switch. Unlike downlink port +it does not participate in distributed routing and hosted on all +edge cluster members associated with logical router. Stateful +services can be applied on this port.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • logical_router_id (str) – Identifier for logical router on which this port is created
      • +
    • service_bindings (list of ServiceBinding or None) – Service Bindings
      • +
    +
    @@ -14695,6 +48732,103 @@ linked_logical_router_port_id on the port on TIER1 logical router.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • edge_cluster_member_index (list of long or None) – Please use logical router API to pass edge cluster members indexes +manually. format: int64
      • +
    • linked_logical_router_port_id (ResourceReference or None) – Reference of LogicalRouterLinkPortOnTIER0 of TIER0 logical router +to connect this TIER1 logical router outwards.
      • +
    • mac_address (str or None) – MAC address +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • subnets (list of IPSubnet or None) – Logical router port subnets +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      LogicalRouterUpLinkPort is allowed only on TIER0 logical router. It +is the north facing port of the logical router. +LogicalRouterLinkPortOnTIER0 is allowed only on TIER0 logical +router. This is the port where the LogicalRouterLinkPortOnTIER1 of +TIER1 logical router connects to. LogicalRouterLinkPortOnTIER1 is +allowed only on TIER1 logical router. This is the port using which +the user connected to TIER1 logical router for upwards connectivity +via TIER0 logical router. Connect this port to the +LogicalRouterLinkPortOnTIER0 of the TIER0 logical router. +LogicalRouterDownLinkPort is for the connected subnets on the +logical router. LogicalRouterLoopbackPort is a loopback port for +logical router component which is placed on chosen edge cluster +member. LogicalRouterIPTunnelPort is a IPSec VPN tunnel port +created on logical router when route based VPN session configured. +LogicalRouterCentralizedServicePort is allowed only on +Active/Standby TIER0 and TIER1 logical router. Port can be +connected to VLAN or overlay logical switch. Unlike downlink port +it does not participate in distributed routing and hosted on all +edge cluster members associated with logical router. Stateful +services can be applied on this port.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • logical_router_id (str) – Identifier for logical router on which this port is created
      • +
    • service_bindings (list of ServiceBinding or None) – Service Bindings
      • +
    +
    @@ -14706,6 +48840,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of LogicalRouter) – Logical router list results
      • +
    +
    @@ -14717,6 +48884,95 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • edge_cluster_member_index (list of long) – Member index of the edge node on the cluster format: int64
      • +
    • subnets (list of IPSubnet) – Loopback port subnets
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      LogicalRouterUpLinkPort is allowed only on TIER0 logical router. It +is the north facing port of the logical router. +LogicalRouterLinkPortOnTIER0 is allowed only on TIER0 logical +router. This is the port where the LogicalRouterLinkPortOnTIER1 of +TIER1 logical router connects to. LogicalRouterLinkPortOnTIER1 is +allowed only on TIER1 logical router. This is the port using which +the user connected to TIER1 logical router for upwards connectivity +via TIER0 logical router. Connect this port to the +LogicalRouterLinkPortOnTIER0 of the TIER0 logical router. +LogicalRouterDownLinkPort is for the connected subnets on the +logical router. LogicalRouterLoopbackPort is a loopback port for +logical router component which is placed on chosen edge cluster +member. LogicalRouterIPTunnelPort is a IPSec VPN tunnel port +created on logical router when route based VPN session configured. +LogicalRouterCentralizedServicePort is allowed only on +Active/Standby TIER0 and TIER1 logical router. Port can be +connected to VLAN or overlay logical switch. Unlike downlink port +it does not participate in distributed routing and hosted on all +edge cluster members associated with logical router. Stateful +services can be applied on this port.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • logical_router_id (str) – Identifier for logical router on which this port is created
      • +
    • service_bindings (list of ServiceBinding or None) – Service Bindings
      • +
    +
    @@ -14728,6 +48984,93 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      LogicalRouterUpLinkPort is allowed only on TIER0 logical router. It +is the north facing port of the logical router. +LogicalRouterLinkPortOnTIER0 is allowed only on TIER0 logical +router. This is the port where the LogicalRouterLinkPortOnTIER1 of +TIER1 logical router connects to. LogicalRouterLinkPortOnTIER1 is +allowed only on TIER1 logical router. This is the port using which +the user connected to TIER1 logical router for upwards connectivity +via TIER0 logical router. Connect this port to the +LogicalRouterLinkPortOnTIER0 of the TIER0 logical router. +LogicalRouterDownLinkPort is for the connected subnets on the +logical router. LogicalRouterLoopbackPort is a loopback port for +logical router component which is placed on chosen edge cluster +member. LogicalRouterIPTunnelPort is a IPSec VPN tunnel port +created on logical router when route based VPN session configured. +LogicalRouterCentralizedServicePort is allowed only on +Active/Standby TIER0 and TIER1 logical router. Port can be +connected to VLAN or overlay logical switch. Unlike downlink port +it does not participate in distributed routing and hosted on all +edge cluster members associated with logical router. Stateful +services can be applied on this port.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • logical_router_id (str) – Identifier for logical router on which this port is created
      • +
    • service_bindings (list of ServiceBinding or None) – Service Bindings
      • +
    +
    RESOURCE_TYPE_LOGICALROUTERCENTRALIZEDSERVICEPORT = 'LogicalRouterCentralizedServicePort'
    @@ -14774,6 +49117,18 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • ip (str) – The IP address format: ip
      • +
    • mac_address (str) – The MAC address
      • +
    +
    @@ -14785,6 +49140,18 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • ip (str) – The IP address format: ip
      • +
    • mac_address (str) – The MAC address
      • +
    +
    @@ -14796,6 +49163,44 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has +never updated the data. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • logical_router_port_id (str) – The ID of the logical router port
      • +
    • results (list of LogicalRouterPortArpEntry or None) –
      • +
    +
    @@ -14807,18 +49212,141 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • file_name (str or None) – File name set by HTTP server if API returns CSV result as a file.
      • +
    • last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has +never updated the data. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of LogicalRouterPortArpCsvRecord or None) –
      • +
    +
    -
    -class com.vmware.nsx_policy.model_client.LogicalRouterPortDeleteRequestParameters(force=None)
    +
    +class com.vmware.nsx_policy.model_client.LogicalRouterPortElement(element_id=None, elements=None, resource_name=None, resource_type=None, mac_address=None, subnets=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    LogicalRouterPort delete request parameters

    +

    Logical router port element extends from Element class. This class contains +logical port information of logical router.

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    +
    +
    +RESOURCE_TYPE_EDGENODEELEMENT = 'EdgeNodeElement'
    +
    + +
    +
    +RESOURCE_TYPE_GROUPELEMENT = 'GroupElement'
    +
    + +
    +
    +RESOURCE_TYPE_HOSTNODEELEMENT = 'HostNodeElement'
    +
    + +
    +
    +RESOURCE_TYPE_LBVIRTUALSERVERELEMENT = 'LBVirtualServerElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOADBALANCERSERVICEELEMENT = 'LoadBalancerServiceElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALROUTERPORTELEMENT = 'LogicalRouterPortElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALSWITCHELEMENT = 'LogicalSwitchElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALSWITCHPORTELEMENT = 'LogicalSwitchPortElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALT0ROUTERELEMENT = 'LogicalT0RouterElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALT1ROUTERELEMENT = 'LogicalT1RouterElement'
    +
    + +
    +
    +RESOURCE_TYPE_PROCESSELEMENT = 'ProcessElement'
    +
    + +
    +
    +RESOURCE_TYPE_VIRTUALNETWORKINTERFACEELEMENT = 'VirtualNetworkInterfaceElement'
    +
    + +
    +
    +RESOURCE_TYPE_VMELEMENT = 'VMElement'
    +
    +
    @@ -14830,6 +49358,44 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of vmware.vapi.struct.VapiStruct) – Logical router port list results +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +LogicalRouterPort. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in LogicalRouterPort.
      • +
    +
    @@ -14841,6 +49407,23 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • admin_distance (long or None) – The admin distance of the next hop format: int64
      • +
    • logical_router_port_id (str or None) – The id of the logical router port which is used as the next hop
      • +
    • lr_component_id (str or None) – Logical router component(Service Router/Distributed Router) id
      • +
    • lr_component_type (str or None) – Logical router component(Service Router/Distributed Router) type
      • +
    • network (str) – CIDR network address format: ipv4-cidr-block
      • +
    • next_hop (str or None) – The IP of the next hop format: ip
      • +
    • route_type (str) – Route type (USER, CONNECTED, NSX_INTERNAL,..)
      • +
    +
    @@ -14852,6 +49435,23 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • admin_distance (long or None) – The admin distance of the next hop format: int64
      • +
    • logical_router_port_id (str or None) – The id of the logical router port which is used as the next hop
      • +
    • lr_component_id (str or None) – Logical router component(Service Router/Distributed Router) id
      • +
    • lr_component_type (str or None) – Logical router component(Service Router/Distributed Router) type
      • +
    • network (str) – CIDR network address format: ipv4-cidr-block
      • +
    • next_hop (str or None) – The IP address of the next hop format: ip
      • +
    • route_type (str) – Route type (USER, CONNECTED, NSX_INTERNAL,..)
      • +
    +
    @@ -14863,6 +49463,47 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has +never updated the data. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • logical_router_id (str) – The id of the logical router
      • +
    • logical_router_name (str or None) – Name of the logical router +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of LogicalRouterRouteEntry or None) –
      • +
    +
    @@ -14874,6 +49515,22 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • file_name (str or None) – File name set by HTTP server if API returns CSV result as a file.
      • +
    • last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has +never updated the data. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of LogicalRouterRouteCsvRecord or None) –
      • +
    +
    @@ -14885,6 +49542,109 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • edge_cluster_member_index (list of long) – Member index of the edge node on the cluster format: int64
      • +
    • linked_logical_switch_port_id (ResourceReference or None) – Reference to the logical switch port to connect to
      • +
    • mac_address (str or None) – MAC address +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • mtu (long or None) – Maximum transmission unit specifies the size of the largest packet +that a network protocol can transmit. format: int64
      • +
    • subnets (list of IPSubnet) – Logical router port subnets
      • +
    • urpf_mode (str or None) –

      Possible values are:

      + +
      +
      Unicast Reverse Path Forwarding mode
      +
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      LogicalRouterUpLinkPort is allowed only on TIER0 logical router. It +is the north facing port of the logical router. +LogicalRouterLinkPortOnTIER0 is allowed only on TIER0 logical +router. This is the port where the LogicalRouterLinkPortOnTIER1 of +TIER1 logical router connects to. LogicalRouterLinkPortOnTIER1 is +allowed only on TIER1 logical router. This is the port using which +the user connected to TIER1 logical router for upwards connectivity +via TIER0 logical router. Connect this port to the +LogicalRouterLinkPortOnTIER0 of the TIER0 logical router. +LogicalRouterDownLinkPort is for the connected subnets on the +logical router. LogicalRouterLoopbackPort is a loopback port for +logical router component which is placed on chosen edge cluster +member. LogicalRouterIPTunnelPort is a IPSec VPN tunnel port +created on logical router when route based VPN session configured. +LogicalRouterCentralizedServicePort is allowed only on +Active/Standby TIER0 and TIER1 logical router. Port can be +connected to VLAN or overlay logical switch. Unlike downlink port +it does not participate in distributed routing and hosted on all +edge cluster members associated with logical router. Stateful +services can be applied on this port.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • logical_router_id (str) – Identifier for logical router on which this port is created
      • +
    • service_bindings (list of ServiceBinding or None) – Service Bindings
      • +
    +
    URPF_MODE_NONE = 'NONE'
    @@ -14906,6 +49666,68 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      +
      Resource type of the logical service
      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • dhcp_relay_profile_id (str) – dhcp relay profile referenced by the dhcp relay service
      • +
    +
    RESOURCE_TYPE_DHCPRELAYSERVICE = 'DhcpRelayService'
    @@ -14922,6 +49744,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of LogicalService) – Logical router service list results
      • +
    +
    @@ -14933,6 +49788,100 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • address_bindings (list of PacketAddressClassifier or None) – Address bindings for the Logical switch
      • +
    • admin_state (str) –

      Possible values are:

      + +
      +
      Represents Desired state of the Logical Switch
      +
      • +
    • extra_configs (list of ExtraConfig or None) – This property could be used for vendor specific configuration in +key value string pairs, the setting in extra_configs will be +automatically inheritted by logical ports in the logical switch.
      • +
    • ip_pool_id (str or None) – IP pool id that associated with a LogicalSwitch.
      • +
    • mac_pool_id (str or None) – Mac pool id that associated with a LogicalSwitch.
      • +
    • replication_mode (str or None) –

      Possible values are:

      + +
      +
      Replication mode of the Logical Switch
      +
      • +
    • switching_profile_ids (list of SwitchingProfileTypeIdEntry or None) –
      • +
    • transport_zone_id (str) – Id of the TransportZone to which this LogicalSwitch is associated
      • +
    • uplink_teaming_policy_name (str or None) – This name has to be one of the switching uplink teaming policy +names listed inside the logical switch’s TransportZone. If this +field is not specified, the logical switch will not have a teaming +policy associated with it and the host switch’s default teaming +policy will be used.
      • +
    • vlan (long or None) – This property is dedicated to VLAN based network, to set VLAN of +logical network. It is mutually exclusive with ‘vlan_trunk_spec’. +format: int64
      • +
    • vlan_trunk_spec (VlanTrunkSpec or None) – This property is used for VLAN trunk specification of logical +switch. It’s mutually exclusive with ‘vlan’. Also it could be set +to do guest VLAN tagging in overlay network.
      • +
    • vni (long or None) – Only for OVERLAY network. A VNI will be auto-allocated from the +default VNI pool if not given; otherwise the given VNI has to be +inside the default pool and not used by any other LogicalSwitch. +format: int32
      • +
    +
    ADMIN_STATE_DOWN = 'DOWN'
    @@ -14966,16 +49915,80 @@ information related to the logical switch.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    +
    +
    +RESOURCE_TYPE_EDGENODEELEMENT = 'EdgeNodeElement'
    +
    +
    RESOURCE_TYPE_GROUPELEMENT = 'GroupElement'
    +
    +
    +RESOURCE_TYPE_HOSTNODEELEMENT = 'HostNodeElement'
    +
    + +
    +
    +RESOURCE_TYPE_LBVIRTUALSERVERELEMENT = 'LBVirtualServerElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOADBALANCERSERVICEELEMENT = 'LoadBalancerServiceElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALROUTERPORTELEMENT = 'LogicalRouterPortElement'
    +
    +
    RESOURCE_TYPE_LOGICALSWITCHELEMENT = 'LogicalSwitchElement'
    +
    +
    +RESOURCE_TYPE_LOGICALSWITCHPORTELEMENT = 'LogicalSwitchPortElement'
    +
    +
    RESOURCE_TYPE_LOGICALT0ROUTERELEMENT = 'LogicalT0RouterElement'
    @@ -14991,6 +50004,11 @@ names.

    RESOURCE_TYPE_PROCESSELEMENT = 'ProcessElement'
    +
    +
    +RESOURCE_TYPE_VIRTUALNETWORKINTERFACEELEMENT = 'VirtualNetworkInterfaceElement'
    +
    +
    RESOURCE_TYPE_VMELEMENT = 'VMElement'
    @@ -15008,6 +50026,41 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of LogicalSwitch or None) – Logical Switch Results +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -15019,6 +50072,158 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.LogicalSwitchPortElement(element_id=None, elements=None, resource_name=None, resource_type=None, ip_addresses=None, mac_address=None, rx_bytes=None, rx_packets=None, tx_bytes=None, tx_packets=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Logical switch port element extends from Element class. This class contains +logical port information of a logical switch.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters: +
    +
    +
    +RESOURCE_TYPE_EDGENODEELEMENT = 'EdgeNodeElement'
    +
    + +
    +
    +RESOURCE_TYPE_GROUPELEMENT = 'GroupElement'
    +
    + +
    +
    +RESOURCE_TYPE_HOSTNODEELEMENT = 'HostNodeElement'
    +
    + +
    +
    +RESOURCE_TYPE_LBVIRTUALSERVERELEMENT = 'LBVirtualServerElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOADBALANCERSERVICEELEMENT = 'LoadBalancerServiceElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALROUTERPORTELEMENT = 'LogicalRouterPortElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALSWITCHELEMENT = 'LogicalSwitchElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALSWITCHPORTELEMENT = 'LogicalSwitchPortElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALT0ROUTERELEMENT = 'LogicalT0RouterElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALT1ROUTERELEMENT = 'LogicalT1RouterElement'
    +
    + +
    +
    +RESOURCE_TYPE_PROCESSELEMENT = 'ProcessElement'
    +
    + +
    +
    +RESOURCE_TYPE_VIRTUALNETWORKINTERFACEELEMENT = 'VirtualNetworkInterfaceElement'
    +
    + +
    +
    +RESOURCE_TYPE_VMELEMENT = 'VMElement'
    +
    +
    @@ -15030,6 +50235,43 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    STATE_FAILED = 'failed'
    @@ -15077,6 +50319,41 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of LogicalSwitchState or None) – Logical Switch State Results +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -15088,6 +50365,22 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • logical_switch_id (str or None) – Unique ID identifying the the Logical Switch +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • num_logical_ports (long or None) – Count of Logical Ports belonging to this switch format: int32 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -15100,11 +50393,46 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of LogicalSwitchStatus or None) – LogicalSwitchStatus Results +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    -class com.vmware.nsx_policy.model_client.LogicalT0RouterElement(element_id=None, elements=None, resource_name=None, resource_type=None)
    +class com.vmware.nsx_policy.model_client.LogicalT0RouterElement(element_id=None, elements=None, resource_name=None, resource_type=None, linking_outside=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    Logical T0 router element extends from Element class. This class contains the information related to logical T0 router.

    @@ -15113,16 +50441,84 @@ the information related to logical T0 router.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    +
    +
    +RESOURCE_TYPE_EDGENODEELEMENT = 'EdgeNodeElement'
    +
    +
    RESOURCE_TYPE_GROUPELEMENT = 'GroupElement'
    +
    +
    +RESOURCE_TYPE_HOSTNODEELEMENT = 'HostNodeElement'
    +
    + +
    +
    +RESOURCE_TYPE_LBVIRTUALSERVERELEMENT = 'LBVirtualServerElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOADBALANCERSERVICEELEMENT = 'LoadBalancerServiceElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALROUTERPORTELEMENT = 'LogicalRouterPortElement'
    +
    +
    RESOURCE_TYPE_LOGICALSWITCHELEMENT = 'LogicalSwitchElement'
    +
    +
    +RESOURCE_TYPE_LOGICALSWITCHPORTELEMENT = 'LogicalSwitchPortElement'
    +
    +
    RESOURCE_TYPE_LOGICALT0ROUTERELEMENT = 'LogicalT0RouterElement'
    @@ -15138,6 +50534,11 @@ names.

    RESOURCE_TYPE_PROCESSELEMENT = 'ProcessElement'
    +
    +
    +RESOURCE_TYPE_VIRTUALNETWORKINTERFACEELEMENT = 'VirtualNetworkInterfaceElement'
    +
    +
    RESOURCE_TYPE_VMELEMENT = 'VMElement'
    @@ -15156,16 +50557,81 @@ the information related to logical T1 router.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    +
    +
    +RESOURCE_TYPE_EDGENODEELEMENT = 'EdgeNodeElement'
    +
    +
    RESOURCE_TYPE_GROUPELEMENT = 'GroupElement'
    +
    +
    +RESOURCE_TYPE_HOSTNODEELEMENT = 'HostNodeElement'
    +
    + +
    +
    +RESOURCE_TYPE_LBVIRTUALSERVERELEMENT = 'LBVirtualServerElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOADBALANCERSERVICEELEMENT = 'LoadBalancerServiceElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALROUTERPORTELEMENT = 'LogicalRouterPortElement'
    +
    +
    RESOURCE_TYPE_LOGICALSWITCHELEMENT = 'LogicalSwitchElement'
    +
    +
    +RESOURCE_TYPE_LOGICALSWITCHPORTELEMENT = 'LogicalSwitchPortElement'
    +
    +
    RESOURCE_TYPE_LOGICALT0ROUTERELEMENT = 'LogicalT0RouterElement'
    @@ -15181,6 +50647,11 @@ names.

    RESOURCE_TYPE_PROCESSELEMENT = 'ProcessElement'
    +
    +
    +RESOURCE_TYPE_VIRTUALNETWORKINTERFACEELEMENT = 'VirtualNetworkInterfaceElement'
    +
    +
    RESOURCE_TYPE_VMELEMENT = 'VMElement'
    @@ -15198,6 +50669,15 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:credential_type (str) – Possible values are ‘UsernamePasswordLoginCredential’, +‘VerifiableAsymmetricLoginCredential’.
    @@ -15210,6 +50690,33 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • mac_address (str) – A MAC address. Must be 6 pairs of hexadecimal digits, upper or +lower case, separated by colons or dashes. Examples: +01:23:45:67:89:ab, 01-23-45-67-89-AB.
      • +
    +
    @@ -15222,6 +50729,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of MACAddressElement) – MAC address element list
      • +
    +
    @@ -15236,18 +50776,62 @@ as members of NSGroups.

    The arguments are used to initialize data attributes with the same names.

    -
    - -
    -
    -class com.vmware.nsx_policy.model_client.MACSetDeleteRequestParameters(force=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    MACSet delete request parameters

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • mac_addresses (list of str or None) – MAC addresses
      • +
    +
    @@ -15259,6 +50843,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of MACSet) – Paged collection of MACSets
      • +
    +
    @@ -15270,6 +50887,22 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • file_name (str or None) – File name set by HTTP server if API returns CSV result as a file.
      • +
    • last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has +never updated the data. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of MacTableCsvRecord or None) –
      • +
    +
    @@ -15281,6 +50914,49 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has +never updated the data. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • logical_switch_id (str or None) – The id of the logical Switch +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of MacTableEntry or None) –
      • +
    • transport_node_id (str or None) – Transport node identifier +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -15293,6 +50969,31 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • aging_time (long or None) – Aging time in sec for learned MAC address format: int32 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • enabled (bool) – Allowing source MAC address learning
      • +
    • limit (long or None) – The maximum number of MAC addresses that can be learned on this +port format: int32
      • +
    • limit_policy (str or None) –

      Possible values are:

      + +
      +
      The policy after MAC Limit is exceeded
      +
      • +
    • unicast_flooding_allowed (bool or None) – Allowing flooding for unlearned MAC for ingress traffic
      • +
    +
    LIMIT_POLICY_ALLOW = 'ALLOW'
    @@ -15314,6 +51015,64 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • mac_change_allowed (bool or None) – Allowing source MAC address change
      • +
    • mac_learning (MacLearningSpec or None) – MAC learning configuration
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • required_capabilities (list of str or None) –
      • +
    +
    @@ -15326,6 +51085,62 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • ranges (list of MacRange) – Array of ranges for MAC addresses
      • +
    +
    @@ -15337,6 +51152,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of MacPool) – MAC pool list results
      • +
    +
    @@ -15349,6 +51197,18 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • end (str) – End value for MAC address range
      • +
    • start (str) – Start value for MAC address range
      • +
    +
    @@ -15360,6 +51220,19 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • mac_address (str) – The MAC address
      • +
    • vtep_ip (str or None) – The virtual tunnel endpoint IP address format: ip
      • +
    • vtep_mac_address (str or None) – The virtual tunnel endpoint MAC address
      • +
    +
    @@ -15371,6 +51244,19 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • mac_address (str) – The MAC address
      • +
    • vtep_ip (str or None) – The virtual tunnel endpoint IP address format: ip
      • +
    • vtep_mac_address (str or None) – The virtual tunnel endpoint MAC address
      • +
    +
    @@ -15383,6 +51269,61 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    +
    @@ -15394,6 +51335,24 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:mgmt_cluster_status (str or None) –

    Possible values are:

    + +
    +
    Status of this node’s connection to the management cluster
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    MGMT_CLUSTER_STATUS_CONNECTED = 'CONNECTED'
    @@ -15420,6 +51379,31 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    TYPE_CONTROLLERCLUSTERROLECONFIG = 'ControllerClusterRoleConfig'
    @@ -15441,6 +51425,38 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    STATUS_INITIALIZING = 'INITIALIZING'
    @@ -15472,6 +51488,32 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • publish_fqdns (bool) – True if Management nodes publish their fqdns(instead of default IP +addresses) across NSX for its reachability.
      • +
    +
    @@ -15483,6 +51525,30 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • node_interface_properties (list of NodeInterfaceProperties or None) – Array of Node interface statistic properties +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • node_interface_statistics (list of NodeInterfaceStatisticsProperties or None) – Array of Node network interface statistic properties +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • node_status (ClusterNodeStatus or None) –
      • +
    • node_status_properties (list of NodeStatusProperties or None) – Time series of the node’s system properties
      • +
    • role_config (ManagementClusterRoleConfig or None) –
      • +
    • transport_nodes_connected (long or None) –
      • +
    +
    @@ -15495,17 +51561,130 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • mgmt_cluster_listen_ip_address (str or None) – The IP address of MP node +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • uuid (str or None) – Management plane node UUID +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    -class com.vmware.nsx_policy.model_client.MetadataProxy(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, attached_logical_port_id=None, edge_cluster_id=None, edge_cluster_member_indexes=None, metadata_server_ca_ids=None, metadata_server_url=None, secret=None)
    +class com.vmware.nsx_policy.model_client.MetadataProxy(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, attached_logical_port_id=None, crypto_protocols=None, edge_cluster_id=None, edge_cluster_member_indexes=None, metadata_server_ca_ids=None, metadata_server_url=None, secret=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • attached_logical_port_id (str or None) – id of attached logical port +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • crypto_protocols (list of str or None) –

      Possible values are:

      + +

      The cryptographic protocols listed here are supported by the +metadata proxy. The TLSv1.1 and TLSv1.2 are supported by default.

      +
      • +
    • edge_cluster_id (str) – edge cluster uuid
      • +
    • edge_cluster_member_indexes (list of long or None) – If none is provided, the NSX will auto-select two edge-nodes from +the given edge cluster. If user provides only one edge node, there +will be no HA support. format: int64
      • +
    • metadata_server_ca_ids (list of str or None) – The CAs referenced here must be uploaded to the truststore using +the API POST /api/v1/trust-management/certificates?action=import. +User needs to ensure a correct CA for this metedata server is used. +The REST API can not detect a wrong CA which was used to verify a +different server. If the Metadata Proxy reports an ERROR or +NO_BACKUP status, user can check the metadata proxy log at +transport node for a possible CA issue.
      • +
    • metadata_server_url (str) – The URL in format scheme://host:port/path. Please note, the scheme +supports only http and https as of now, port supports range 3000 - +9000, inclusive.
      • +
    • secret (str or None) – secret to access metadata server
      • +
    +
    +
    +
    +CRYPTO_PROTOCOLS_V1 = 'TLS_V1'
    +
    + +
    +
    +CRYPTO_PROTOCOLS_V1_1 = 'TLS_V1_1'
    +
    + +
    +
    +CRYPTO_PROTOCOLS_V1_2 = 'TLS_V1_2'
    +
    +
    @@ -15517,6 +51696,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of MetadataProxy) – paginated list of metadata proxies
      • +
    +
    @@ -15528,6 +51740,24 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:connectivity_status (str or None) –

    Possible values are:

    + +
    +
    Indicates the controller node’s MP channel connectivity status
    +

    This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

    +
    CONNECTIVITY_STATUS_CONNECTED = 'CONNECTED'
    @@ -15554,6 +51784,22 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:resource_type (str) –

    Possible values are:

    + +
    +
    Resource types of mirror destination
    +
    RESOURCE_TYPE_IPMIRRORDESTINATION = 'IPMirrorDestination'
    @@ -15580,6 +51826,23 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:resource_type (str) –

    Possible values are:

    + +
    +
    Resource types of mirror source
    +
    RESOURCE_TYPE_LOGICALPORTMIRRORSOURCE = 'LogicalPortMirrorSource'
    @@ -15611,6 +51874,24 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • day_of_month (long) – Day of month on which data will be collected. Specify a value +between 1 through 31. format: int64
      • +
    • hour_of_day (long) – Hour at which data will be collected. Specify a value between 0 +through 23. format: int64
      • +
    • minutes (long or None) – Minute at which data will be collected. Specify a value between 0 +through 59. format: int64
      • +
    • frequency_type (str) – Specify one of DailyTelemetrySchedule, WeeklyTelemetrySchedule, or +MonthlyTelemetrySchedule.
      • +
    +
    @@ -15623,6 +51904,25 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • account_name (str or None) – Account name for the messaging client. Identifies the client on the +management plane message bus.
      • +
    • certificate (str or None) – Messaging client’s certificate. Used to authenticate to the control +plane messaging endpoint.
      • +
    • shared_secret (str or None) – Messaging client’s secret. Used to authenticate to the management +plane messaging broker.
      • +
    • software_version (str or None) – Software version of the node. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -15635,6 +51935,90 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • navigation (str or None) – Hyperlink of the specified UI page that provides details.
      • +
    • widgets (list of WidgetItem) – Array of widgets that are part of the multi-widget.
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str) – Title of the widget.
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      Supported visualization types are LabelValueConfiguration, +DonutConfiguration, GridConfiguration, StatsConfiguration, +MultiWidgetConfiguration and ContainerConfiguration.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • datasources (list of Datasource or None) – The ‘datasources’ represent the sources from which data will be +fetched. Currently, only NSX-API is supported as a ‘default’ +datasource. An example of specifying ‘default’ datasource along +with the urls to fetch data from is given at ‘example_request’ +section of ‘CreateWidgetConfiguration’ API.
      • +
    • drilldown_id (str or None) – Id of drilldown widget, if any. Id should be a valid id of an +existing widget. A widget is considered as drilldown widget when it +is associated with any other widget and provides more detailed +information about any data item from the parent widget.
      • +
    • footer (Footer or None) –
      • +
    • is_drilldown (bool or None) – Set to true if this widget should be used as a drilldown.
      • +
    • shared (bool or None) – Please use the property ‘shared’ of View instead of this. The +widgets of a shared view are visible to other users.
      • +
    • weight (long or None) – Specify relavite weight in WidgetItem for placement in a view. +Please see WidgetItem for details. format: int32
      • +
    +
    @@ -15648,6 +52032,76 @@ physical), typically used in policy definitions.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • member_count (long or None) – Count of the members added to this NSGroup format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • members (list of NSGroupSimpleExpression or None) – Reference to the direct/static members of the NSGroup. Can be ID +based expressions only. VirtualMachine cannot be added as a static +member.
      • +
    • membership_criteria (list of vmware.vapi.struct.VapiStruct or None) – List of tag or name based expressions which define the dynamic +membership criteria for this NSGroup. An object must satisfy +atleast one of these expressions to qualify as a member of this +group. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +NSGroupExpression. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in NSGroupExpression.
      • +
    +
    @@ -15660,18 +52114,31 @@ names.

    The arguments are used to initialize data attributes with the same names.

    -
    - -
    -
    -class com.vmware.nsx_policy.model_client.NSGroupDeleteRequestParameters(force=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    NSGroup delete request parameters

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    + +++ + + + +
    Parameters: +
    @@ -15684,6 +52151,20 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:resource_type (str) –

    Possible values are:

    + +
    RESOURCE_TYPE_NSGROUPCOMPLEXEXPRESSION = 'NSGroupComplexExpression'
    @@ -15711,6 +52192,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of NSGroup) – NSGroup list results
      • +
    +
    @@ -15723,6 +52237,50 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    OP_CONTAINS = 'CONTAINS'
    @@ -15738,6 +52296,11 @@ names.

    OP_STARTSWITH = 'STARTSWITH'
    +
    +
    +TARGET_TYPE_DIRECTORYGROUP = 'DirectoryGroup'
    +
    +
    TARGET_TYPE_IPSET = 'IPSet'
    @@ -15782,6 +52345,48 @@ tag.tag = ‘T1’

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    SCOPE_OP_EQUALS = 'EQUALS'
    @@ -15821,18 +52426,72 @@ and protocol pair.

    The arguments are used to initialize data attributes with the same names.

    -
    - -
    -
    -class com.vmware.nsx_policy.model_client.NSServiceDeleteRequestParameters(force=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    NSService delete request parameters

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • default_service (bool or None) – The default NSServices are created in the system by default. These +NSServices can’t be modified/deleted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • nsservice_element (vmware.vapi.struct.VapiStruct) – An NSService Element that describes traffic corresponding to this +NSService +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +NSServiceElement. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in NSServiceElement.
      • +
    +
    @@ -15845,6 +52504,25 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:resource_type (str) –

    Possible values are:

    + +
    +
    The specific type of NSServiceElement
    +
    RESOURCE_TYPE_ALGTYPENSSERVICE = 'ALGTypeNSService'
    @@ -15888,6 +52566,77 @@ NSServices

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • default_service (bool or None) – The default NSServiceGroups are created in the system by default. +These NSServiceGroups can’t be modified/deleted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • members (list of ResourceReference) – List of NSService or NSServiceGroup resources that can be added as +members to an NSServiceGroup.
      • +
    • service_type (str or None) –

      Possible values are:

      + +
      +
      Type of the NSServiceGroup
      +

      This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    +
    SERVICE_TYPE_ETHER = 'ETHER'
    @@ -15900,18 +52649,6 @@ names.

    -
    -
    -class com.vmware.nsx_policy.model_client.NSServiceGroupDeleteRequestParameters(force=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    NSServiceGroup delete request parameters

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    class com.vmware.nsx_policy.model_client.NSServiceGroupListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    @@ -15922,6 +52659,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of NSServiceGroup) – Paged collection of NSServiceGroups
      • +
    +
    @@ -15934,6 +52704,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of NSService) – Paged collection of NSServices
      • +
    +
    @@ -15946,6 +52749,38 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • edge_cluster_ids (list of str or None) – Edge Cluster UUIDs on NSX Manager. Edge cluster information is +required for creating logical L2, L3 constructs on NSX Manager. Max +1 edge cluster ID.
      • +
    • password (str or None) – Password
      • +
    • thumbprint (str) – Thumbprint of EnforcementPoint. sha-256 hash represented in lower +case hex.
      • +
    • transport_zone_ids (list of str or None) – Transport Zone UUIDs on NSX Manager. Transport zone information is +required for creating logical L2, L3 constructs on NSX Manager. Max +1 transport zone ID.
      • +
    • username (str) – UserName
      • +
    • enforcement_point_address (str or None) – Value of this property could be hostname or ip. eg. For NSX-T +manager running on default port the value can be +"10.192.1.1", for NSX-T manager running on custom port +value can be "192.168.1.1:32789". For NSX-T manager in VMC +deployments value can have url prefix eg. +"192.168.1.1:5480/nsxapi"
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    +
    @@ -15958,6 +52793,32 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • password (str or None) – Password
      • +
    • thumbprint (str) – Thumbprint of EnforcementPoint. sha-256 hash represented in lower +case hex.
      • +
    • username (str or None) – UserName
      • +
    • enforcement_point_address (str or None) – Value of this property could be hostname or ip. eg. For NSX-T +manager running on default port the value can be +"10.192.1.1", for NSX-T manager running on custom port +value can be "192.168.1.1:32789". For NSX-T manager in VMC +deployments value can have url prefix eg. +"192.168.1.1:5480/nsxapi"
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    +
    @@ -15971,6 +52832,40 @@ switches

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • active_list (list of Uplink) – List of Uplinks used in active list
      • +
    • policy (str) –

      Possible values are:

      + +
      +
      Teaming policy
      +
      • +
    • standby_list (list of Uplink or None) – List of Uplinks used in standby list
      • +
    • name (str) – An uplink teaming policy of a given name defined in +UplinkHostSwitchProfile. The names of all NamedTeamingPolicies in +an UplinkHostSwitchProfile must be different, but a name can be +shared by different UplinkHostSwitchProfiles. Different +TransportNodes can use different NamedTeamingPolicies having the +same name in different UplinkHostSwitchProfiles to realize an +uplink teaming policy on a logical switch. An uplink teaming policy +on a logical switch can be any policy defined by a user; it does +not have to be a single type of FAILOVER or LOADBALANCE. It can be +a combination of types, for instance, a user can define a policy +with name "MyHybridTeamingPolicy" as "FAILOVER on all +ESX TransportNodes and LOADBALANCE on all KVM TransportNodes". +The name is the key of the teaming policy and can not be changed +once assigned.
      • +
    +
    POLICY_FAILOVER_ORDER = 'FAILOVER_ORDER'
    @@ -15992,6 +52887,107 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • action (str) –

      Possible values are:

      + +

      valid actions: SNAT, DNAT, NO_SNAT, NO_DNAT, REFLEXIVE. All rules +in a logical router are either stateless or stateful. Mix is not +supported. SNAT and DNAT are stateful, can NOT be supported when +the logical router is running at active-active HA mode; REFLEXIVE +is stateless. NO_SNAT and NO_DNAT have no translated_fields, only +match fields are supported.

      +
      • +
    • applied_tos (list of ResourceReference or None) – Holds the list of LogicalRouterPort Ids that a NAT rule can be +applied to. The LogicalRouterPort used must belong to the same +LogicalRouter for which the NAT Rule is created. As of now a NAT +rule can only have a single LogicalRouterPort as applied_tos. When +applied_tos is not set, the NAT rule is applied to all +LogicalRouterPorts beloging to the LogicalRouter.
      • +
    • enabled (bool or None) – enable/disable the rule
      • +
    • logging (bool or None) – enable/disable the logging of rule
      • +
    • logical_router_id (str or None) – Logical router id +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • match_destination_network (str or None) – IP Address | CIDR | (null implies Any)
      • +
    • match_service (vmware.vapi.struct.VapiStruct or None) – A NSServiceElement that specifies the matching services of source +ports, destination ports, ip protocol version and number, sub +protocol version and number, ICMP type and code, etc. The +match_service can be one of IPProtocolNSService,L4PortSetNSService +or ICMPTypeNSService. REFLEXIVE NAT does not support match_service. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +NSServiceElement. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in NSServiceElement.
      • +
    • match_source_network (str or None) – IP Address | CIDR | (null implies Any)
      • +
    • nat_pass (bool or None) – Default is true. If the nat_pass is set to true, the following +firewall stage will be skipped. Please note, if action is NO_NAT, +then nat_pass must be set to true or omitted.
      • +
    • rule_priority (long or None) – Ascending, valid range [0-2147483647]. If multiple rules have the +same priority, evaluation sequence is undefined. format: int64
      • +
    • translated_network (str or None) – IP Address | IP Range | CIDR
      • +
    • translated_ports (str or None) – port number or port range. DNAT only
      • +
    +
    ACTION_DNAT = 'DNAT'
    @@ -16033,6 +53029,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of NatRule) – NAT rule list results
      • +
    +
    @@ -16045,39 +53074,159 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • capabilities (str or None) – Capabilities +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • enabled_capabilities (str or None) – Enabled capabilities +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • ifindex (long or None) – Interface index format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • link_aggregation_capable (bool or None) – Aggregation Capability +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • link_aggregation_port_id (str or None) – Aggregation port id +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • link_aggregation_status (bool or None) – True if currently in aggregation +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • mac (str or None) – Interface MAC address +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • mgmt_addr (str or None) – Management address +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • name (str or None) – Interface name +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • oid (str or None) – Object identifier +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • port_desc (str or None) – Port description +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_desc (str or None) – System description +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_name (str or None) – System name +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_port_number (long or None) – System port number format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    class com.vmware.nsx_policy.model_client.NestedExpression(expressions=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='NestedExpression', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Nested expressions must have three expression nodes. The first and third +nodes must be condition nodes and must have the same member type. The +second must be a conjunction operator with the AND operator.

    Tip

    The arguments are used to initialize data attributes with the same names.

    -
    - -
    -
    -class com.vmware.nsx_policy.model_client.Network(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, force_whitelisting=None, ha_mode=None, ip_addresses=None, provider=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Network instance configuration

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    -HA_MODE_ACTIVE = 'ACTIVE_ACTIVE'
    -
    - -
    -
    -HA_MODE_STANDBY = 'ACTIVE_STANDBY'
    -
    - + +++ + + + +
    Parameters:
      +
    • expressions (list of vmware.vapi.struct.VapiStruct or None) – Expression +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +Expression. When methods return a value of this class as a +return value, the attribute will contain all the attributes defined +in Expression.
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -16090,18 +53239,28 @@ names.

    The arguments are used to initialize data attributes with the same names.

    -
    - -
    -
    -class com.vmware.nsx_policy.model_client.NetworkListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Paged collection of Network instances

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    + +++ + + + +
    Parameters:
      +
    • dest_element_id (str or None) – Unique element ID of destination element to which the connection is +established. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • number_of_events (long or None) – Represents the number of events/flows between the source and +destination elements. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • src_element_id (str or None) – Unique element ID of source element from which the connection is +established. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -16115,6 +53274,68 @@ migration specifications to be handled by transport node.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    +
    RESOURCE_TYPE_HOSTPROFILENETWORKMIGRATIONSPEC = 'HostProfileNetworkMigrationSpec'
    @@ -16132,6 +53353,46 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of vmware.vapi.struct.VapiStruct or None) – Network migration specification template results +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +NetworkMigrationSpec. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in NetworkMigrationSpec. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -16143,6 +53404,27 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • key (str or None) –

      Possible values are:

      + +

      This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    • value (str) – the id of the NetworkMigrationSpec
      • +
    +
    KEY_HOSTPROFILENETWORKMIGRATIONSPEC = 'HostProfileNetworkMigrationSpec'
    @@ -16161,6 +53443,21 @@ needs to be configured by the NSX Manager.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • gateway_address (str or None) – Gateway address associated with the NIC metadata.
      • +
    • ip_address (str or None) – IP address associated with the NIC metadata.
      • +
    • network_id (str or None) – Network Id associated with the NIC metadata.
      • +
    • nic_metadata (NicMetadata or None) – NIC metadata information.
      • +
    • subnet_mask (str or None) – Subnet mask associated with the NIC metadata.
      • +
    +
    @@ -16174,6 +53471,29 @@ needs to be configured by the NSX Manager.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    INTERFACE_TYPE_DATA1 = 'DATA1'
    @@ -16211,6 +53531,80 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • enabled (bool or None) – The enabled property specifies the status of NIOC feature. When +enabled is set to true, NIOC feature is turned on and the bandwidth +allocations specified for the traffic resources are enforced. When +enabled is set to false, NIOC feature is turned off and no +bandwidth allocation is guaranteed. By default, enabled will be set +to true.
      • +
    • host_infra_traffic_res (list of ResourceAllocation or None) – host_infra_traffic_res specifies bandwidth allocation for various +traffic resources.
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • required_capabilities (list of str or None) –
      • +
    +
    @@ -16222,6 +53616,75 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) – Fabric node type, for example ‘HostNode’, ‘EdgeNode’ or +‘PublicCloudGatewayNode’
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • discovered_ip_addresses (list of str or None) – Discovered IP Addresses of the fabric node, version 4 or 6 format: +ip +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • external_id (str or None) – ID of the Node maintained on the Node and used to recognize the +Node
      • +
    • fqdn (str or None) – Fully qualified domain name of the fabric node +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • ip_addresses (list of str or None) – IP Addresses of the Node, version 4 or 6. This property is +mandatory for all nodes except for automatic deployment of edge +virtual machine node. For automatic deployment, the ip address from +management_port_subnets property will be considered. format: ip
      • +
    +
    @@ -16234,6 +53697,67 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • node (vmware.vapi.struct.VapiStruct or None) – Node attributes +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in Node. +When methods return a value of this class as a return value, the +attribute will contain all the attributes defined in Node.
      • +
    • status (NodeStatus or None) – Node status
      • +
    +
    @@ -16246,6 +53770,160 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of NodeAggregateInfo) – Node Aggregate Info Results
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.NodeElement(element_id=None, elements=None, resource_name=None, resource_type=None, fqdn=None, ip_addresses=None, os=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Host node element extends from Element class. NodeElement can be ‘HostNode’ +or ‘EdgeNode’

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters: +
    +
    +
    +RESOURCE_TYPE_EDGENODEELEMENT = 'EdgeNodeElement'
    +
    + +
    +
    +RESOURCE_TYPE_GROUPELEMENT = 'GroupElement'
    +
    + +
    +
    +RESOURCE_TYPE_HOSTNODEELEMENT = 'HostNodeElement'
    +
    + +
    +
    +RESOURCE_TYPE_LBVIRTUALSERVERELEMENT = 'LBVirtualServerElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOADBALANCERSERVICEELEMENT = 'LoadBalancerServiceElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALROUTERPORTELEMENT = 'LogicalRouterPortElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALSWITCHELEMENT = 'LogicalSwitchElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALSWITCHPORTELEMENT = 'LogicalSwitchPortElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALT0ROUTERELEMENT = 'LogicalT0RouterElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALT1ROUTERELEMENT = 'LogicalT1RouterElement'
    +
    + +
    +
    +RESOURCE_TYPE_PROCESSELEMENT = 'ProcessElement'
    +
    + +
    +
    +RESOURCE_TYPE_VIRTUALNETWORKINTERFACEELEMENT = 'VirtualNetworkInterfaceElement'
    +
    + +
    +
    +RESOURCE_TYPE_VMELEMENT = 'VMElement'
    +
    +
    @@ -16258,6 +53936,31 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • file_system (str or None) – File system id +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • mount (str or None) – File system mount +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • total (long or None) – File system size in kilobytes format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • type (str or None) – File system type +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • used (long or None) – Amount of file system used in kilobytes format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -16269,6 +53972,26 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    SERVICE_TYPES_API = 'API'
    @@ -16296,6 +54019,29 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    IP_CONFIGURATION_DHCP = 'dhcp'
    @@ -16323,6 +54069,55 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    ADMIN_STATUS_DOWN = 'DOWN'
    @@ -16375,6 +54170,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of NodeInterfaceProperties) – Node interface property results
      • +
    +
    @@ -16387,6 +54215,44 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • interface_id (str or None) – Interface ID
      • +
    • rx_bytes (long or None) – Number of bytes received format: int64
      • +
    • rx_dropped (long or None) – Number of packets dropped format: int64
      • +
    • rx_errors (long or None) – Number of receive errors format: int64
      • +
    • rx_frame (long or None) – Number of framing errors format: int64
      • +
    • rx_packets (long or None) – Number of packets received format: int64
      • +
    • source (str or None) –

      Possible values are:

      + +
      +
      Source of status data.
      +
      • +
    • tx_bytes (long or None) – Number of bytes transmitted format: int64
      • +
    • tx_carrier (long or None) – Number of carrier losses detected format: int64
      • +
    • tx_colls (long or None) – Number of collisions detected format: int64
      • +
    • tx_dropped (long or None) – Number of packets dropped format: int64
      • +
    • tx_errors (long or None) – Number of transmit errors format: int64
      • +
    • tx_packets (long or None) – Number of packets transmitted format: int64
      • +
    +
    SOURCE_CACHED = 'cached'
    @@ -16409,6 +54275,43 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of vmware.vapi.struct.VapiStruct) – Node list results +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in Node. +When methods return a value of this class as a return value, the +attribute will contain all the attributes defined in Node.
      • +
    +
    @@ -16421,6 +54324,117 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    HOST_NODE_DEPLOYMENT_STATUS_EDGE_CONFIG_ERROR = 'EDGE_CONFIG_ERROR'
    @@ -16623,6 +54637,65 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cpu_cores (long or None) – Number of CPU cores on the system format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • file_systems (list of NodeFileSystemProperties or None) – File systems configured on the system +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • load_average (list of float or None) – One, five, and fifteen minute load averages for the system +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • mem_cache (long or None) – Amount of RAM on the system that can be flushed out to disk, in +kilobytes format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • mem_total (long or None) – Amount of RAM allocated to the system, in kilobytes format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • mem_used (long or None) – Amount of RAM in use on the system, in kilobytes format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • source (str or None) –

      Possible values are:

      + +
      +
      Source of status data.
      +

      This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    • swap_total (long or None) – Amount of disk available for swap, in kilobytes format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • swap_used (long or None) – Amount of swap disk in use, in kilobytes format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_time (long or None) – Current time expressed in milliseconds since epoch format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • uptime (long or None) – Milliseconds since system start format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    SOURCE_CACHED = 'cached'
    @@ -16644,6 +54717,38 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • audit_password (str or None) – Password for the node audit user. For deployment, this property is +required. After deployment, this property is ignored, and the node +cli must be used to change the password. The password specified +must be at least 8 characters in length and must contain at least +one lowercase, one uppercase, one numeric character and one special +character (except quotes).
      • +
    • audit_username (str or None) – The default username is "audit". To configure username, you +must provide this property together with audit_password.
      • +
    • cli_password (str or None) – Password for the node cli user. For deployment, this property is +required. After deployment, this property is ignored, and the node +cli must be used to change the password. The password specified +must be at least 8 characters in length and must contain at least +one lowercase, one uppercase, one numeric character and one special +character (except quotes).
      • +
    • cli_username (str or None) – To configure username, you must provide this property together with +cli_password.
      • +
    • root_password (str or None) – Password for the node root user. For deployment, this property is +required. After deployment, this property is ignored, and the node +cli must be used to change the password. The password specified +must be at least 8 characters in length and must contain at least +one lowercase, one uppercase, one numeric character and one special +character (except quotes).
      • +
    +
    @@ -16656,6 +54761,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of ResourceReference) – Normalized resource list results
      • +
    +
    @@ -16668,6 +54806,50 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    PERMISSIONS_CRUD = 'crud'
    @@ -16790,6 +54972,74 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • operation (str or None) –

      Possible values are:

      + +
      +
      Allowed operation
      +
      • +
    • path_prefix (str) – Path prefix
      • +
    • role_name (str) – Role name
      • +
    • rule_disabled (bool or None) – Is rule disabled or not
      • +
    +
    OPERATION_CRUD = 'crud'
    @@ -16822,6 +55072,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of ObjectRolePermissionGroup) – ObjectRolePermissionGroup list results
      • +
    +
    @@ -16835,6 +55118,26 @@ PUT and POST.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • action (str or None) – Optional action +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • href (str or None) – Link to resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • rel (str or None) – Custom relation type (follows RFC 5988 where appropriate +definitions exist) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -16846,6 +55149,57 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • owner (OwnerResourceLink or None) – Owner of this resource
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Identifier of the resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • action (str) –

      Possible values are:

      + +
      +
      Action enforced on the packets which matches the PBR rule.
      +
      • +
    • applied_tos (list of ResourceReference or None) – List of object where rule will be enforced. field overrides this +one. Null will be treated as any.
      • +
    • destinations (list of ResourceReference or None) – List of the destinations. Null will be treated as any.
      • +
    • disabled (bool or None) – Flag to disable rule. Disabled will only be persisted but never +provisioned/realized.
      • +
    • logged (bool or None) – Flag to enable packet logging. Default is disabled.
      • +
    • notes (str or None) – User notes specific to the rule.
      • +
    • rule_tag (str or None) – User level field which will be printed in CLI and packet logs.
      • +
    • services (list of PBRService or None) – List of the services. Null will be treated as any.
      • +
    • sources (list of ResourceReference or None) – List of sources. Null will be treated as any.
      • +
    +
    ACTION_OVERLAY = 'ROUTE_TO_OVERLAY'
    @@ -16877,6 +55231,41 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of PBRRule or None) – PBR rule list result with pagination support. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -16888,6 +55277,64 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • rule_count (long or None) – Number of rules in this section. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -16899,6 +55346,41 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of PBRSection or None) – List of the PBR sections. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -16910,6 +55392,65 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • rule_count (long or None) – Number of rules in this section. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • rules (list of PBRRule) – List of PBR rules in the section.
      • +
    +
    @@ -16922,6 +55463,33 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • is_valid (bool or None) – Will be set to false if the referenced NSX resource has been +deleted. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • target_display_name (str or None) – Display name of the NSX resource. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • target_id (str or None) – Identifier of the NSX resource.
      • +
    • target_type (str or None) – Type of the NSX resource.
      • +
    • service (vmware.vapi.struct.VapiStruct or None) – Distributed Service API accepts raw protocol and ports as part of +NS service element in Distributed Service Rule that describes +traffic corresponding to an NSService. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +NSServiceElement. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in NSServiceElement.
      • +
    +
    @@ -16934,6 +55502,18 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • bulletin_ids (list of str) – List of bulletin ids
      • +
    • package_url (str) – url of the package
      • +
    +
    @@ -16947,6 +55527,20 @@ configuration matches with all user specified properties.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • ip_address (str or None) – A single IP address or a subnet, e.g. x.x.x.x or x.x.x.x/y format: +address-or-block-or-range
      • +
    • mac_address (str or None) – A single MAC address
      • +
    • vlan (long or None) – Virtual Local Area Network Identifier format: int64
      • +
    +
    @@ -16959,6 +55553,36 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    NAME_DSTIP = 'DSTIP'
    @@ -17036,6 +55660,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • values (list of PacketCaptureOption or None) – Packet capture option collection
      • +
    +
    @@ -17049,6 +55706,74 @@ related parameters according to the capture point.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    CAPMODE_STANDALONE = 'STANDALONE'
    @@ -17070,13 +55795,13 @@ names.

    -
    -CAPPOINT_OTHERS = 'OTHERS'
    +
    +CAPPOINT_VDRPORT = 'VDRPORT'
    -
    -CAPPOINT_VDRPORT = 'VDRPORT'
    +
    +CAPPOINT_VIF = 'VIF'
    @@ -17141,6 +55866,37 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    SESSIONSTATUS_CREATED = 'CREATED'
    @@ -17177,6 +55933,36 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long) – Total capture session count format: int64
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of PacketCaptureSession or None) – Packet capture list for all sessoins
      • +
    +
    @@ -17189,6 +55975,18 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • accepted (bool) – States if EULA is accepted or not
      • +
    • eula_link (str or None) – Contains link to end user’s terms and conditions
      • +
    +
    @@ -17201,6 +55999,33 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    VALUE_FAILED = 'FAILED'
    @@ -17243,6 +56068,19 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • device_name (str) – device name or key
      • +
    • uplink_name (str) – Uplink name for this Pnic. This name will be used to reference this +Pnic in other configurations.
      • +
    +
    @@ -17255,6 +56093,36 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    STATUS_DEGRADED = 'DEGRADED'
    @@ -17302,6 +56170,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of PnicBondStatus or None) – List of pNIC statuses belonging to the transport node
      • +
    +
    @@ -17313,6 +56214,27 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    @@ -17324,11 +56246,34 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    -class com.vmware.nsx_policy.model_client.PolicyAlarmResource(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, message=None)
    +class com.vmware.nsx_policy.model_client.PolicyAlarmResource(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, error_details=None, message=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    Alarm base class of realized policy object

    @@ -17336,6 +56281,97 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – error id for the alarm
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – path of the alarm object
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • error_details (PolicyApiError or None) – Detailed information about errors from an API call made to the +enforcement point, if any.
      • +
    • message (str or None) – error message to describe the issue
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.PolicyApiError(details=None, error_code=None, error_data=None, error_message=None, module_name=None, related_errors=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Detailed information about errors from API call to an enforcement point

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • details (str or None) – Further details about the error
      • +
    • error_code (long or None) – A numeric error code format: int64
      • +
    • error_data (vmware.vapi.struct.VapiStruct or None) – Additional data about the error
      • +
    • error_message (str or None) – A description of the error
      • +
    • module_name (str or None) – The module name where the error occurred
      • +
    • related_errors (list of PolicyApiError or None) – Other errors related to this error
      • +
    +
    @@ -17348,6 +56384,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of PolicyResource) – Associations list results
      • +
    +
    @@ -17362,6 +56431,81 @@ local and peer subnet.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • policy_rules (list of IPSecVPNPolicyRule) – Policy rules
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      A Policy Based VPN requires to define protect rules that match +local and peer subnets. IPSec security associations is negotiated +for each pair of local and peer subnet. A Route Based VPN is more +flexible, more powerful and recommended over policy based VPN. IP +Tunnel port is created and all traffic routed via tunnel port is +protected. Routes can be configured statically or can be learned +through BGP. A route based VPN is must for establishing redundant +VPN session to remote site.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • enabled (bool or None) – Enable/Disable IPSec VPN session.
      • +
    • ipsec_vpn_service_id (str or None) – Identifier of VPN Service linked with local endpoint. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • local_endpoint_id (str) – Local endpoint identifier.
      • +
    • peer_endpoint_id (str) – Peer endpoint identifier.
      • +
    +
    @@ -17375,6 +56519,34 @@ tunnel is referenced in a policy whose action is set as tunnel.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • rules (list of L3VpnRule or None) – L3Vpn rules that are specific to the L3Vpn. Only L3Vpn rules with +PROTECT action are supported.
      • +
    • resource_type (str) –

      Possible values are:

      + +
        +
      • A Policy Based L3Vpn is a configuration in which protect rules to
        • +
      +

      match local and remote subnet needs to be defined. Tunnel is +established for each pair of local and remote subnet defined in +protect rules. - A Route Based L3Vpn is more flexible, more +powerful and recommended over policy based. IP Tunnel subnet is +created and all traffic routed through tunnel subnet (commonly +known as VTI) is sent over tunnel. Routes can be learned through +BGP. A route based L3Vpn is required when using redundant L3Vpn.

      +
      • +
    +
    @@ -17387,6 +56559,80 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -17399,6 +56645,96 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • conditional_forwarder_zone_paths (list of str or None) – Max of 5 DNS servers can be configured
      • +
    • default_forwarder_zone_path (str) – This is the zone to which DNS requests are forwarded by default
      • +
    • listener_ip (str) – This is the IP on which the DNS Forwarder listens. format: ipv4
      • +
    • log_level (str or None) –

      Possible values are:

      + +
      +
      Set log_level to DISABLED will stop dumping fowarder log.
      +
      • +
    +
    LOG_LEVEL_DEBUG = 'DEBUG'
    @@ -17446,6 +56782,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of PolicyDnsForwarder) – DNS Forwarder list results
      • +
    +
    @@ -17458,6 +56827,90 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • dns_domain_names (list of str or None) – List of domain names on which conditional forwarding is based. This +field is required if the DNS Zone is being used for a conditional +forwarder. This field will also be used for conditional reverse +lookup. Example 1, if for one of the zones, one of the entries in +the fqdn is example.com, all the DNS requests under the domain +example.com will be served by the corresponding upstream DNS +server. Example 2, if for one of the zones, one of the entries in +the fqdn list is "13.12.30.in-addr.arpa", reverse lookup +for 30.12.13.0/24 will go to the corresponding DNS server.
      • +
    • upstream_servers (list of str) – Max of 3 DNS servers can be configured format: ipv4
      • +
    +
    @@ -17470,11 +56923,90 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of PolicyDnsForwarderZone) – Dns Forwarder Zone list results
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.PolicyGroupIPMembersListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Paginated collection of IP members belonging to a Group.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of str) – Paged Collection of IP addresses that belong to the given Group +format: address-or-block-or-range
      • +
    +
    -class com.vmware.nsx_policy.model_client.PolicyIPAddressInfo(address_value=None, display_name=None)
    +class com.vmware.nsx_policy.model_client.PolicyIPAddressInfo(address_value=None, display_name=None, next_hop=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    Used to specify the display name and value of the IPv4Address.

    @@ -17482,6 +57014,20 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • address_value (str) – Value of the IPv4Address. format: ipv4
      • +
    • display_name (str or None) – Display name used to help identify the IPv4Address.
      • +
    • next_hop (str or None) – Next hop used in auto-plumbing of static route. If a value is not +provided, static route will not be auto-plumbed. format: ipv4
      • +
    +
    @@ -17494,6 +57040,82 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • refs (list of str or None) – Policy entity paths referred by the label instance
      • +
    • type (str) – Policy intent entity type from PolicyResourceType
      • +
    +
    @@ -17506,244 +57128,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    -
    - -
    -
    -class com.vmware.nsx_policy.model_client.PolicyLbMonitorProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='PolicyLbMonitorProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, fall_count=None, interval=None, monitor_port=None, rise_count=None, timeout=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    All the types of PolicyLbMonitorProfile extend from this abstract class. -This is present for extensibility.

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    -RESOURCE_TYPE_HTTPPOLICYLBMONITORPROFILE = 'HttpPolicyLbMonitorProfile'
    -
    - -
    -
    -RESOURCE_TYPE_HTTPSPOLICYLBMONITORPROFILE = 'HttpsPolicyLbMonitorProfile'
    -
    - -
    -
    -RESOURCE_TYPE_ICMPPOLICYLBMONITORPROFILE = 'IcmpPolicyLbMonitorProfile'
    -
    - -
    -
    -RESOURCE_TYPE_TCPPOLICYLBMONITORPROFILE = 'TcpPolicyLbMonitorProfile'
    -
    - -
    -
    -RESOURCE_TYPE_UDPPOLICYLBMONITORPROFILE = 'UdpPolicyLbMonitorProfile'
    -
    - -
    - -
    -
    -class com.vmware.nsx_policy.model_client.PolicyLbMonitorProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Paged Collection of PolicyLbMonitorProfiles

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    - -
    -
    -class com.vmware.nsx_policy.model_client.PolicyLbPersistenceProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='PolicyLbPersistenceProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Some applications maintain state and require all relevant connections to be -sent to the same server as the application state is not synchronized among -servers. Persistence is enabled on a PolicyLbVirtualServer by binding a -persistence profile to it.

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    -RESOURCE_TYPE_CUSTOMPOLICYLBPERSISTENCEPROFILE = 'CustomPolicyLbPersistenceProfile'
    -
    - -
    -
    -RESOURCE_TYPE_L4POLICYLBPERSISTENCEPROFILE = 'L4PolicyLbPersistenceProfile'
    -
    - -
    -
    -RESOURCE_TYPE_L7POLICYLBPERSISTENCEPROFILE = 'L7PolicyLbPersistenceProfile'
    -
    - -
    - -
    -
    -class com.vmware.nsx_policy.model_client.PolicyLbPersistenceProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Paged Collection of PolicyLbPersistenceProfiles

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    - -
    -
    -class com.vmware.nsx_policy.model_client.PolicyLbPoolAccess(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, algorithm=None, ip_port_list=None, lb_monitor_profile=None, pool_port=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Defining access of a Group from a PolicyLbVirtualServer and binding to -PolicyLbMonitorProfile.

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    -ALGORITHM_LEAST_CONNECTION = 'LEAST_CONNECTION'
    -
    - -
    -
    -ALGORITHM_ROUND_ROBIN = 'ROUND_ROBIN'
    -
    - -
    - -
    -
    -class com.vmware.nsx_policy.model_client.PolicyLbPoolAccessListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Paged Collection of PolicyLbPoolAccess

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    - -
    -
    -class com.vmware.nsx_policy.model_client.PolicyLbRule(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, host_match=None, lb_virtual_server=None, match_strategy=None, path_match=None, sequence_number=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Binding of a LbPoolAccess and Group to a PolicyLbVirtualServer used to -route application traffic passing through load balancers. PolicyLbRule uses -match conditions to match application traffic passing through a -PolicyLbVirtualServer using HTTP or HTTPS. Can bind multiple -PolicyLbVirtualServers to a Group. Each PolicyLbRule consists of two -optional match conditions, each match contidion defines a criterion for -application traffic. If no match conditions are specified, then the -PolicyLbRule will always match and it is used typically to define default -rules. If more than one match condition is specified, then matching -strategy determines if all conditions should match or any one condition -should match for the PolicyLbRule to be considered a match. A match -indicates that the PolicyLbVirtualServer should route the request to the -Group (parent of PolicyLbRule).

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    -MATCH_STRATEGY_ALL = 'ALL'
    -
    - -
    -
    -MATCH_STRATEGY_ANY = 'ANY'
    -
    - -
    - -
    -
    -class com.vmware.nsx_policy.model_client.PolicyLbRuleListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Paged Collection of PolicyLbRules

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    - -
    -
    -class com.vmware.nsx_policy.model_client.PolicyLbVirtualServer(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='PolicyLbVirtualServer', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, access_log_enabled=None, ip_address=None, lb_persistence_profile=None, ports=None, router_path=None, traffic_source=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    All the types of PolicyLbVirtualServer extend from this abstract class. -This is present for extensibility.

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    -RESOURCE_TYPE_CUSTOMPOLICYLBVIRTUALSERVER = 'CustomPolicyLbVirtualServer'
    -
    - -
    -
    -RESOURCE_TYPE_HTTPPOLICYLBVIRTUALSERVER = 'HttpPolicyLbVirtualServer'
    -
    - -
    -
    -RESOURCE_TYPE_HTTPSPOLICYLBVIRTUALSERVER = 'HttpsPolicyLbVirtualServer'
    -
    - -
    -
    -RESOURCE_TYPE_TCPPOLICYLBVIRTUALSERVER = 'TcpPolicyLbVirtualServer'
    -
    - -
    -
    -RESOURCE_TYPE_UDPPOLICYLBVIRTUALSERVER = 'UdpPolicyLbVirtualServer'
    -
    - -
    -
    -TRAFFIC_SOURCE_EXTERNAL_PUBLIC = 'EXTERNAL_PUBLIC'
    -
    - -
    -
    -TRAFFIC_SOURCE_EXTERNAL_VPN = 'EXTERNAL_VPN'
    -
    - -
    -
    -TRAFFIC_SOURCE_INTERNAL = 'INTERNAL'
    -
    - -
    - -
    -
    -class com.vmware.nsx_policy.model_client.PolicyLbVirtualServerListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Paged Collection of PolicyLbVirtualServers

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of PolicyLabel) – Policy label list results
      • +
    +
    @@ -17751,13 +57168,96 @@ names.

    class com.vmware.nsx_policy.model_client.PolicyNat(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, nat_type=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    Represents NAT section. This object is created by default when -corresponding Network is created. Under Network there will be 3 different +corresponding tier-1 is created. Under tier-1 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT).

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • nat_type (str or None) –

      Possible values are:

      + +
      +
      Represents a NAT section under tier-1.
      +
      • +
    +
    NAT_TYPE_DEFAULT = 'DEFAULT'
    @@ -17785,6 +57285,137 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • action (str) –

      Possible values are:

      + +

      Source NAT(SNAT) - translates a source IP address in an outbound +packet so that the packet appears to originate from a different +network. SNAT is only supported when the logical router is running +in active-standby mode. Destination NAT(DNAT) - translates the +destination IP address of inbound packets so that packets are +delivered to a target address into another network. DNAT is only +supported when the logical router is running in active-standby +mode. Reflexive NAT(REFLEXIVE) - IP-Range and CIDR are supported to +define the "n". The number of original networks should be +exactly the same as that of translated networks. The address +translation is deterministic. Reflexive is supported on both +Active/Standby and Active/Active LR. NO_SNAT and NO_DNAT - These do +not have support for translated_fields, only source_network and +destination_network fields are supported.

      +
      • +
    • destination_network (str or None) – IP Address | Comma separeted list of IP addresses | CIDR. For DNAT +and NO_DNAT rules, this is a mandatory field, and represents the +destination network for the incoming packets. For other type of +rules, optionally it can contain destination network of outgoing +packets. NULL value for this field represents ANY network. format: +list-of-address-or-block-or-range
      • +
    • scope (list of str or None) – Represents the array of policy paths of labels of type +ProviderInterface on which the NAT rule should get enforced. The +tier-0 interfaces must belong to the same tier-0 router for which +the NAT Rule is created.
      • +
    • sequence_number (long or None) – The sequence_number decides the rule_priority of a NAT rule. +Sequence_number and rule_priority have 1:1 mapping.For each NAT +section, there will be reserved rule_priority numbers.The valid +range of rule_priority number is from 0 to 2147483647(MAX_INT). 1. +INTERNAL section rule_priority reserved from 0 - 1023 (1024 rules) +valid sequence_number range 0 - 1023 2. USER section rule_priority +reserved from 1024 - 2147482623 (2147481600 rules) valid +sequence_number range 0 - 2147481599 3. DEFAULT section +rule_priority reserved from 2147482624 - 2147483647 (1024 rules) +valid sequence_number range 0 - 1023 format: int32
      • +
    • service (str or None) – It represents the path of Service on which the NAT rule will be +applied. If not provided or if it is blank then Policy manager will +consider it as ANY.
      • +
    • source_network (str or None) – IP Address | Comma separeted list of IP addresses | CIDR. For SNAT, +NO_SNAT and REFLEXIVE rules, this is a mandatory field and +represents the source network of the packets leaving the network. +For DNAT and NO_DNAT rules, optionally it can contain source +network of incoming packets. NULL value for this field represents +ANY network. format: list-of-address-or-block-or-range
      • +
    • translated_network (str or None) – IP Address | Comma separeted list of IP addresses | CIDR. For SNAT, +DNAT and REFLEXIVE rules, this ia a mandatory field, which +represents the translated network address. For NO_SNAT and NO_DNAT +this should be empty. format: list-of-address-or-block-or-range
      • +
    • translated_ports (str or None) – Port number or port range format: port-or-range
      • +
    +
    ACTION_DNAT = 'DNAT'
    @@ -17822,6 +57453,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of PolicyNatRule) – NAT Rules list results
      • +
    +
    @@ -17834,6 +57498,85 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • alarms (list of PolicyAlarmResource or None) – Alarm info detail
      • +
    • intent_reference (list of str or None) – Desire state paths of this object
      • +
    • realization_specific_identifier (str or None) – Realization id of this object
      • +
    • runtime_status (str or None) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is +not exhaustive.
      • +
    • state (str) –

      Possible values are:

      + +
      +
      Realization state of this object
      +
      • +
    +
    STATE_ERROR = 'ERROR'
    @@ -17866,6 +57609,70 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -17878,6 +57685,28 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • is_valid (bool or None) – Will be set to false if the referenced NSX resource has been +deleted. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • target_display_name (str or None) – Display name of the NSX resource. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • target_id (str or None) – Identifier of the NSX resource.
      • +
    • target_type (str or None) – Type of the NSX resource.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -17890,6 +57719,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of PolicyResourceReference) – Policy resource references list results
      • +
    +
    @@ -17902,6 +57764,80 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -17914,6 +57850,123 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • deployment_mode (str or None) –

      Possible values are:

      + +

      Deployment mode specifies how the partner appliance will be +deployed i.e. in HA or standalone mode.

      +
      • +
    • partner_service_name (str) – Unique name of Partner Service to be consumed in redirection
      • +
    • transport_type (str or None) –

      Possible values are:

      + +
      +
      Transport to be used while deploying Service-VM.
      +
      • +
    • attributes (list of Attribute) – List of attributes specific to a partner for which the service is +created. There attributes are passed on to the partner appliance.
      • +
    • compute_id (str) – Id of the compute(ResourcePool) to which this service needs to be +deployed.
      • +
    • context_id (str or None) – UUID of VCenter/Compute Manager as seen on NSX Manager, to which +this service needs to be deployed.
      • +
    • deployment_spec_name (str) – Form factor for the deployment of partner service.
      • +
    • deployment_template_name (str) – Template for the deployment of partnet service.
      • +
    • failure_policy (str or None) –

      Possible values are:

      + +

      Failure policy for the Service VM. If this values is not provided, +it will be defaulted to FAIL_CLOSE.

      +
      • +
    • primary_interface_mgmt_ip (str) – Management IP Address of primary interface of the Service format: +address-or-block-or-range
      • +
    • primary_interface_network (str) – Path of the Network to which primary interface of the Service VM +needs to be connected
      • +
    • secondary_interface_mgmt_ip (str) – Management IP Address of secondary interface of the Service format: +address-or-block-or-range
      • +
    • secondary_interface_network (str) – Path of Network to which secondary interface of the Service VM +needs to be connected
      • +
    • storage_id (str) – Id of the storage(Datastore). VC moref of Datastore to which this +service needs to be deployed.
      • +
    +
    DEPLOYMENT_MODE_ACTIVE_STANDBY = 'ACTIVE_STANDBY'
    @@ -17956,6 +58009,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of PolicyServiceInstance) – Service instance list results
      • +
    +
    @@ -17968,6 +58054,63 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • template_body (vmware.vapi.struct.VapiStruct) – Body of an instance of Infra
      • +
    • template_placeholders (list of PolicyTemplatePlaceholder) – Template placeholders
      • +
    +
    @@ -17980,6 +58123,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of PolicyTemplate) – Policy Template list results
      • +
    +
    @@ -17992,6 +58168,18 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • parameter_id (str) – Parameter id
      • +
    • parameter_value (str) – Parameter value
      • +
    +
    @@ -18004,6 +58192,14 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:placeholders (list of PolicyTemplateParameter) – List of Policy template parameter
    @@ -18016,6 +58212,18 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • placeholder_id (str) – Placeholder id
      • +
    • placeholder_message (str) – Placeholder message
      • +
    +
    @@ -18027,6 +58235,45 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • admin_state (str or None) –

      Possible values are:

      + +
      +
      member admin state
      +
      • +
    • backup_member (bool or None) – Backup servers are typically configured with a sorry page +indicating to the user that the application is currently +unavailable. While the pool is active (a specified minimum number +of pool members are active) BACKUP members are skipped during +server selection. When the pool is inactive, incoming connections +are sent to only the BACKUP member(s).
      • +
    • display_name (str or None) – pool member name
      • +
    • ip_address (str) – pool member IP address format: ip
      • +
    • max_concurrent_connections (long or None) – To ensure members are not overloaded, connections to a member can +be capped by the load balancer. When a member reaches this limit, +it is skipped during server selection. If it is not specified, it +means that connections are unlimited. format: int64
      • +
    • port (str or None) – If port is specified, all connections will be sent to this port. +Only single port is supported. If unset, the same port the client +connected to will be used, it could be overrode by +default_pool_member_port setting in virtual server. The port should +not specified for port range case. format: port-or-range
      • +
    • weight (long or None) – Pool member weight is used for WEIGHTED_ROUND_ROBIN balancing +algorithm. The weight value would be ignored in other algorithms. +format: int64
      • +
    +
    ADMIN_STATE_DISABLED = 'DISABLED'
    @@ -18053,6 +58300,49 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • customized_members (list of PoolMemberSetting or None) – The list is used to show the customized pool member settings. User +can only user pool member action API to update the admin state for +a specific IP address.
      • +
    • grouping_object (ResourceReference) – Load balancer pool support grouping object as dynamic pool members. +The IP list of the grouping object such as NSGroup would be used as +pool member IP setting.
      • +
    • ip_revision_filter (str or None) –

      Possible values are:

      + +

      Ip revision filter is used to filter IPv4 or IPv6 addresses from +the grouping object. If the filter is not specified, both IPv4 and +IPv6 addresses would be used as server IPs. The link local and +loopback addresses would be always filtered out.

      +
      • +
    • max_ip_list_size (long or None) – The size is used to define the maximum number of grouping object IP +address list. These IP addresses would be used as pool members. If +the grouping object includes more than certain number of IP +addresses, the redundant parts would be ignored and those IP +addresses would not be treated as pool members. If the size is not +specified, one member is budgeted for this dynamic pool so that the +pool has at least one member even if some other dynamic pools grow +beyond the capacity of load balancer service. Other members are +picked according to available dynamic capacity. The unused members +would be set to DISABLED so that the load balancer system itself is +not overloaded during runtime. format: int64
      • +
    • port (long or None) – If port is specified, all connections will be sent to this port. If +unset, the same port the client connected to will be used, it could +be overridden by default_pool_member_ports setting in virtual +server. The port should not specified for multiple ports case. +format: int32
      • +
    +
    IP_REVISION_FILTER_IPV4 = 'IPV4'
    @@ -18082,6 +58372,31 @@ For dynamic pool members, only admin_state can be updated.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • admin_state (str or None) –

      Possible values are:

      + +
      +
      Member admin state
      +
      • +
    • display_name (str or None) – Only applicable to static pool members. If supplied for a pool +defined by a grouping object, update API would fail.
      • +
    • ip_address (str) – Pool member IP address format: ip
      • +
    • port (str or None) – Pool member port number format: port-or-range
      • +
    • weight (long or None) – Only applicable to static pool members. If supplied for a pool +defined by a grouping object, update API would fail. format: int64
      • +
    +
    ADMIN_STATE_DISABLED = 'DISABLED'
    @@ -18109,6 +58424,25 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • allocated_ids (long or None) – Total number of allocated IDs in a pool format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • free_ids (long or None) – Total number of free IDs in a pool format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • total_ids (long or None) – Total number of IDs in a pool format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -18121,6 +58455,94 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • destination_group (str) – Data from source group will be copied to members of destination +group.
      • +
    • direction (str or None) –

      Possible values are:

      + +
      +
      Port mirroring instance direction
      +
      • +
    • snap_length (long or None) – If this property is set, the packet will be truncated to the +provided length. If this property is unset, entire packet will be +mirrored. format: int32
      • +
    +
    DIRECTION_BIDIRECTIONAL = 'BIDIRECTIONAL'
    @@ -18148,6 +58570,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of PortMirroringInstance) – Port Mirroring Instances list results
      • +
    +
    @@ -18159,6 +58614,101 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • direction (str) –

      Possible values are:

      + +
      +
      Port mirroring session direction
      +
      • +
    • encapsulation_vlan_id (long or None) – Only for Remote SPAN Port Mirror. format: int64
      • +
    • mirror_destination (vmware.vapi.struct.VapiStruct) – Mirror destination +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +MirrorDestination. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in MirrorDestination.
      • +
    • mirror_sources (list of vmware.vapi.struct.VapiStruct) – Mirror sources +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +MirrorSource. When methods return a value of this class as +a return value, the attribute will contain all the attributes +defined in MirrorSource.
      • +
    • preserve_original_vlan (bool or None) – Only for Remote SPAN Port Mirror. Whether to preserve original +VLAN.
      • +
    • session_type (str or None) –

      Possible values are:

      + +

      If this property is unset, this session will be treated as +LocalPortMirrorSession.

      +
      • +
    • snap_length (long or None) – If this property is set, the packet will be truncated to the +provided length. If this property is unset, entire packet will be +mirrored. format: int64
      • +
    +
    DIRECTION_BIDIRECTIONAL = 'BIDIRECTIONAL'
    @@ -18221,6 +58771,41 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of PortMirroringSession or None) – Port mirroring session results +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -18232,6 +58817,75 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • destinations (list of str or None) – List of destination addresses format: ip
      • +
    • direction (str or None) –

      Possible values are:

      + +
      +
      port mirroring direction
      +
      • +
    • key (long or None) – User-configurable 32-bit key format: int64
      • +
    • snap_length (long or None) – If this property not set, original package will not be truncated. +format: int64
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • required_capabilities (list of str or None) –
      • +
    +
    DIRECTION_BIDIRECTIONAL = 'BIDIRECTIONAL'
    @@ -18259,6 +58913,14 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:device_name (str) – Name of the virtual tunnel endpoint
    @@ -18271,6 +58933,19 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • endpoints (list of PreconfiguredEndpoint or None) – List of virtual tunnel endpoints which are preconfigured on this +host switch
      • +
    • host_switch_id (str) – External Id of the preconfigured host switch.
      • +
    +
    @@ -18285,6 +58960,23 @@ is provided to NSX. This type is only valid for supported KVM fabric nodes.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    @@ -18296,6 +58988,28 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • action (str) –

      Possible values are:

      + +
      +
      Action for the IPPrefix
      +
      • +
    • ge (long or None) – Greater than or equal to format: int64
      • +
    • le (long or None) – Less than or equal to format: int64
      • +
    • network (str or None) – If absent, the action applies to all addresses. format: +ipv4-cidr-block
      • +
    +
    ACTION_DENY = 'DENY'
    @@ -18308,6 +59022,179 @@ names.

    +
    +
    +class com.vmware.nsx_policy.model_client.PrefixEntry(action=None, network=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Network prefix entry

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters: +
    +
    +
    +ACTION_DENY = 'DENY'
    +
    + +
    +
    +ACTION_PERMIT = 'PERMIT'
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.model_client.PrefixList(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, prefixes=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    A named list of prefixes for routing purposes.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • prefixes (list of PrefixEntry) – Specify ordered list of network prefixes.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.PrefixListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Paged collection of PrefixLists

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of PrefixList) – PrefixList results
      • +
    +
    +
    +
    class com.vmware.nsx_policy.model_client.Principal(attributes=None)
    @@ -18317,6 +59204,14 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:attributes (list of KeyValue) – Certificate list
    @@ -18328,6 +59223,77 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • certificate_id (str) – Id of the stored certificate
      • +
    • is_protected (bool or None) – Indicator whether the entities created by this principal should be +protected
      • +
    • name (str) – Name of the principal
      • +
    • node_id (str) – Unique node-id of a principal
      • +
    • permission_group (str or None) –

      Possible values are:

      + +

      Use the ‘role’ field instead and pass in ‘auditor’ for +read_only_api_users or ‘enterprise_admin’ for the others.

      +
      • +
    • role (str or None) – Role
      • +
    +
    PERMISSION_GROUP_READ_ONLY_API_USERS = 'read_only_api_users'
    @@ -18360,6 +59326,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of PrincipalIdentity) – PrincipalIdentity list
      • +
    +
    @@ -18373,6 +59372,57 @@ between two processes.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • dest_element_id (str or None) – Unique element ID of destination element to which the connection is +established. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • number_of_events (long or None) – Represents the number of events/flows between the source and +destination elements. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • src_element_id (str or None) – Unique element ID of source element from which the connection is +established. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • dest_port (long or None) – Port number of the destination process to which the connection is +established by source processes. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • latency (long or None) – Time taken for a packet of data to get from source process to +destination process. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • packets_rx (long or None) – Packets received by destination process format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • packets_tx (long or None) – Packets transmitted by source process format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protocol (str or None) –

      Possible values are:

      + +

      Type of protocol used by the processes for communication. Protocol +type can be TCP, UDP or Invalid. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    • source_ports (list of long or None) – List of port numbers of all the source processes establishing a +connection with destination process. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    PROTOCOL_INVALID = 'INVALID'
    @@ -18401,16 +59451,81 @@ information related to the process.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    +
    +
    +RESOURCE_TYPE_EDGENODEELEMENT = 'EdgeNodeElement'
    +
    +
    RESOURCE_TYPE_GROUPELEMENT = 'GroupElement'
    +
    +
    +RESOURCE_TYPE_HOSTNODEELEMENT = 'HostNodeElement'
    +
    + +
    +
    +RESOURCE_TYPE_LBVIRTUALSERVERELEMENT = 'LBVirtualServerElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOADBALANCERSERVICEELEMENT = 'LoadBalancerServiceElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALROUTERPORTELEMENT = 'LogicalRouterPortElement'
    +
    +
    RESOURCE_TYPE_LOGICALSWITCHELEMENT = 'LogicalSwitchElement'
    +
    +
    +RESOURCE_TYPE_LOGICALSWITCHPORTELEMENT = 'LogicalSwitchPortElement'
    +
    +
    RESOURCE_TYPE_LOGICALT0ROUTERELEMENT = 'LogicalT0RouterElement'
    @@ -18426,6 +59541,11 @@ names.

    RESOURCE_TYPE_PROCESSELEMENT = 'ProcessElement'
    +
    +
    +RESOURCE_TYPE_VIRTUALNETWORKINTERFACEELEMENT = 'VirtualNetworkInterfaceElement'
    +
    +
    RESOURCE_TYPE_VMELEMENT = 'VMElement'
    @@ -18443,6 +59563,33 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • condition (str or None) – If the condition is met then the property will be displayed. +Examples of expression syntax are provided under ‘example_request’ +section of ‘CreateWidgetConfiguration’ API.
      • +
    • field (str) – Represents field value of the property.
      • +
    • heading (bool or None) – Set to true if the field is a heading. Default is false.
      • +
    • label (Label or None) – If a field represents a heading, then label is not needed
      • +
    • render_configuration (list of RenderConfiguration or None) – Render configuration to be applied, if any.
      • +
    • type (str) –

      Possible values are:

      + +
      +
      Data type of the field.
      +
      • +
    +
    TYPE_DATE = 'Date'
    @@ -18465,88 +59612,6 @@ names.

    -
    -
    -class com.vmware.nsx_policy.model_client.Provider(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, force_whitelisting=None, ha_mode=None, transit_subnet=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Provider configuration for external connectivity

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    -HA_MODE_ACTIVE = 'ACTIVE_ACTIVE'
    -
    - -
    -
    -HA_MODE_STANDBY = 'ACTIVE_STANDBY'
    -
    - -
    - -
    -
    -class com.vmware.nsx_policy.model_client.ProviderDeploymentMap(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, enforcement_point=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Associate provider to the enforcement point to realize policy intent

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    - -
    -
    -class com.vmware.nsx_policy.model_client.ProviderDeploymentMapListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Paged Collection of Provider Deployment map

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    - -
    -
    -class com.vmware.nsx_policy.model_client.ProviderInterface(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, subnets=None, edge_cluster_member_index=None, ls_id=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Provider interface configuration for external connectivity

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    - -
    -
    -class com.vmware.nsx_policy.model_client.ProviderInterfaceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Paged collection of Provider Interfaces

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    - -
    -
    -class com.vmware.nsx_policy.model_client.ProviderListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Paged collection of Providers

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    class com.vmware.nsx_policy.model_client.PublicCloudGatewayNode(allocation_list=None, deployment_config=None, deployment_type=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, discovered_ip_addresses=None, external_id=None, fqdn=None, ip_addresses=None)
    @@ -18556,6 +59621,92 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • allocation_list (list of str or None) – List of logical router ids to which this edge node is allocated. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • deployment_config (EdgeNodeDeploymentConfig or None) – When this configuration is specified, edge fabric node of +deployment_type VIRTUAL_MACHINE will be deployed and registered +with MP.
      • +
    • deployment_type (str or None) –

      Possible values are:

      + +
      +
      Supported edge deployment type.
      +

      This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) – Fabric node type, for example ‘HostNode’, ‘EdgeNode’ or +‘PublicCloudGatewayNode’
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • discovered_ip_addresses (list of str or None) – Discovered IP Addresses of the fabric node, version 4 or 6 format: +ip +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • external_id (str or None) – ID of the Node maintained on the Node and used to recognize the +Node
      • +
    • fqdn (str or None) – Fully qualified domain name of the fabric node +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • ip_addresses (list of str or None) – IP Addresses of the Node, version 4 or 6. This property is +mandatory for all nodes except for automatic deployment of edge +virtual machine node. For automatic deployment, the ip address from +management_port_subnets property will be considered. format: ip
      • +
    +
    @@ -18568,6 +59719,24 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    RESOURCE_TYPE_EGRESSRATESHAPER = 'EgressRateShaper'
    @@ -18594,6 +59763,65 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • class_of_service (long or None) – Class of service format: int32
      • +
    • dscp (Dscp or None) –
      • +
    • shaper_configuration (list of QosBaseRateShaper or None) –
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • required_capabilities (list of str or None) –
      • +
    +
    @@ -18605,6 +59833,26 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • result_count (long) – Result count format: int64
      • +
    • results (list of TypeGroup) – Search results
      • +
    +
    @@ -18618,6 +59866,25 @@ packets. Use 0 to disable rate limiting for a specific traffic type

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • enabled (bool or None) – Whether rate limiting is enabled
      • +
    • rx_broadcast (long or None) – Incoming broadcast traffic limit in packets per second format: +int32
      • +
    • rx_multicast (long or None) – Incoming multicast traffic limit in packets per second format: +int32
      • +
    • tx_broadcast (long or None) – Outgoing broadcast traffic limit in packets per second format: +int32
      • +
    • tx_multicast (long or None) – Outgoing multicast traffic limit in packets per second format: +int32
      • +
    +
    @@ -18630,6 +59897,32 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • interval (long) – The interval in milliseconds used for auto incrementing the barrier +number format: int64
      • +
    +
    @@ -18642,6 +59935,102 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • alarms (list of PolicyAlarmResource or None) – Alarm info detail
      • +
    • intent_reference (list of str or None) – Desire state paths of this object
      • +
    • realization_specific_identifier (str or None) – Realization id of this object
      • +
    • runtime_status (str or None) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is +not exhaustive.
      • +
    • state (str) –

      Possible values are:

      + +
      +
      Realization state of this object
      +
      • +
    • message (str or None) – This property displays the detailed message of the current status +of discovery session. The reason for failure will be displayed in +case of FAILED status.
      • +
    • status (str or None) –

      Possible values are:

      + +
      +
      Status of discovery session
      +
      • +
    • timestamp (long or None) – Timestamp when the data was collected. Unset if the discovery +session has started or in-progress or failed state. format: int64
      • +
    • topology (Topology or None) – Topology
      • +
    +
    STATE_ERROR = 'ERROR'
    @@ -18699,6 +60088,88 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • alarms (list of PolicyAlarmResource or None) – Alarm info detail
      • +
    • intent_reference (list of str or None) – Desire state paths of this object
      • +
    • realization_specific_identifier (str or None) – Realization id of this object
      • +
    • runtime_status (str or None) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is +not exhaustive.
      • +
    • state (str) –

      Possible values are:

      + +
      +
      Realization state of this object
      +
      • +
    • realized_firewalls (RealizedFirewalls or None) – Root of Realized Firewalls
      • +
    • realized_groups (RealizedGroups or None) – Root of Realized Groups
      • +
    • realized_services (RealizedServices or None) – Root of Realized Services
      • +
    +
    STATE_ERROR = 'ERROR'
    @@ -18730,6 +60201,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of RealizedEnforcementPoint or None) – Paged Collection of Enforcement Point’s
      • +
    +
    @@ -18742,6 +60246,89 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • alarms (list of PolicyAlarmResource or None) – Alarm info detail
      • +
    • intent_reference (list of str or None) – Desire state paths of this object
      • +
    • realization_specific_identifier (str or None) – Realization id of this object
      • +
    • runtime_status (str or None) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is +not exhaustive.
      • +
    • state (str) –

      Possible values are:

      + +
      +
      Realization state of this object
      +
      • +
    +
    RESOURCE_TYPE_REALIZEDFIREWALLSECTION = 'RealizedFirewallSection'
    @@ -18779,6 +60366,121 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • alarms (list of PolicyAlarmResource or None) – Alarm info detail
      • +
    • intent_reference (list of str or None) – Desire state paths of this object
      • +
    • realization_specific_identifier (str or None) – Realization id of this object
      • +
    • runtime_status (str or None) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is +not exhaustive.
      • +
    • state (str) –

      Possible values are:

      + +
      +
      Realization state of this object
      +
      • +
    • action (str or None) –

      Possible values are:

      + +
      +
      Action enforced on the packets which matches the firewall rule.
      +

      This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    • destinations (list of ResourceReference or None) – List of the destinations. Null will be treated as any. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • direction (str or None) –

      Possible values are:

      + +

      Rule direction in case of stateless firewall rules. This will only +considered if section level parameter is set to stateless. Default +to IN_OUT if not specified. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    • disabled (bool or None) – Flag to disable rule. Disabled will only be persisted but never +provisioned/realized. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • services (list of ResourceReference or None) – List of the services. Null will be treated as any. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sources (list of ResourceReference or None) – List of sources. Null will be treated as any. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    ACTION_ALLOW = 'ALLOW'
    @@ -18841,6 +60543,105 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • rule_count (long or None) – Number of rules in this section. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • rules (list of RealizedFirewallRule or None) – List of firewall rules in the section. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • section_type (str or None) –

      Possible values are:

      + +
      +
      Type of the rules which a section can contain.
      +

      This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • alarms (list of PolicyAlarmResource or None) – Alarm info detail
      • +
    • intent_reference (list of str or None) – Desire state paths of this object
      • +
    • realization_specific_identifier (str or None) – Realization id of this object
      • +
    • runtime_status (str or None) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is +not exhaustive.
      • +
    • state (str) –

      Possible values are:

      + +
      +
      Realization state of this object
      +
      • +
    +
    SECTION_TYPE_LAYER2 = 'LAYER2'
    @@ -18862,6 +60663,41 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of RealizedFirewallSection or None) – Paged Collection of firewall sections +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -18874,6 +60710,87 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • intent_communication_map (CommunicationMap or None) –
      • +
    • realized_firewall_sections (list of vmware.vapi.struct.VapiStruct) – Realized firewall sections associated to the communication map +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +RealizedFirewall. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in RealizedFirewall.
      • +
    +
    @@ -18886,6 +60803,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of RealizedFirewallUIResource) – communication map and realized firewall sections list results
      • +
    +
    @@ -18898,6 +60848,93 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • alarms (list of PolicyAlarmResource or None) – Alarm info detail
      • +
    • intent_reference (list of str or None) – Desire state paths of this object
      • +
    • realization_specific_identifier (str or None) – Realization id of this object
      • +
    • runtime_status (str or None) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is +not exhaustive.
      • +
    • state (str) –

      Possible values are:

      + +
      +
      Realization state of this object
      +
      • +
    • realized_firewalls (list of vmware.vapi.struct.VapiStruct or None) – list of realized firewalls +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +RealizedFirewall. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in RealizedFirewall. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    STATE_ERROR = 'ERROR'
    @@ -18930,6 +60967,90 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • alarms (list of PolicyAlarmResource or None) – Alarm info detail
      • +
    • intent_reference (list of str or None) – Desire state paths of this object
      • +
    • realization_specific_identifier (str or None) – Realization id of this object
      • +
    • runtime_status (str or None) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is +not exhaustive.
      • +
    • state (str) –

      Possible values are:

      + +
      +
      Realization state of this object
      +
      • +
    +
    RESOURCE_TYPE_REALIZEDNSGROUP = 'RealizedNSGroup'
    @@ -18972,6 +61093,82 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • intent_group (Group or None) –
      • +
    • realized_groups (list of GenericPolicyRealizedResource) – Realized groups associated to the intent group
      • +
    +
    @@ -18984,6 +61181,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of RealizedGroupUIResource) – Intent and realized group list results
      • +
    +
    @@ -18996,6 +61226,93 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • alarms (list of PolicyAlarmResource or None) – Alarm info detail
      • +
    • intent_reference (list of str or None) – Desire state paths of this object
      • +
    • realization_specific_identifier (str or None) – Realization id of this object
      • +
    • runtime_status (str or None) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is +not exhaustive.
      • +
    • state (str) –

      Possible values are:

      + +
      +
      Realization state of this object
      +
      • +
    • realized_groups (list of vmware.vapi.struct.VapiStruct or None) – list of realized groups +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +RealizedGroup. When methods return a value of this class +as a return value, the attribute will contain all the attributes +defined in RealizedGroup. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    STATE_ERROR = 'ERROR'
    @@ -19028,6 +61345,85 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • alarms (list of PolicyAlarmResource or None) – Alarm info detail
      • +
    • intent_reference (list of str or None) – Desire state paths of this object
      • +
    • realization_specific_identifier (str or None) – Realization id of this object
      • +
    • runtime_status (str or None) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is +not exhaustive.
      • +
    • state (str) –

      Possible values are:

      + +
      +
      Realization state of this object
      +
      • +
    +
    STATE_ERROR = 'ERROR'
    @@ -19059,6 +61455,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of RealizedIPSet or None) – Paged Collection of Realized IPSets
      • +
    +
    @@ -19071,6 +61500,99 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • alarms (list of PolicyAlarmResource or None) – Alarm info detail
      • +
    • intent_reference (list of str or None) – Desire state paths of this object
      • +
    • realization_specific_identifier (str or None) – Realization id of this object
      • +
    • runtime_status (str or None) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is +not exhaustive.
      • +
    • state (str) –

      Possible values are:

      + +
      +
      Realization state of this object
      +
      • +
    • logical_port_id (str or None) – The id of the logical port +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • status (str or None) –

      Possible values are:

      + +
      +
      The Operational status of the logical port
      +

      This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    +
    STATE_ERROR = 'ERROR'
    @@ -19118,6 +61640,91 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • alarms (list of PolicyAlarmResource or None) – Alarm info detail
      • +
    • intent_reference (list of str or None) – Desire state paths of this object
      • +
    • realization_specific_identifier (str or None) – Realization id of this object
      • +
    • runtime_status (str or None) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is +not exhaustive.
      • +
    • state (str) –

      Possible values are:

      + +
      +
      Realization state of this object
      +
      • +
    • logical_switch_id (str or None) – Id of the logical switch +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • transport_zone_id (str or None) – Transport zone identifier +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    STATE_ERROR = 'ERROR'
    @@ -19150,6 +61757,85 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • alarms (list of PolicyAlarmResource or None) – Alarm info detail
      • +
    • intent_reference (list of str or None) – Desire state paths of this object
      • +
    • realization_specific_identifier (str or None) – Realization id of this object
      • +
    • runtime_status (str or None) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is +not exhaustive.
      • +
    • state (str) –

      Possible values are:

      + +
      +
      Realization state of this object
      +
      • +
    +
    STATE_ERROR = 'ERROR'
    @@ -19181,6 +61867,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of RealizedMACSet or None) – Paged Collection of Realized MACSets
      • +
    +
    @@ -19193,6 +61912,93 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • evaluations (list of RealizedNSGroupMemberEvaluation or None) – Reference to the evaluated members of the NSGroup. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • alarms (list of PolicyAlarmResource or None) – Alarm info detail
      • +
    • intent_reference (list of str or None) – Desire state paths of this object
      • +
    • realization_specific_identifier (str or None) – Realization id of this object
      • +
    • runtime_status (str or None) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is +not exhaustive.
      • +
    • state (str) –

      Possible values are:

      + +
      +
      Realization state of this object
      +
      • +
    +
    @@ -19204,6 +62010,41 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of RealizedNSGroup or None) – Paged Collection of realized NSGroups +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -19216,6 +62057,97 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • alarms (list of PolicyAlarmResource or None) – Alarm info detail
      • +
    • intent_reference (list of str or None) – Desire state paths of this object
      • +
    • realization_specific_identifier (str or None) – Realization id of this object
      • +
    • runtime_status (str or None) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is +not exhaustive.
      • +
    • state (str) –

      Possible values are:

      + +
      +
      Realization state of this object
      +
      • +
    • logical_ports (list of RealizedLogicalPort or None) – list of logical ports +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • logical_switches (list of RealizedLogicalSwitch or None) – list of logical switches +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • member_count (long or None) – Count of the members added to this NSGroup format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • virtual_machines (list of RealizedVirtualMachine or None) – list of virtual machines +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    STATE_ERROR = 'ERROR'
    @@ -19248,6 +62180,101 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • service_type (str or None) –

      Possible values are:

      + +
      +
      Realized nsservice type
      +

      This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      +
      Realized services
      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • alarms (list of PolicyAlarmResource or None) – Alarm info detail
      • +
    • intent_reference (list of str or None) – Desire state paths of this object
      • +
    • realization_specific_identifier (str or None) – Realization id of this object
      • +
    • runtime_status (str or None) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is +not exhaustive.
      • +
    • state (str) –

      Possible values are:

      + +
      +
      Realization state of this object
      +
      • +
    +
    SERVICE_TYPE_SERVICE = 'SERVICE'
    @@ -19269,6 +62296,41 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of RealizedNSService or None) – Paged Collection of realized services +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -19281,6 +62343,93 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • evaluations (list of RealizedSecurityGroupMemberEvaluation or None) – Reference to the evaluted members of the Security Group. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • alarms (list of PolicyAlarmResource or None) – Alarm info detail
      • +
    • intent_reference (list of str or None) – Desire state paths of this object
      • +
    • realization_specific_identifier (str or None) – Realization id of this object
      • +
    • runtime_status (str or None) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is +not exhaustive.
      • +
    • state (str) –

      Possible values are:

      + +
      +
      Realization state of this object
      +
      • +
    +
    @@ -19292,6 +62441,41 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of RealizedSecurityGroup or None) – Paged Collection of realized Security Groups +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -19304,6 +62488,91 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • alarms (list of PolicyAlarmResource or None) – Alarm info detail
      • +
    • intent_reference (list of str or None) – Desire state paths of this object
      • +
    • realization_specific_identifier (str or None) – Realization id of this object
      • +
    • runtime_status (str or None) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is +not exhaustive.
      • +
    • state (str) –

      Possible values are:

      + +
      +
      Realization state of this object
      +
      • +
    • member_count (long or None) – Count of the members added to this Security Group format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • virtual_machines (list of RealizedVirtualMachine or None) – list of virtual machines +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    STATE_ERROR = 'ERROR'
    @@ -19336,6 +62605,91 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      +
      Realized services
      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • alarms (list of PolicyAlarmResource or None) – Alarm info detail
      • +
    • intent_reference (list of str or None) – Desire state paths of this object
      • +
    • realization_specific_identifier (str or None) – Realization id of this object
      • +
    • runtime_status (str or None) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is +not exhaustive.
      • +
    • state (str) –

      Possible values are:

      + +
      +
      Realization state of this object
      +
      • +
    +
    RESOURCE_TYPE_REALIZEDNSSERVICE = 'RealizedNSService'
    @@ -19373,6 +62727,93 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • alarms (list of PolicyAlarmResource or None) – Alarm info detail
      • +
    • intent_reference (list of str or None) – Desire state paths of this object
      • +
    • realization_specific_identifier (str or None) – Realization id of this object
      • +
    • runtime_status (str or None) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is +not exhaustive.
      • +
    • state (str) –

      Possible values are:

      + +
      +
      Realization state of this object
      +
      • +
    • realized_services (list of vmware.vapi.struct.VapiStruct or None) – List of realized services +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +RealizedService. When methods return a value of this class +as a return value, the attribute will contain all the attributes +defined in RealizedService. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    STATE_ERROR = 'ERROR'
    @@ -19405,6 +62846,86 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • alarms (list of PolicyAlarmResource or None) – Alarm info detail
      • +
    • intent_reference (list of str or None) – Desire state paths of this object
      • +
    • realization_specific_identifier (str or None) – Realization id of this object
      • +
    • runtime_status (str or None) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is +not exhaustive.
      • +
    • state (str) –

      Possible values are:

      + +
      +
      Realization state of this object
      +
      • +
    • enforcement_points (list of RealizedEnforcementPoint or None) – Enforcement points for realized policy
      • +
    +
    STATE_ERROR = 'ERROR'
    @@ -19437,6 +62958,109 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • alarms (list of PolicyAlarmResource or None) – Alarm info detail
      • +
    • intent_reference (list of str or None) – Desire state paths of this object
      • +
    • realization_specific_identifier (str or None) – Realization id of this object
      • +
    • runtime_status (str or None) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is +not exhaustive.
      • +
    • state (str) –

      Possible values are:

      + +
      +
      Realization state of this object
      +
      • +
    • compute_ids (list of str or None) – List of external compute ids of the virtual machine in the format +‘id-type-key:value’ , list of external compute ids +[‘uuid:xxxx-xxxx-xxxx-xxxx’, ‘moIdOnHost:moref-11’, +‘instanceUuid:xxxx-xxxx-xxxx-xxxx’] +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • host_id (str or None) – Id of the host on which the vm exists. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • local_id_on_host (str or None) – Id of the vm unique within the host. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • power_state (str or None) –

      Possible values are:

      + +
      +
      Current power state of this virtual machine in the system.
      +

      This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    +
    POWER_STATE_UNKNOWN = 'UNKNOWN'
    @@ -19488,11 +63112,191 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of RealizedVirtualMachine or None) – Paged Collection of VMs
      • +
    +
    -
    -class com.vmware.nsx_policy.model_client.RedirectionCommunicationEntry(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, action=None, destination_groups=None, logged=None, scope=None, sequence_number=None, services=None, source_groups=None)
    +
    +class com.vmware.nsx_policy.model_client.RedirectionPolicy(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, category=None, rules=None, sequence_number=None, redirect_to=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Ordered list of redirection rules along with paths of redirection targets +to which the traffic needs to be redirected.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • category (str or None) – Policy framework provides four pre-defined categories for +classifying a security policy. They are "Emergency", +"Infrastructure" "Environmental" and +"Application". There is a pre-determined order in which the +policy framework manages the priority of these security policies. +Emergency category has the highest priority followed by +Infrastructure, Environmental and then Application rules. +Administrator can choose to categorize a security policy into the +above categories or can choose to leave it empty. If empty it will +have the least precedence w.r.t the above four categories.
      • +
    • rules (list of RedirectionRule or None) – RedirectionRules that are a part of this RedirectionPolicy
      • +
    • sequence_number (long or None) –
      • +
    • redirect_to (list of str) – List of paths to redirection targets. Valid redirection targets +could be PolicyServiceInstance, VirtualEndpoint or +ServiceInstanceEndpoint.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.RedirectionPolicyListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Paged Collection of Redirection Policies

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of SecurityPolicy) – SecurityPolicy list results
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.RedirectionRule(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, action=None, destination_groups=None, logged=None, scope=None, sequence_number=None, services=None, source_groups=None, direction=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    It define redirection rule for service insertion

    @@ -19500,53 +63304,187 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • action (str or None) –

      Possible values are:

      + +
      +
      The action to be applied to all the services
      +
      • +
    • destination_groups (list of str or None) – We need paths as duplicate names may exist for groups under +different domains.In order to specify all groups, use the constant +"ANY". This is case insensitive. If "ANY" is used, +it should be the ONLY element in the group array. Error will be +thrown if ANY is used in conjunction with other values.
      • +
    • logged (bool or None) – Flag to enable packet logging. Default is disabled.
      • +
    • scope (list of str or None) – The list of policy paths where the rule is applied +LR/Edge/T0/T1/LRP etc. Note that a given rule can be applied on +multiple LRs/LRPs.
      • +
    • sequence_number (long or None) – This field is used to resolve conflicts between multiple Rules +under Security or Gateway Policy for a Domain format: int32
      • +
    • services (list of str or None) – In order to specify all services, use the constant "ANY". +This is case insensitive. If "ANY" is used, it should be +the ONLY element in the services array. Error will be thrown if ANY +is used in conjunction with other values.
      • +
    • source_groups (list of str or None) – We need paths as duplicate names may exist for groups under +different domains. In order to specify all groups, use the constant +"ANY". This is case insensitive. If "ANY" is used, +it should be the ONLY element in the group array. Error will be +thrown if ANY is used in conjunction with other values.
      • +
    • direction (str or None) –

      Possible values are:

      + +
      +
      Define direction of traffic
      +
      • +
    +
    -
    -ACTION_DO_NOT_REDIRECT = 'DO_NOT_REDIRECT'
    +
    +ACTION_DO_NOT_REDIRECT = 'DO_NOT_REDIRECT'
    -
    -ACTION_REDIRECT = 'REDIRECT'
    +
    +ACTION_REDIRECT = 'REDIRECT'
    +
    + +
    +
    +DIRECTION_IN = 'IN'
    +
    + +
    +
    +DIRECTION_IN_OUT = 'IN_OUT'
    +
    + +
    +
    +DIRECTION_OUT = 'OUT'
    -
    -class com.vmware.nsx_policy.model_client.RedirectionCommunicationEntryListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    +
    +class com.vmware.nsx_policy.model_client.RedirectionRuleListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Paged Collection of RedirectionCommunicationEntries

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    - -
    -
    -class com.vmware.nsx_policy.model_client.RedirectionCommunicationMap(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, category=None, communication_entries=None, precedence=None, redirect_to=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Ordered list of CommunicationEntries long with the path of -PolicyServiceInstance to which the traffic needs to be redirected.

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    - -
    -
    -class com.vmware.nsx_policy.model_client.RedirectionCommunicationMapListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Paged Collection of Groups

    +

    Paged Collection of RedirectionRules

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of Rule) – Rule list results
      • +
    +
    @@ -19558,6 +63496,65 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • bgp_enabled (bool or None) – Flag to enable redistribution for BGP as destinationProtocol
      • +
    • logical_router_id (str or None) – Logical router id +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -19569,6 +63566,47 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    DESTINATION_BGP = 'BGP'
    @@ -19660,6 +63698,66 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • logical_router_id (str or None) – Logical router id +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • rules (list of RedistributionRule or None) – List of redistribution rules. User needs to re-order rules to +change the priority.
      • +
    +
    @@ -19672,6 +63770,45 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • roles (list of str) – List results
      • +
    • token (str) – Access token
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.RelatedApiError(details=None, error_code=None, error_data=None, error_message=None, module_name=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Detailed information about a related API error

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • details (str or None) – Further details about the error
      • +
    • error_code (long or None) – A numeric error code format: int64
      • +
    • error_data (vmware.vapi.struct.VapiStruct or None) – Additional data about the error
      • +
    • error_message (str or None) – A description of the error
      • +
    • module_name (str or None) – The module name where the error occurred
      • +
    +
    @@ -19686,6 +63823,14 @@ related attribute of sourceGroups in communcation entry.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:attribute (str) – Related attribute name on the target entity.
    @@ -19715,6 +63860,71 @@ allow only values "HTTPS", "HTTP" for attribute X. {

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • condition (ConditionalValueConstraintExpression) – Conditional value expression for target based on realted attribute +value.
      • +
    • related_attribute (RelatedAttribute) – Related attribute.
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    +
    @@ -19727,6 +63937,40 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • alias (str or None) – Alias for the related type
      • +
    • results (list of vmware.vapi.struct.VapiStruct) – Array of related objects
      • +
    +
    @@ -19739,6 +63983,27 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • included_fields (str or None) – Comma separated list of fields that should be included in query +result
      • +
    • alias (str or None) – Alias for the response
      • +
    • filters (list of FilterRequest or None) – An array of filter conditions
      • +
    • resource_type (str) – Resource type name
      • +
    • join_condition (str) – Join condition between the parent and the related object. This is +to be specified in +"relatedObjectFieldName:ParentObjectFieldName" format.
      • +
    • size (long or None) – Number of related objects to return. If not specified all the +related objects will be returned. Should be set to 0 if only the +count of related objects is desired. format: int64
      • +
    +
    @@ -19751,6 +64016,20 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • directory_path (str) – Remote server directory to copy bundle files to
      • +
    • port (long or None) – Server port format: int64
      • +
    • protocol (FileTransferProtocol) – Protocol to use to copy file
      • +
    • server (str) – Remote server hostname or IP address format: hostname-or-ip
      • +
    +
    @@ -19763,6 +64042,19 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • port (long or None) – Server port format: int64
      • +
    • server (str) – Remote server hostname or IP address format: hostname-or-ip
      • +
    • ssh_fingerprint (str) – SSH fingerprint of server
      • +
    +
    @@ -19775,6 +64067,18 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • port (long or None) – Server port format: int64
      • +
    • server (str) – Remote server hostname or IP address format: hostname-or-ip
      • +
    +
    @@ -19787,6 +64091,38 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • color (str or None) –

      Possible values are:

      + +

      The color to use when rendering an entity. For example, set color +as ‘RED’ to render a portion of donut in red.

      +
      • +
    • condition (str or None) – If the condition is met then the rendering specified for the +condition will be applied. Examples of expression syntax are +provided under ‘example_request’ section of +‘CreateWidgetConfiguration’ API.
      • +
    • display_value (str or None) – If specified, overrides the field value. This can be used to +display a meaningful value in situations where field value is not +available or not configured.
      • +
    • icons (list of Icon or None) – Icons to be applied at dashboard for widgets and UI elements.
      • +
    • tooltip (list of Tooltip or None) – Multi-line text to be shown on tooltip while hovering over the UI +element if the condition is met.
      • +
    +
    COLOR_BLUE = 'BLUE'
    @@ -19829,6 +64165,24 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    +
    @@ -19845,6 +64199,24 @@ rejected.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • limit (float) – The limit property specifies the maximum bandwidth allocation for a +given traffic type and is expressed in percentage. The default +value for this field is set to -1 which means the traffic is +unbounded for the traffic type. All other negative values for this +property is not supported and will be rejected by the API.
      • +
    • reservation (float) – Minimum guaranteed bandwidth percentage
      • +
    • shares (long) – Shares format: int32
      • +
    • traffic_type (HostInfraTrafficType) – Resource allocation traffic type
      • +
    +
    @@ -19857,6 +64229,26 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • action (str or None) – Optional action +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • href (str or None) – Link to resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • rel (str or None) – Custom relation type (follows RFC 5988 where appropriate +definitions exist) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -19869,6 +64261,25 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • is_valid (bool or None) – Will be set to false if the referenced NSX resource has been +deleted. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • target_display_name (str or None) – Display name of the NSX resource. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • target_id (str or None) – Identifier of the NSX resource.
      • +
    • target_type (str or None) – Type of the NSX resource.
      • +
    +
    @@ -19881,6 +64292,18 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • passphrase (str or None) – Passphrase used to encrypt backup files.
      • +
    • remote_file_server (RemoteFileServer) – The server from which backup files will be retrieved for restore.
      • +
    +
    @@ -19893,6 +64316,26 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • description (str or None) – Restore step description +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • status (PerStepRestoreStatus or None) –
      • +
    • step_number (long or None) – Restore step number format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • value (str or None) – Restore step value +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -19905,17 +64348,30 @@ names.

    The arguments are used to initialize data attributes with the same names.

    -
    - -
    -
    -class com.vmware.nsx_policy.model_client.RevokeNodeRequest(hosts=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    +
    @@ -19927,11 +64383,19 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:role (str) – Role name
    -class com.vmware.nsx_policy.model_client.RoleBinding(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, name=None, roles=None, type=None)
    +class com.vmware.nsx_policy.model_client.RoleBinding(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, name=None, roles=None, stale=None, type=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    User/Group’s role binding

    @@ -19939,6 +64403,110 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • name (str or None) – User/Group’s name +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • roles (list of Role or None) – Roles +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • stale (str or None) –

      Possible values are:

      + +

      Property ‘stale’ can be considered to have these values - absent - +This type of rolebinding does not support stale property TRUE - +Rolebinding is stale in vIDM meaning the user is no longer present +in vIDM FALSE - Rolebinding is available in vIDM UNKNOWN - +Rolebinding’s state of staleness in unknown Once rolebindings +become stale, they can be deleted using the API POST +/aaa/role-bindings?action=delete_stale_bindings +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    • type (str or None) –

      Possible values are:

      + +
      +
      Type
      +

      This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    +
    +
    +
    +STALE_FALSE = 'FALSE'
    +
    + +
    +
    +STALE_TRUE = 'TRUE'
    +
    + +
    +
    +STALE_UNKNOWN = 'UNKNOWN'
    +
    +
    TYPE_LOCAL_USER = 'local_user'
    @@ -19970,6 +64538,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of RoleBinding) – List results
      • +
    +
    @@ -19981,6 +64582,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of Role) – List results
      • +
    +
    @@ -19993,6 +64627,46 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • features (list of FeaturePermission) – Features
      • +
    • role (str or None) – Role name +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.RouteAggregationEntry(prefix=None, summary_only=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    List of routes to be aggregated

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • prefix (str) – CIDR of aggregate address format: ip-cidr-block
      • +
    • summary_only (bool or None) – Send only summarized route. Summarization reduces number of routes +advertised by representing multiple related routes with prefix +property.
      • +
    +
    @@ -20009,11 +64683,86 @@ VPN session to remote site.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • tunnel_ports (list of TunnelPortConfig) – IP Tunnel ports.
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      A Policy Based VPN requires to define protect rules that match +local and peer subnets. IPSec security associations is negotiated +for each pair of local and peer subnet. A Route Based VPN is more +flexible, more powerful and recommended over policy based VPN. IP +Tunnel port is created and all traffic routed via tunnel port is +protected. Routes can be configured statically or can be learned +through BGP. A route based VPN is must for establishing redundant +VPN session to remote site.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • enabled (bool or None) – Enable/Disable IPSec VPN session.
      • +
    • ipsec_vpn_service_id (str or None) – Identifier of VPN Service linked with local endpoint. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • local_endpoint_id (str) – Local endpoint identifier.
      • +
    • peer_endpoint_id (str) – Peer endpoint identifier.
      • +
    +
    -class com.vmware.nsx_policy.model_client.RouteBasedL3VpnSession(routing_config_path=None, tunnel_subnets=None, resource_type='RouteBasedL3VpnSession')
    +class com.vmware.nsx_policy.model_client.RouteBasedL3VpnSession(default_rule_logging=None, force_whitelisting=None, routing_config_path=None, tunnel_subnets=None, resource_type='RouteBasedL3VpnSession')

    Bases: vmware.vapi.bindings.struct.VapiStruct

    A Route Based L3Vpn is more flexible, more powerful and recommended over policy based. IP Tunnel subnet is created and all traffic routed through @@ -20024,6 +64773,43 @@ route based L3Vpn is required when using redundant L3Vpn.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • default_rule_logging (bool or None) – Indicates if logging should be enabled for the default whitelisting +rule for the VTI interface.
      • +
    • force_whitelisting (bool or None) – The default firewall rule Action is set to DROP if true otherwise +set to ALLOW.
      • +
    • routing_config_path (str or None) – Policy path referencing the bgp neighbor for a route based L3Vpn. - +For an L3Vpn transporting L2Vpn, it is not necessary to provide bgp +neighbor configuration. - For an L3Vpn not transporting L2Vpn, this +property is necessary.
      • +
    • tunnel_subnets (list of TunnelSubnet) – Virtual tunnel interface (VTI) port IP subnets to be used to +configure route-based L3Vpn session. A max of one tunnel subnet is +allowed.
      • +
    • resource_type (str) –

      Possible values are:

      + +
        +
      • A Policy Based L3Vpn is a configuration in which protect rules to
        • +
      +

      match local and remote subnet needs to be defined. Tunnel is +established for each pair of local and remote subnet defined in +protect rules. - A Route Based L3Vpn is more flexible, more +powerful and recommended over policy based. IP Tunnel subnet is +created and all traffic routed through tunnel subnet (commonly +known as VTI) is sent over tunnel. Routes can be learned through +BGP. A route based L3Vpn is required when using redundant L3Vpn.

      +
      • +
    +
    @@ -20035,6 +64821,65 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • logical_router_id (str or None) – Logical router id +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sequences (list of RouteMapSequence) – Ordered list of routeMap sequences
      • +
    +
    @@ -20046,6 +64891,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of RouteMap) – Paginated list of RouteMaps
      • +
    +
    @@ -20057,6 +64935,26 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    ACTION_DENY = 'DENY'
    @@ -20081,6 +64979,20 @@ them must be provided.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • ip_prefix_lists (list of str or None) – IPPrefixList Identifiers for RouteMap Sequence Match Criteria
      • +
    • match_community_expression (CommunityMatchExpression or None) – It supports conjunction operator (AND) and five operators within +singular community match expression (MATCH_ANY, MATCH_ALL, +MATCH_EXACT, MATCH_NONE, MATCH_REGEX).
      • +
    +
    @@ -20092,11 +65004,26 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • as_path_prepend (str or None) – As Path Prepending to influence path selection
      • +
    • community (str or None) – Either well-known community name or community value in +aa:nn(2byte:2byte) format
      • +
    • multi_exit_discriminator (long or None) – Multi Exit Discriminator (MED) format: int64
      • +
    • weight (long or None) – Weight used to select certain path format: int32
      • +
    +
    -class com.vmware.nsx_policy.model_client.RouterNexthop(admin_distance=None, interface_name=None, ip_address=None)
    +class com.vmware.nsx_policy.model_client.RouterNexthop(admin_distance=None, ip_address=None, scope=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    Next hop configuration for network

    @@ -20104,6 +65031,19 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • admin_distance (long or None) – Cost associated with next hop route. format: int32
      • +
    • ip_address (str or None) – Next hop gateway IP address. format: ip
      • +
    • scope (list of str or None) – Interface path associated with current route.
      • +
    +
    @@ -20115,6 +65055,174 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • forwarding_up_timer (long or None) – Defines the extra time the router must wait before sending the UP +notification after the first BGP session is established. Default +means forward immediately. format: int64
      • +
    • logical_router_id (str or None) – Logical router id +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.RoutingEntry(admin_distance=None, network=None, next_hop=None, route_type=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Routing table entry.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • admin_distance (long or None) – Admin distance. format: int32 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • network (str or None) – Network CIDR. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • next_hop (str or None) – Next hop address. format: ip +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • route_type (str or None) – Network address CIDR. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.RoutingTable(count=None, edge_node=None, route_entries=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Routing table.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • count (long or None) – Entry count. format: int32 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • edge_node (str or None) – Transport node ID. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • route_entries (list of RoutingEntry) – Route entries.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.RoutingTableListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of RoutingTable or None) – Paged Collection of Routes per transport node ID.
      • +
    +
    @@ -20127,6 +65235,194 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • alias (str or None) –
      • +
    • path (str) – JSON path to the root of the api result set for forming rows.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.Rule(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, action=None, destination_groups=None, logged=None, scope=None, sequence_number=None, services=None, source_groups=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    A rule indicates the action to be performed for various types of traffic +flowing between workload groups.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • action (str or None) –

      Possible values are:

      + +
      +
      The action to be applied to all the services
      +
      • +
    • destination_groups (list of str or None) – We need paths as duplicate names may exist for groups under +different domains.In order to specify all groups, use the constant +"ANY". This is case insensitive. If "ANY" is used, +it should be the ONLY element in the group array. Error will be +thrown if ANY is used in conjunction with other values.
      • +
    • logged (bool or None) – Flag to enable packet logging. Default is disabled.
      • +
    • scope (list of str or None) – The list of policy paths where the rule is applied +LR/Edge/T0/T1/LRP etc. Note that a given rule can be applied on +multiple LRs/LRPs.
      • +
    • sequence_number (long or None) – This field is used to resolve conflicts between multiple Rules +under Security or Gateway Policy for a Domain format: int32
      • +
    • services (list of str or None) – In order to specify all services, use the constant "ANY". +This is case insensitive. If "ANY" is used, it should be +the ONLY element in the services array. Error will be thrown if ANY +is used in conjunction with other values.
      • +
    • source_groups (list of str or None) – We need paths as duplicate names may exist for groups under +different domains. In order to specify all groups, use the constant +"ANY". This is case insensitive. If "ANY" is used, +it should be the ONLY element in the group array. Error will be +thrown if ANY is used in conjunction with other values.
      • +
    +
    +
    +
    +ACTION_ALLOW = 'ALLOW'
    +
    + +
    +
    +ACTION_DROP = 'DROP'
    +
    + +
    +
    +ACTION_REJECT = 'REJECT'
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.model_client.RuleListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Paged Collection of Rules

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of Rule) – Rule list results
      • +
    +
    @@ -20138,6 +65434,43 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • details (list of ConfigurationStateElement or None) – Array of configuration state of various sub systems +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • failure_code (long or None) – Error code format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • failure_message (str or None) – Error message in case of failure +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • state (str or None) –

      Possible values are:

      + +
      +
      Gives details of state of desired configuration
      +

      This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    • revision_desired (long or None) – revision number of the desired state format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    STATE_FAILED = 'failed'
    @@ -20188,6 +65521,37 @@ few.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    HOST_TYPE_ESXI = 'ESXI'
    @@ -20220,6 +65584,190 @@ names.

    +
    +
    +class com.vmware.nsx_policy.model_client.SavedSearch(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, is_saved=None, query=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • is_saved (bool) – The flag indicates whether the saved query is saved search or +recent search.
      • +
    • query (str) – The search query that is to be saved.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.SavedSearchListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    The results array will contain all the saved or recent search objects.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of SavedSearch) – The list of all saved searches by the user.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.SavedSearchRequest(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, is_saved=None, query=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    The request will contain the query to be saved and the flag indicating +whether it is recent or saved search.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • is_saved (bool) – The flag indicates whether the query is recent or saved search.
      • +
    • query (str) – The search query that has to be saved.
      • +
    +
    +
    +
    class com.vmware.nsx_policy.model_client.SearchResponse(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    @@ -20229,18 +65777,341 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of vmware.vapi.struct.VapiStruct) – Search results
      • +
    +
    -
    -class com.vmware.nsx_policy.model_client.Segment(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, domain_name=None, l2_extension=None, ls_id=None, subnets=None)
    +
    +class com.vmware.nsx_policy.model_client.SecurityPolicy(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, category=None, rules=None, sequence_number=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Segment configuration to attach workloads

    +

    Ordered list of Rules. This object is created by default along with the +Domain.

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • category (str or None) – Policy framework provides four pre-defined categories for +classifying a security policy. They are "Emergency", +"Infrastructure" "Environmental" and +"Application". There is a pre-determined order in which the +policy framework manages the priority of these security policies. +Emergency category has the highest priority followed by +Infrastructure, Environmental and then Application rules. +Administrator can choose to categorize a security policy into the +above categories or can choose to leave it empty. If empty it will +have the least precedence w.r.t the above four categories.
      • +
    • rules (list of Rule or None) – Rules that are a part of this SecurityPolicy
      • +
    • sequence_number (long or None) –
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.SecurityPolicyListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Paged Collection of security policies

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of SecurityPolicy) – SecurityPolicy list results
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.Segment(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, advanced_config=None, domain_name=None, l2_extension=None, ls_id=None, overlay_id=None, subnets=None, type=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Segment configuration to attach workloads.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • advanced_config (SegmentAdvancedConfig or None) – Advanced configuration for Segment.
      • +
    • domain_name (str or None) – DNS domain name
      • +
    • l2_extension (L2Extension or None) – Configuration for extending Segment through L2 VPN
      • +
    • ls_id (str or None) – Sepcify pre-creted logical switch id for Segment.
      • +
    • overlay_id (long or None) – Used for overlay connectivity of segments. The overlay_id should be +allocated from the pool as definied by enforcement-point. If not +provided, it is auto-allocated from the default pool on the +enforcement-point. format: int32
      • +
    • subnets (list of SegmentSubnet or None) – Subnet configuration. Max 1 subnet
      • +
    • type (str or None) –

      Possible values are:

      + +
      +
      Segment type based on configuration.
      +

      This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    +
    +
    +
    +TYPE_DISCONNECTED = 'DISCONNECTED'
    +
    + +
    +
    +TYPE_EXTENDED = 'EXTENDED'
    +
    + +
    +
    +TYPE_ROUTED = 'ROUTED'
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.model_client.SegmentAdvancedConfig(connectivity=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Advanced configuration for Segment

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:connectivity (str or None) –

    Possible values are:

    + +

    Connectivity configuration to manually connect (ON) or disconnect +(OFF) a logical entity from network topology.

    +
    +
    +
    +CONNECTIVITY_OFF = 'OFF'
    +
    + +
    +
    +CONNECTIVITY_ON = 'ON'
    +
    +
    @@ -20253,11 +66124,44 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of Segment) – Segment list results
      • +
    +
    -class com.vmware.nsx_policy.model_client.SegmentSubnet(dhcp_ranges=None, gateway_addresses=None, network=None, prefix_len=None)
    +class com.vmware.nsx_policy.model_client.SegmentSubnet(dhcp_ranges=None, gateway_address=None, network=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    Subnet configuration for segment

    @@ -20265,6 +66169,27 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • dhcp_ranges (list of str or None) – DHCP address ranges are used for dynamic IP allocation. Supports +address range and CIDR formats. First valid host address from the +first value is assigned to DHCP server IP address. Existing values +cannot be deleted or modified, but additional DHCP ranges can be +added. format: address-or-block-or-range
      • +
    • gateway_address (str or None) – Gateway IP address in CIDR format for both IPv4 and IPv6. format: +ip-cidr-block
      • +
    • network (str or None) – Network CIDR for this subnet calculated from gateway_addresses and +prefix_len. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -20277,6 +66202,26 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • is_valid (bool or None) – Will be set to false if the referenced NSX resource has been +deleted. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • target_display_name (str or None) – Display name of the NSX resource. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • target_id (str or None) – Identifier of the NSX resource.
      • +
    • target_type (str or None) – Type of the NSX resource.
      • +
    • selected (bool) – Set to true if this resource has been selected to be acted upon
      • +
    +
    @@ -20290,6 +66235,26 @@ PUT and POST.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • action (str or None) – Optional action +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • href (str or None) – Link to resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • rel (str or None) – Custom relation type (follows RFC 5988 where appropriate +definitions exist) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -20301,6 +66266,37 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • certificate_chain_depth (long or None) – authentication depth is used to set the verification depth in the +server certificates chain. format: int64
      • +
    • client_certificate_id (str or None) – To support client authentication (load balancer acting as a client +authenticating to the backend server), client certificate can be +specified in the server-side SSL profile binding
      • +
    • server_auth (str or None) –

      Possible values are:

      + +
      +
      server authentication mode
      +
      • +
    • server_auth_ca_ids (list of str or None) – If server auth type is REQUIRED, server certificate must be signed +by one of the trusted Certificate Authorities (CAs), also referred +to as root CAs, whose self signed certificates are specified.
      • +
    • server_auth_crl_ids (list of str or None) – A Certificate Revocation List (CRL) can be specified in the +server-side SSL profile binding to disallow compromised server +certificates.
      • +
    • ssl_profile_id (str or None) – Server SSL profile defines reusable, application-independent server +side SSL properties.
      • +
    +
    SERVER_AUTH_IGNORE = 'IGNORE'
    @@ -20324,6 +66320,86 @@ service entries.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • service_entries (list of vmware.vapi.struct.VapiStruct) – Service type +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +ServiceEntry. When methods return a value of this class as +a return value, the attribute will contain all the attributes +defined in ServiceEntry.
      • +
    +
    @@ -20335,6 +66411,44 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • service_type (str) –

      Possible values are:

      + +
      • +
    +
    SERVICE_TYPE_FIREWALLSERVICEASSOCIATIONLISTRESULT = 'FireWallServiceAssociationListResult'
    @@ -20361,6 +66475,82 @@ handle the lifecycle of these appliance/s.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • attachment_status (str or None) –

      Possible values are:

      + +

      UP - A Service Attachment will have its Service Port - UP and with +a configured IP address. DOWN - An Inactive ServiceAttachment has +its Service Port - DOWN. It can be used to connect set of +appliances that do not need to exchange traffic to/from/through the +Edge node.

      +
      • +
    • deployed_to (ResourceReference) – NSX Resource where we want to create Service Attachment Point. Ex. +T0 LR Edge in case of HCX-ServiceInsertion.
      • +
    • local_ips (list of IPInfo) – Local IPs associated with this Service Attachment.
      • +
    • logical_switch (ResourceReference or None) – Logical Switch gets created as a part of Service Attachment +creation. If a Logical Switch is provided, then that needs to be +used - instead of creating new one.
      • +
    • service_port (ResourceReference or None) – Service Port gets created as a part of Service Attachment creation. +It is a Logical Router Port of type CentralizedServicePort. It does +not participate in distributed routing. Stateless Policy Based +Routing service can be applied on this port.
      • +
    +
    ATTACHMENT_STATUS_DOWN = 'DOWN'
    @@ -20383,6 +66573,41 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of ServiceAttachment or None) – List of the Service Attachments. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -20394,6 +66619,14 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:service_id (ResourceReference) – Identifier of Logical Service
    @@ -20407,6 +66640,106 @@ A ServiceDefinition is used to create a service.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • attachment_point (list of str) –

      Possible values are:

      + +

      The point at which the service is deployed/attached for redirecting +the traffic to the the partner appliance.

      +
      • +
    • functionalities (list of str) –

      Possible values are:

      + +

      The capabilities provided by the services like NG_FW, IDS_IPS +Hybrid Cloud Exchange(HCX) is specified here.

      +
      • +
    • implementations (list of str) –

      Possible values are:

      + +
      +
      This indicates the insertion point of the service.
      +
      • +
    • on_failure_policy (str or None) –

      Possible values are:

      + +

      Failure policy for the service tells datapath, the action to take +i.e to Allow or Block traffic during failure scenarios.

      +
      • +
    • service_deployment_spec (ServiceDeploymentSpec or None) – Service Deployment Specification defines takes in information +required to deploy and configure a partner appliance/service-vm.
      • +
    • transports (list of str) –

      Possible values are:

      + +

      Transport Type of the service, which is the mechanism of +redirecting the traffic to the the partner appliance.

      +
      • +
    • vendor_id (str) – Id which is unique to a vendor or partner for which the service is +created.
      • +
    +
    ATTACHMENT_POINT_TIER0_LR = 'TIER0_LR'
    @@ -20476,6 +66809,136 @@ and NIC metatdata.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • deployment_specs (list of SVMDeploymentSpec or None) – Deployment Specs holds information required to deploy the +Service-VMs. i.e. OVF url where the partner Service-VM OVF is +hosted. The host type on which the OVF can be deployed, Form factor +to name a few.
      • +
    • deployment_template (list of DeploymentTemplate) – Deployment Template holds the attributes specific to partner for +which the service is created. These attributes are opaque to NSX +Manager.
      • +
    • nic_metadata_list (list of NicMetadata or None) – NIC metadata associated with the deployment spec.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.ServiceElement(element_id=None, elements=None, resource_name=None, resource_type=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Network services such as Loadbalancer, DHCP will be represented using this +type.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters: +
    +
    +
    +RESOURCE_TYPE_EDGENODEELEMENT = 'EdgeNodeElement'
    +
    + +
    +
    +RESOURCE_TYPE_GROUPELEMENT = 'GroupElement'
    +
    + +
    +
    +RESOURCE_TYPE_HOSTNODEELEMENT = 'HostNodeElement'
    +
    + +
    +
    +RESOURCE_TYPE_LBVIRTUALSERVERELEMENT = 'LBVirtualServerElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOADBALANCERSERVICEELEMENT = 'LoadBalancerServiceElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALROUTERPORTELEMENT = 'LogicalRouterPortElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALSWITCHELEMENT = 'LogicalSwitchElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALSWITCHPORTELEMENT = 'LogicalSwitchPortElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALT0ROUTERELEMENT = 'LogicalT0RouterElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALT1ROUTERELEMENT = 'LogicalT1RouterElement'
    +
    + +
    +
    +RESOURCE_TYPE_PROCESSELEMENT = 'ProcessElement'
    +
    + +
    +
    +RESOURCE_TYPE_VIRTUALNETWORKINTERFACEELEMENT = 'VirtualNetworkInterfaceElement'
    +
    + +
    +
    +RESOURCE_TYPE_VMELEMENT = 'VMElement'
    +
    +
    @@ -20487,6 +66950,21 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • certificate (str or None) –
      • +
    • certificate_sha256_thumbprint (str or None) –
      • +
    • fqdn (str or None) –
      • +
    • ip_address (str) – IPv4 or IPv6 address format: ip
      • +
    • port (long) –
      • +
    +
    @@ -20499,6 +66977,88 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    RESOURCE_TYPE_ALGTYPESERVICEENTRY = 'ALGTypeServiceEntry'
    @@ -20536,6 +67096,44 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of vmware.vapi.struct.VapiStruct) – Service entry list results +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +ServiceEntry. When methods return a value of this class as +a return value, the attribute will contain all the attributes +defined in ServiceEntry.
      • +
    +
    @@ -20547,6 +67145,29 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • ip_address (str or None) – Service IP address registerd by the service. format: ipv4 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • is_advertised (bool or None) – Flag to denote advertisement status of service IP to TIER0 LR. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • is_arp_proxy_enabled (bool or None) – Flag to denote status of ARP Proxy for service IP. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • is_loopback_enabled (bool or None) – Flag to denote loopback status for service IP. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • service (ResourceReference or None) – Service which registered the ip.
      • +
    +
    @@ -20559,6 +67180,95 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • owner (OwnerResourceLink or None) – Owner of this resource
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Identifier of the resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • action (str) –

      Possible values are:

      + +

      Action enforced on the packets which matches the distributed +service rule. Currently DS Layer supports below actions. ALLOW - +Forward any packet when a rule with this action gets a match (Used +by Firewall). DROP - Drop any packet when a rule with this action +gets a match. Packets won’t go further(Used by Firewall). REJECT - +Terminate TCP connection by sending TCP reset for a packet when a +rule with this action gets a match (Used by Firewall). REDIRECT - +Redirect any packet to a partner appliance when a rule with this +action gets a match (Used by Service Insertion). DO_NOT_REDIRECT - +Do not redirect any packet to a partner appliance when a rule with +this action gets a match (Used by Service Insertion).

      +
      • +
    • applied_tos (list of ResourceReference or None) – List of object where rule will be enforced. The section level field +overrides this one. Null will be treated as any.
      • +
    • destinations (list of ResourceReference or None) – List of the destinations. Null will be treated as any.
      • +
    • destinations_excluded (bool or None) – Negation of the destination.
      • +
    • direction (str or None) –

      Possible values are:

      + +

      Rule direction in case of stateless distributed service rules. This +will only considered if section level parameter is set to +stateless. Default to IN_OUT if not specified.

      +
      • +
    • disabled (bool or None) – Flag to disable rule. Disabled will only be persisted but never +provisioned/realized.
      • +
    • ip_protocol (str or None) –

      Possible values are:

      + +
      +
      Type of IP packet that should be matched while enforcing the rule.
      +
      • +
    • is_default (bool or None) – Flag to indicate whether rule is default. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • logged (bool or None) – Flag to enable packet logging. Default is disabled.
      • +
    • notes (str or None) – User notes specific to the rule.
      • +
    • rule_tag (str or None) – User level field which will be printed in CLI and packet logs.
      • +
    • services (list of ServiceInsertionService or None) – List of the services. Null will be treated as any.
      • +
    • sources (list of ResourceReference or None) – List of sources. Null will be treated as any.
      • +
    • sources_excluded (bool or None) – Negation of the source.
      • +
    • redirect_tos (list of ResourceReference) – A rule can be realized on a particular service definition, service +instance or instance endpoint. If a service definition is selected +as a redirect_to target, by default it will take the first deployed +service instance if finds.
      • +
    +
    ACTION_ALLOW = 'ALLOW'
    @@ -20626,6 +67336,41 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of ServiceInsertionRule or None) – ServiceInsertion rule list result with pagination support. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -20638,6 +67383,83 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • applied_tos (list of ResourceReference or None) – List of objects where the rules in this section will be enforced. +This will take precedence over rule level appliedTo.
      • +
    • is_default (bool or None) – It is a boolean flag which reflects whether a distributed service +section is default section or not. Each Layer 3 and Layer 2 section +will have at least and at most one default section. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • rule_count (long or None) – Number of rules in this section. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • section_type (str) –

      Possible values are:

      + +

      Type of the rules which a section can contain. Only homogeneous +sections are supported.

      +
      • +
    • stateful (bool) – Stateful or Stateless nature of distributed service section is +enforced on all rules inside the section. Layer3 sections can be +stateful or stateless. Layer2 sections can only be stateless.
      • +
    +
    SECTION_TYPE_L3REDIRECT = 'L3REDIRECT'
    @@ -20665,6 +67487,42 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of ServiceInsertionSection or None) – List of the ServiceInsertion sections. The list has to be +homogeneous. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -20677,6 +67535,85 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • applied_tos (list of ResourceReference or None) – List of objects where the rules in this section will be enforced. +This will take precedence over rule level appliedTo.
      • +
    • is_default (bool or None) – It is a boolean flag which reflects whether a distributed service +section is default section or not. Each Layer 3 and Layer 2 section +will have at least and at most one default section. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • rule_count (long or None) – Number of rules in this section. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • section_type (str) –

      Possible values are:

      + +

      Type of the rules which a section can contain. Only homogeneous +sections are supported.

      +
      • +
    • stateful (bool) – Stateful or Stateless nature of distributed service section is +enforced on all rules inside the section. Layer3 sections can be +stateful or stateless. Layer2 sections can only be stateless.
      • +
    • rules (list of ServiceInsertionRule) – List of Service Insertion rules in the section. Only homogeneous +rules are supported.
      • +
    +
    SECTION_TYPE_L3REDIRECT = 'L3REDIRECT'
    @@ -20704,6 +67641,33 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • is_valid (bool or None) – Will be set to false if the referenced NSX resource has been +deleted. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • target_display_name (str or None) – Display name of the NSX resource. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • target_id (str or None) – Identifier of the NSX resource.
      • +
    • target_type (str or None) – Type of the NSX resource.
      • +
    • service (vmware.vapi.struct.VapiStruct or None) – Distributed Service API accepts raw protocol and ports as part of +NS service element in Distributed Service Rule that describes +traffic corresponding to an NSService. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +NSServiceElement. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in NSServiceElement.
      • +
    +
    @@ -20716,11 +67680,47 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of ServiceDefinition or None) – List of the Service-Insertion Services. The list has to be +homogenous. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    -class com.vmware.nsx_policy.model_client.ServiceInstance(attachment_point=None, deployed_to=None, deployment_spec_name=None, implementation_type=None, instance_deployment_config=None, instance_deployment_template=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ServiceInstance', tags=None, deployment_mode=None, on_failure_policy=None, service_id=None, transport_type=None)
    +class com.vmware.nsx_policy.model_client.ServiceInstance(attachment_point=None, deployed_to=None, deployment_mode=None, deployment_spec_name=None, implementation_type=None, instance_deployment_config=None, instance_deployment_template=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ServiceInstance', tags=None, on_failure_policy=None, service_id=None, transport_type=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    The deployment of a registered service. Service instance is instantiation of service. It is the most used type of instance. It is a default instance @@ -20731,6 +67731,126 @@ appliance related all the information is necessary.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • attachment_point (str) –

      Possible values are:

      + +

      Attachment point to be used by this service instance for deploying +the Service-VM.

      +
      • +
    • deployed_to (list of ResourceReference) – List of resource references where service instance be deployed. Ex. +Tier 0 Logical Router in case of N-S ServiceInsertion.
      • +
    • deployment_mode (str) –

      Possible values are:

      + +

      Deployment mode specifies where the partner appliance will be +deployed in HA or non-HA i.e standalone mode.

      +
      • +
    • deployment_spec_name (str) – Name of the deployment spec to be used by this service instance.
      • +
    • implementation_type (str) –

      Possible values are:

      + +

      Implementation to be used by this service instance for deploying +the Service-VM.

      +
      • +
    • instance_deployment_config (InstanceDeploymentConfig) – Instance Deployment Config contains the information to be injected +during Service-VM deployment.
      • +
    • instance_deployment_template (DeploymentTemplate) – The deployment template to be used by this service instance. The +attribute values specific to this instance can be added.
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      ServiceInstance is used when NSX handles the lifecyle of appliance. +Deployment and appliance related all the information is necessary. +ByodServiceInstance is a custom instance to be used when NSX is not +handling the lifecycles of appliance/s. User will manage their own +appliance (BYOD) to connect with NSX. VirtualServiceInstance is a a +custom instance to be used when NSX is not handling the lifecycle +of an appliance and when the user is not bringing their own +appliance.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • on_failure_policy (str or None) –

      Possible values are:

      + +

      Failure policy of the service instance - if it has to be different +from the service. By default the service instance inherits the +FailurePolicy of the service it belongs to.

      +
      • +
    • service_id (str or None) – The Service to which the service instance is associated. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • transport_type (str) –

      Possible values are:

      + +

      Transport to be used by this service instance for deploying the +Service-VM.

      +
      • +
    +
    ATTACHMENT_POINT_TIER0_LR = 'TIER0_LR'
    @@ -20741,6 +67861,16 @@ names.

    ATTACHMENT_POINT_TIER1_LR = 'TIER1_LR'
    +
    +
    +DEPLOYMENT_MODE_ACTIVE_STANDBY = 'ACTIVE_STANDBY'
    +
    + +
    +
    +DEPLOYMENT_MODE_STAND_ALONE = 'STAND_ALONE'
    +
    +
    IMPLEMENTATION_TYPE_EAST_WEST = 'EAST_WEST'
    @@ -20755,26 +67885,143 @@ names.

    -class com.vmware.nsx_policy.model_client.ServiceInstanceEndpoint(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, endpoint_type=None, service_interface_path=None, target_ips=None)
    +class com.vmware.nsx_policy.model_client.ServiceInstanceEndpoint(service_interface_path=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ServiceInstanceEndpoint', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, target_ips=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    A ServiceInstanceEndpoint belongs to one ByodPolicyServiceInstance and is attached to one ServiceInterface. A ServiceInstanceEndpoint represents a -redirection target for a RedirectionCommunicationMap.

    +redirection target for a RedirectionPolicy.

    Tip

    The arguments are used to initialize data attributes with the same names.

    -
    -
    -ENDPOINT_TYPE_LOGICAL = 'LOGICAL'
    -
    - -
    -
    -ENDPOINT_TYPE_VIRTUAL = 'VIRTUAL'
    -
    + +++ + + + +
    Parameters:
      +
    • service_interface_path (str) – Path of Service Interface to which this ServiceInstanceEndpoint is +connected.
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • target_ips (list of IPInfo) – IPs where either inbound or outbound traffic is to be redirected.
      • +
    +
    +
    +
    +
    +class com.vmware.nsx_policy.model_client.ServiceInstanceEndpointListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Paged Collection of ServiceInstanceEndpoint

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of ServiceInstanceEndpoint) – ServiceInstanceEndpoint list results
      • +
    +
    @@ -20787,6 +68034,47 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of vmware.vapi.struct.VapiStruct or None) – List of the Service-Insertion ServicesInstances. The list has to be +homogenous. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +BaseServiceInstance. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in BaseServiceInstance. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -20799,6 +68087,81 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • subnets (list of InterfaceSubnet) – Specify IP address and network prefix for interface.
      • +
    +
    @@ -20811,6 +68174,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of ServiceInterface) – Service Interface list results
      • +
    +
    @@ -20823,6 +68219,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of Service) – Service list results
      • +
    +
    @@ -20834,6 +68263,68 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      +
      Resource type of the service profile
      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • server_addresses (list of str) –
      • +
    +
    RESOURCE_TYPE_DHCPRELAYPROFILE = 'DhcpRelayProfile'
    @@ -20850,6 +68341,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of ServiceProfile) – service profile list results
      • +
    +
    @@ -20861,6 +68385,42 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of ServiceIP or None) – List of service IPs registered with the LR by services like NAT, +LB, VPN, etc. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -20873,6 +68433,71 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • white_list_providers (list of str) –

      Possible values are:

      + +
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • required_capabilities (list of str or None) –
      • +
    +
    WHITE_LIST_PROVIDERS_LPORT_BINDINGS = 'LPORT_BINDINGS'
    @@ -20885,40 +68510,6 @@ names.

    -
    -
    -class com.vmware.nsx_policy.model_client.SslCertificate(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, details=None, pem_encoded=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    - -
    -
    -class com.vmware.nsx_policy.model_client.SslCertificateList(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Certificate queries result

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    - -
    -
    -class com.vmware.nsx_policy.model_client.SslTrustObjectData(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, key_algo=None, passphrase=None, pem_encoded=None, private_key=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    class com.vmware.nsx_policy.model_client.StandardHostSwitch(cpu_config=None, host_switch_name=None, host_switch_profile_ids=None, ip_assignment_spec=None, pnics=None)
    @@ -20929,6 +68520,38 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • cpu_config (list of CpuCoreConfigForEnhancedNetworkingStackSwitch or None) – CPU configuration specifies number of Logical cpu cores (Lcores) +per Non Uniform Memory Access (NUMA) node dedicated to Enhanced +Networking Stack enabled HostSwitch to get the best performance.
      • +
    • host_switch_name (str or None) – If this name is unset or empty then the default host switch name +will be used. The name must be unique among all host switches +specified in a given transport node; unset name, empty name and the +default host switch name are considered the same in terms of +uniqueness.
      • +
    • host_switch_profile_ids (list of HostSwitchProfileTypeIdEntry or None) – host switch profiles bound to this host switch. If a profile ID is +not provided for any HostSwitchProfileType that is supported by the +transport node, the corresponding default profile will be bound to +the host switch.
      • +
    • ip_assignment_spec (vmware.vapi.struct.VapiStruct or None) – IPs can come from either a static IP pool or an explicitly +specified IP list or DHCP. In case a list of IP is specified, the +number of IPs provided should be sufficient as per teaming policy +associated with host switch uplink profile. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +IpAssignmentSpec. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in IpAssignmentSpec.
      • +
    • pnics (list of Pnic or None) – Physical NICs connected to the host switch
      • +
    +
    @@ -20942,6 +68565,23 @@ node.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    @@ -20956,6 +68596,21 @@ number of logical switches and their admin states.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • drilldown_id (str or None) – Id of drilldown widget, if any. Id should be a valid id of an +existing widget.
      • +
    • tooltip (list of Tooltip or None) – Multi-line text to be shown on tooltip while hovering over the +stat.
      • +
    • value (str) – Expression for stat to be displayed.
      • +
    +
    @@ -20968,6 +68623,82 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • ip_address (str) – IP Address format: ip
      • +
    • mac_address (str) – MAC Address
      • +
    +
    @@ -20979,18 +68710,68 @@ names.

    The arguments are used to initialize data attributes with the same names.

    -
    - -
    -
    -class com.vmware.nsx_policy.model_client.StaticHopBfdPeerDeleteRequestParameters(force=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    BFD peer delete request parameters

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • bfd_config (BfdConfigParameters or None) – If not specified then BFD peer will inherit configuration from the +BFD global config.
      • +
    • enabled (bool or None) – Indicate BFD peer is enabled or disabled. Default is true.
      • +
    • peer_ip_address (str) – IP address of BFD peer. This should be same as next hop IP address. +format: ipv4
      • +
    • source_addresses (list of str or None) – BFD peers will be created from all these source addresses to this +neighbour. format: ipv4
      • +
    +
    @@ -21002,6 +68783,41 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of StaticHopBfdPeer or None) – static hop BFD peer list results +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -21014,6 +68830,28 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    @@ -21026,6 +68864,28 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    @@ -21038,6 +68898,25 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    @@ -21049,6 +68928,66 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • logical_router_id (str or None) – Logical router id +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • network (str) – CIDR format: ipv4-cidr-block
      • +
    • next_hops (list of StaticRouteNextHop) – Next Hops
      • +
    +
    @@ -21060,6 +68999,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of StaticRoute) – Paginated list of static routes
      • +
    +
    @@ -21071,6 +69043,33 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • administrative_distance (long or None) – Administrative Distance for the next hop IP format: int64
      • +
    • bfd_enabled (bool or None) – Status of bfd for this next hop where bfd_enabled = true indicate +bfd is enabled for this next hop and bfd_enabled = false indicate +bfd peer is disabled or not configured for this next hop. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • blackhole_action (str or None) –

      Possible values are:

      + +
      +
      Action to be taken on matching packets for NULL routes.
      +

      This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    • ip_address (str or None) – Next Hop IP format: ipv4
      • +
    • logical_router_port_id (ResourceReference or None) – Reference of logical router port to be used for next hop
      • +
    +
    BLACKHOLE_ACTION_DISCARD = 'DISCARD'
    @@ -21082,12 +69081,89 @@ names.

    class com.vmware.nsx_policy.model_client.StaticRoutes(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, network=None, next_hops=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Static routes configuration on Provider or Network

    +

    Static routes configuration on Tier-0 or Tier-1.

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • network (str) – Specify network address in CIDR format. format: +address-or-block-or-range
      • +
    • next_hops (list of RouterNexthop) – Specify next hop routes for network.
      • +
    +
    @@ -21100,6 +69176,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of StaticRoutes) – Static Routes list results
      • +
    +
    @@ -21113,6 +69222,97 @@ logical switches and their admin states.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • label (Label or None) – Displayed at the sections, by default. It labels the entities of +sections. If label is not provided, the sections are not labelled.
      • +
    • navigation (str or None) – Hyperlink of the specified UI page that provides details.
      • +
    • sections (list of DonutSection or None) – Sections
      • +
    • stat (StatItem or None) – Expression that fetches statistic. It can be used to show the +characteristics of entities such as Logical Switches, Firewall +Rules, and so on. For example, number of logical switches and their +admin states. If stat is not provided, then it will not be +displayed.
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str) – Title of the widget.
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      Supported visualization types are LabelValueConfiguration, +DonutConfiguration, GridConfiguration, StatsConfiguration, +MultiWidgetConfiguration and ContainerConfiguration.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • datasources (list of Datasource or None) – The ‘datasources’ represent the sources from which data will be +fetched. Currently, only NSX-API is supported as a ‘default’ +datasource. An example of specifying ‘default’ datasource along +with the urls to fetch data from is given at ‘example_request’ +section of ‘CreateWidgetConfiguration’ API.
      • +
    • drilldown_id (str or None) – Id of drilldown widget, if any. Id should be a valid id of an +existing widget. A widget is considered as drilldown widget when it +is associated with any other widget and provides more detailed +information about any data item from the parent widget.
      • +
    • footer (Footer or None) –
      • +
    • is_drilldown (bool or None) – Set to true if this widget should be used as a drilldown.
      • +
    • shared (bool or None) – Please use the property ‘shared’ of View instead of this. The +widgets of a shared view are visible to other users.
      • +
    • weight (long or None) – Specify relavite weight in WidgetItem for placement in a view. +Please see WidgetItem for details. format: int32
      • +
    +
    @@ -21124,6 +69324,29 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    STATUS_DEGRADED = 'DEGRADED'
    @@ -21156,12 +69379,77 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of str) – Domain list results
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.StringMapEntry(key=None, value=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • key (str) – String key for the map
      • +
    • value (str or None) – String value for the map entry
      • +
    +
    class com.vmware.nsx_policy.model_client.StubFactory(stub_config)

    Bases: vmware.vapi.bindings.stub.StubFactoryBase

    +

    Initialize StubFactoryBase

    + +++ + + + +
    Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
    @@ -21173,6 +69461,68 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • block_non_ip_traffic (bool or None) – A flag to block all traffic except IP/(G)ARP/BPDU
      • +
    • bpdu_filter (BpduFilter or None) – BPDU filtering is enabled by default. A pre-defined list of MAC +addresses are automatically excluded from BPDU filtering.
      • +
    • dhcp_filter (DhcpFilter or None) – DHCP server blocking is enabled and client blocking is disabled by +default
      • +
    • rate_limits (RateLimits or None) – Rate limiting is disabled by default
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • required_capabilities (list of str or None) –
      • +
    +
    @@ -21184,6 +69534,30 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    KEY_IPDISCOVERYSWITCHINGPROFILE = 'IpDiscoverySwitchingProfile'
    @@ -21226,6 +69600,46 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of vmware.vapi.struct.VapiStruct or None) – Switching Profile Results +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +BaseSwitchingProfile. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in BaseSwitchingProfile. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -21238,6 +69652,18 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • scope (str or None) – Tag searches may optionally be restricted by scope
      • +
    • tag (str or None) – Identifier meaningful to user
      • +
    +
    @@ -21250,6 +69676,25 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    TARGET_STATUS_DISABLED = 'DISABLED'
    @@ -21272,6 +69717,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of TaskProperties) – Task property results
      • +
    +
    @@ -21284,6 +69762,71 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • async_response_available (bool or None) – True if response for asynchronous request is available +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • cancelable (bool or None) – True if this task can be canceled +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of the task +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • end_time (long or None) – The end time of the task in epoch milliseconds format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • id (str or None) – Identifier for this task +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • message (str or None) – A message describing the disposition of the task +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • progress (long or None) – Task progress if known, from 0 to 100 format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • request_method (str or None) – HTTP request method +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • request_uri (str or None) – URI of the method invocation that spawned this task +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • start_time (long or None) – The start time of the task in epoch milliseconds format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • status (str or None) –

      Possible values are:

      + +
      +
      Current status of the task
      +

      This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    • user (str or None) – Name of the user who created this task +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    STATUS_CANCELED = 'canceled'
    @@ -21316,43 +69859,6 @@ names.

    -
    -
    -class com.vmware.nsx_policy.model_client.TcpPolicyLbMonitorProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='TcpPolicyLbMonitorProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, fall_count=None, interval=None, monitor_port=None, rise_count=None, timeout=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Active healthchecks are disabled by default and can be enabled for a server -pool by binding a health monitor to the Group through the PolicyLbRule -object. This represents active health monitoring over TCP. Active -healthchecks are initiated periodically, at a configurable interval, to -each member of the Group. Only if a healthcheck fails consecutively for a -specified number of times (fall_count) to a member will the member status -be marked DOWN. Once a member is DOWN, a specified number of consecutive -successful healthchecks (rise_count) will bring the member back to UP -state. After a healthcheck is initiated, if it does not complete within a -certain period, then also the healthcheck is considered to be unsuccessful. -Completing a healthcheck within timeout means establishing a connection -(TCP or SSL), if applicable, sending the request and receiving the -response, all within the configured timeout.

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    - -
    -
    -class com.vmware.nsx_policy.model_client.TcpPolicyLbVirtualServer(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='TcpPolicyLbVirtualServer', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, access_log_enabled=None, ip_address=None, lb_persistence_profile=None, ports=None, router_path=None, traffic_source=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Virtual server acts as a facade to an application, receives all client -connections over TCP and distributes them among the backend servers.

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    class com.vmware.nsx_policy.model_client.TeamingPolicy(active_list=None, policy=None, standby_list=None)
    @@ -21363,6 +69869,26 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    POLICY_FAILOVER_ORDER = 'FAILOVER_ORDER'
    @@ -21384,6 +69910,63 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • telemetry_agreement_displayed (bool) – Determine if telemetry agreement has been displayed. If false, the +agreement text will be displayed at login time.
      • +
    +
    @@ -21395,6 +69978,75 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • ceip_acceptance (bool) – Enable this flag to participate in the Customer Experience +Improvement Program.
      • +
    • proxy_enabled (bool or None) – Enable this flag to specify a proxy, and provide the proxy +settings.
      • +
    • schedule_enabled (bool) – Enable this to schedule data collection and upload times. If +enabled, and a schedule is not provided, a default schedule +(WEEKLY, Sunday at 2:00 a.m) will be applied.
      • +
    • telemetry_proxy (TelemetryProxy or None) – Specify the proxy configuration (scheme, server, port) here.
      • +
    • telemetry_schedule (vmware.vapi.struct.VapiStruct or None) – Specify one of Daily, Weekly or Monthly schedules. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +TelemetrySchedule. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in TelemetrySchedule.
      • +
    +
    @@ -21406,6 +70058,81 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • hostname (str) – Specify the fully qualified domain name, or ip address, of the +proxy server. format: hostname-or-ip
      • +
    • password (str or None) – Specify the password used to authenticate with the proxy server, if +required. A GET call on /telemetry/config returns a non-meaningful +password to maintain security. To change the password to a new +value, issue a PUT call after updating this field. To remove the +password, issue a PUT call after emptying this field. To retain a +previously set password, issue a PUT call keeping the +non-meaningful value obtained from the GET call.
      • +
    • port (long) – Specify the port of the proxy server. format: int32
      • +
    • scheme (str) –

      Possible values are:

      + +

      The scheme accepted by the proxy server. Specify one of HTTP and +HTTPS.

      +
      • +
    • username (str or None) – Specify the user name used to authenticate with the proxy server, +if required.
      • +
    +
    SCHEME_HTTP = 'HTTP'
    @@ -21428,6 +70155,800 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:frequency_type (str) – Specify one of DailyTelemetrySchedule, WeeklyTelemetrySchedule, or +MonthlyTelemetrySchedule.
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.Tier0(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, default_rule_logging=None, force_whitelisting=None, ha_mode=None, transit_subnets=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Tier-0 configuration for external connectivity.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • default_rule_logging (bool or None) – Indicates if logging should be enabled for the default whitelisting +rule.
      • +
    • force_whitelisting (bool or None) – Flag to add whitelisting FW rule during realization
      • +
    • ha_mode (str or None) –

      Possible values are:

      + +

      Specify high-availability mode for Tier-0. Default is +ACTIVE_ACTIVE.

      +
      • +
    • transit_subnets (list of str or None) – Specify transit subnets that are used to assign addresses to +logical links connecting tier-0 and tier-1s. Both IPv4 and IPv6 +addresses are supported. format: ip-cidr-block
      • +
    +
    +
    +
    +HA_MODE_ACTIVE = 'ACTIVE_ACTIVE'
    +
    + +
    +
    +HA_MODE_STANDBY = 'ACTIVE_STANDBY'
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.model_client.Tier0DeploymentMap(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, enforcement_point=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Associate tier-0 to the enforcement point to realize policy intent

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • enforcement_point (str) – Path of enforcement point on which Tier-0 will be deployed
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.Tier0DeploymentMapListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Paged Collection of Tier-0 Deployment map

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of Tier0DeploymentMap) – Tier-0 Deployment Maps
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.Tier0Interface(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, subnets=None, edge_cluster_member_index=None, ls_id=None, mtu=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Tier-0 interface configuration for external connectivity.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • subnets (list of InterfaceSubnet) – Specify IP address and network prefix for interface.
      • +
    • edge_cluster_member_index (long or None) – Specify association of interface with edge cluster member. format: +int32
      • +
    • ls_id (str) – Specify logical switch to which tier-0 interface is connected for +external access.
      • +
    • mtu (long or None) – Maximum transmission unit (MTU) specifies the size of the largest +packet that a network protocol can transmit. format: int32
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.Tier0InterfaceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Paged collection of Tier-0 Interfaces

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of Tier0Interface) – Tier-0 Interface list results
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.Tier0ListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Paged collection of Tier-0s

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of Tier0) – Tier-0 list results
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.Tier1(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, default_rule_logging=None, force_whitelisting=None, tier0_path=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Tier-1 instance configuration.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • default_rule_logging (bool or None) – Indicates if logging should be enabled for the default whitelisting +rule.
      • +
    • force_whitelisting (bool or None) – Flag to add whitelisting FW rule during realization
      • +
    • tier0_path (str or None) – Specify tier-1 connectivity to Tier-0 instance.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.Tier1ListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Paged collection of Tier-1 instances

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of Tier1) – Tier-1 list results
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.TlsCertificate(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, details=None, pem_encoded=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • details (list of X509Certificate or None) – list of X509Certificates +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • pem_encoded (str) – pem encoded certificate data
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.TlsCertificateList(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Certificate queries result

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of TlsCertificate or None) – TlsCertificate list +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.TlsTrustData(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, key_algo=None, passphrase=None, pem_encoded=None, private_key=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • key_algo (str or None) – Key algorithm contained in this certificate
      • +
    • passphrase (str or None) – Password for private key encryption
      • +
    • pem_encoded (str) – pem encoded certificate data
      • +
    • private_key (str or None) – private key data
      • +
    +
    @@ -21440,6 +70961,22 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • condition (str or None) – If the condition is met then the tooltip will be applied. If no +condition is provided, then the tooltip will be applied +unconditionally. Examples of expression syntax are provided under +‘example_request’ section of ‘CreateWidgetConfiguration’ API.
      • +
    • text (str) – Text to be shown on tooltip while hovering over UI element. The +text would be wrapped if it exceeds 80 chars.
      • +
    +
    @@ -21456,17 +70993,101 @@ provides information of connectivity between the elements.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • connections (Connections or None) – Contains list of connections that provides the information to +connect the elements. Based on the view option specified in +ViewTypeQueryParameter, connections contains either VM, process, +group or network connection information.
      • +
    • elements (list of Element or None) – Contains list of elments of type VMElement, ProcessElement, +GroupElement, LogicalSwitchElement, LogicalT0RouterElement and +LogicalT1RouterElement. These elements form the nodes/verticies +when preseneted in graphical view.
      • +
    +
    -class com.vmware.nsx_policy.model_client.Traceflow(links=None, schema=None, self_=None, analysis=None, counters=None, id=None, logical_counters=None, lport_id=None, operation_state=None, result_overflowed=None, timeout=None)
    +class com.vmware.nsx_policy.model_client.Traceflow(links=None, schema=None, self_=None, analysis=None, counters=None, id=None, logical_counters=None, lport_id=None, operation_state=None, request_status=None, result_overflowed=None, timeout=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • analysis (list of str or None) – Traceflow result analysis notes +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • counters (TraceflowObservationCounters or None) – observation counters
      • +
    • id (str or None) – The id of the traceflow round +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • logical_counters (TraceflowObservationCounters or None) – counters of observations from logical components
      • +
    • lport_id (str or None) – id of the source logical port used for injecting the traceflow +packet +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • operation_state (str or None) –

      Possible values are:

      + +
      +
      Represents the traceflow operation state
      +

      This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    • request_status (str or None) –

      Possible values are:

      + +

      The status of the traceflow RPC request. SUCCESS - The traceflow +request is sent successfully. TIMEOUT - The traceflow request gets +timeout. SOURCE_PORT_NOT_FOUND - The source port of the request is +not found. DATA_PATH_NOT_READY - The datapath component is not +ready to receive request. CONNECTION_ERROR - There is connection +error on datapath component. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    • result_overflowed (bool or None) – A flag, when set true, indicates some observations were deleted +from the result set. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • timeout (long or None) – Maximum time (in ms) the management plane will be waiting for this +traceflow round. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    OPERATION_STATE_FAILED = 'FAILED'
    @@ -21482,6 +71103,31 @@ names.

    OPERATION_STATE_IN_PROGRESS = 'IN_PROGRESS'
    +
    +
    +REQUEST_STATUS_CONNECTION_ERROR = 'CONNECTION_ERROR'
    +
    + +
    +
    +REQUEST_STATUS_DATA_PATH_NOT_READY = 'DATA_PATH_NOT_READY'
    +
    + +
    +
    +REQUEST_STATUS_SOURCE_PORT_NOT_FOUND = 'SOURCE_PORT_NOT_FOUND'
    +
    + +
    +
    +REQUEST_STATUS_SUCCESS = 'SUCCESS'
    +
    + +
    +
    +REQUEST_STATUS_TIMEOUT = 'TIMEOUT'
    +
    +
    @@ -21494,6 +71140,41 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of Traceflow or None) – Traceflow Results +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -21505,6 +71186,96 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    COMPONENT_SUB_TYPE_LR_TIER0 = 'LR_TIER0'
    @@ -21651,6 +71422,31 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • delivered_count (long or None) – Total number of delivered observations for this traceflow round. +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • dropped_count (long or None) – Total number of dropped observations for this round. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • forwarded_count (long or None) – Total number of forwarded observations for this traceflow round. +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • received_count (long or None) – Total number of received observations for this traceflow round. +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -21662,6 +71458,105 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    COMPONENT_SUB_TYPE_LR_TIER0 = 'LR_TIER0'
    @@ -21808,6 +71703,143 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    COMPONENT_SUB_TYPE_LR_TIER0 = 'LR_TIER0'
    @@ -21878,26 +71910,136 @@ names.

    REASON_ARP_FAIL = 'ARP_FAIL'
    +
    +
    +REASON_BFD = 'BFD'
    +
    + +
    +
    +REASON_DHCP = 'DHCP'
    +
    +
    REASON_FW_RULE = 'FW_RULE'
    +
    +
    +REASON_GENEVE = 'GENEVE'
    +
    + +
    +
    +REASON_GRE = 'GRE'
    +
    + +
    +
    +REASON_IFACE = 'IFACE'
    +
    + +
    +
    +REASON_IP = 'IP'
    +
    + +
    +
    +REASON_IPSEC = 'IPSEC'
    +
    + +
    +
    +REASON_IPSEC_VTI = 'IPSEC_VTI'
    +
    + +
    +
    +REASON_IP_REASS = 'IP_REASS'
    +
    + +
    +
    +REASON_L2VPN = 'L2VPN'
    +
    + +
    +
    +REASON_L4PORT = 'L4PORT'
    +
    + +
    +
    +REASON_LB = 'LB'
    +
    + +
    +
    +REASON_LROUTER = 'LROUTER'
    +
    + +
    +
    +REASON_LSERVICE = 'LSERVICE'
    +
    + +
    +
    +REASON_LSWITCH = 'LSWITCH'
    +
    + +
    +
    +REASON_MD_PROXY = 'MD_PROXY'
    +
    + +
    +
    +REASON_NAT = 'NAT'
    +
    + +
    +
    +REASON_NEIGH = 'NEIGH'
    +
    +
    REASON_NO_ROUTE = 'NO_ROUTE'
    +
    +
    +REASON_SERVICE_INSERT = 'SERVICE_INSERT'
    +
    +
    REASON_TTL_ZERO = 'TTL_ZERO'
    +
    +
    +REASON_TUNNEL = 'TUNNEL'
    +
    +
    REASON_UNKNOWN = 'UNKNOWN'
    +
    +
    +REASON_VXLAN = 'VXLAN'
    +
    + +
    +
    +REASON_VXSTT = 'VXSTT'
    +
    +
    RESOURCE_TYPE_TRACEFLOWOBSERVATIONDELIVERED = 'TraceflowObservationDelivered'
    @@ -21979,6 +72121,148 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    COMPONENT_SUB_TYPE_LR_TIER0 = 'LR_TIER0'
    @@ -22049,26 +72333,136 @@ names.

    REASON_ARP_FAIL = 'ARP_FAIL'
    +
    +
    +REASON_BFD = 'BFD'
    +
    + +
    +
    +REASON_DHCP = 'DHCP'
    +
    +
    REASON_FW_RULE = 'FW_RULE'
    +
    +
    +REASON_GENEVE = 'GENEVE'
    +
    + +
    +
    +REASON_GRE = 'GRE'
    +
    + +
    +
    +REASON_IFACE = 'IFACE'
    +
    + +
    +
    +REASON_IP = 'IP'
    +
    + +
    +
    +REASON_IPSEC = 'IPSEC'
    +
    + +
    +
    +REASON_IPSEC_VTI = 'IPSEC_VTI'
    +
    + +
    +
    +REASON_IP_REASS = 'IP_REASS'
    +
    + +
    +
    +REASON_L2VPN = 'L2VPN'
    +
    + +
    +
    +REASON_L4PORT = 'L4PORT'
    +
    + +
    +
    +REASON_LB = 'LB'
    +
    + +
    +
    +REASON_LROUTER = 'LROUTER'
    +
    + +
    +
    +REASON_LSERVICE = 'LSERVICE'
    +
    + +
    +
    +REASON_LSWITCH = 'LSWITCH'
    +
    + +
    +
    +REASON_MD_PROXY = 'MD_PROXY'
    +
    + +
    +
    +REASON_NAT = 'NAT'
    +
    + +
    +
    +REASON_NEIGH = 'NEIGH'
    +
    +
    REASON_NO_ROUTE = 'NO_ROUTE'
    +
    +
    +REASON_SERVICE_INSERT = 'SERVICE_INSERT'
    +
    +
    REASON_TTL_ZERO = 'TTL_ZERO'
    +
    +
    +REASON_TUNNEL = 'TUNNEL'
    +
    +
    REASON_UNKNOWN = 'UNKNOWN'
    +
    +
    +REASON_VXLAN = 'VXLAN'
    +
    + +
    +
    +REASON_VXSTT = 'VXSTT'
    +
    +
    RESOURCE_TYPE_TRACEFLOWOBSERVATIONDELIVERED = 'TraceflowObservationDelivered'
    @@ -22150,6 +72544,109 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    COMPONENT_SUB_TYPE_LR_TIER0 = 'LR_TIER0'
    @@ -22296,6 +72793,142 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    COMPONENT_SUB_TYPE_LR_TIER0 = 'LR_TIER0'
    @@ -22482,6 +73115,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of TraceflowObservation or None) – TraceflowObservation list results
      • +
    +
    @@ -22493,6 +73159,100 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    COMPONENT_SUB_TYPE_LR_TIER0 = 'LR_TIER0'
    @@ -22639,6 +73399,138 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    COMPONENT_SUB_TYPE_LR_TIER0 = 'LR_TIER0'
    @@ -22826,6 +73718,89 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • host_switch_spec (vmware.vapi.struct.VapiStruct or None) – This property is used to either create standard host switches or to +inform NSX about preconfigured host switches that already exist on +the transport node. Pass an array of either StandardHostSwitchSpec +objects or PreconfiguredHostSwitchSpec objects. It is an error to +pass an array containing different types of HostSwitchSpec objects. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +HostSwitchSpec. When methods return a value of this class +as a return value, the attribute will contain all the attributes +defined in HostSwitchSpec.
      • +
    • host_switches (list of HostSwitch or None) – This property is deprecated in favor of ‘host_switch_spec’. +Property ‘host_switches’ can only be used for NSX managed transport +nodes. ‘host_switch_spec’ can be used for both NSX managed or +manually preconfigured host switches.
      • +
    • maintenance_mode (str or None) –

      Possible values are:

      + +

      The property is read-only, used for querying result. User could +update transport node maintenance mode by +UpdateTransportNodeMaintenanceMode call. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    • node_id (str) – Unique Id of the fabric node
      • +
    • transport_zone_endpoints (list of TransportZoneEndPoint or None) – Transport zone endpoints.
      • +
    +
    MAINTENANCE_MODE_DISABLED = 'DISABLED'
    @@ -22853,6 +73828,41 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of TransportNode or None) – TransportNode Results +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -22865,6 +73875,58 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    MAINTENANCE_MODE_STATE_DISABLED = 'DISABLED'
    @@ -22932,6 +73994,41 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of TransportNodeState or None) – Transport Node State Results +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -22943,6 +74040,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    MGMT_CONNECTION_STATUS_DOWN = 'DOWN'
    @@ -22984,6 +74114,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of TransportNodeStatus or None) – List of transport node statuses
      • +
    +
    @@ -22996,6 +74159,41 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of ComputeCollectionTransportNodeTemplate or None) – Compute collection transport node template results +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -23008,6 +74206,35 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    STATE_FAILED_TO_CREATE = 'FAILED_TO_CREATE'
    @@ -23032,13 +74259,103 @@ names.

    -class com.vmware.nsx_policy.model_client.TransportZone(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, host_switch_mode=None, host_switch_name=None, nested_nsx=None, transport_type=None, transport_zone_profile_ids=None, uplink_teaming_policy_names=None)
    +class com.vmware.nsx_policy.model_client.TransportZone(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, host_switch_id=None, host_switch_mode=None, host_switch_name=None, nested_nsx=None, transport_type=None, transport_zone_profile_ids=None, uplink_teaming_policy_names=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • host_switch_id (str or None) – the host switch id generated by the system. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • host_switch_mode (str or None) –

      Possible values are:

      + +

      STANDARD mode applies to all the hypervisors. ENS mode stands for +Enhanced Networking Stack. This feature is only available for ESX +hypervisor. It is not available on KVM, EDGE and Public Cloud +Gateway etc. When a Transport Zone mode is set to ENS, only +Transport Nodes of type ESX can participate in such a Transport +Zone.

      +
      • +
    • host_switch_name (str or None) – If this name is unset or empty then the default host switch name +will be used.
      • +
    • nested_nsx (bool or None) – The flag only need to be set in nested NSX environment.
      • +
    • transport_type (str) –

      Possible values are:

      + +
      +
      The transport type of this transport zone.
      +
      • +
    • transport_zone_profile_ids (list of TransportZoneProfileTypeIdEntry or None) – Identifiers of the transport zone profiles associated with this +TransportZone.
      • +
    • uplink_teaming_policy_names (list of str or None) – The names of switching uplink teaming policies that all transport +nodes in this transport zone must support. An exception will be +thrown if a transport node within the transport zone does not +support a named teaming policy. The user will need to first ensure +all trasnport nodes support the desired named teaming policy before +assigning it to the transport zone. If the field is not specified, +the host switch’s default teaming policy will be used.
      • +
    +
    HOST_SWITCH_MODE_ENS = 'ENS'
    @@ -23072,6 +74389,19 @@ given TransportZone

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • transport_zone_id (str) – Unique ID identifying the transport zone for this endpoint
      • +
    • transport_zone_profile_ids (list of TransportZoneProfileTypeIdEntry or None) – Identifiers of the transport zone profiles associated with this +transport zone endpoint on this transport node.
      • +
    +
    @@ -23084,6 +74414,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of TransportZone) – Transport Zone Results
      • +
    +
    @@ -23095,6 +74458,65 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    +
    RESOURCE_TYPE_BFDHEALTHMONITORINGPROFILE = 'BfdHealthMonitoringProfile'
    @@ -23112,6 +74534,46 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of vmware.vapi.struct.VapiStruct or None) – Transport zone profile results +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +TransportZoneProfile. When methods return a value of this +class as a return value, the attribute will contain all the +attributes defined in TransportZoneProfile. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -23123,6 +74585,25 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    RESOURCE_TYPE_BFDHEALTHMONITORINGPROFILE = 'BfdHealthMonitoringProfile'
    @@ -23140,6 +74621,28 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • num_logical_ports (long or None) – Count of logical ports in the transport zone format: int32 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • num_logical_switches (long or None) – Count of logical switches in the transport zone format: int32 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • num_transport_nodes (long or None) – Count of transport nodes in the transport zone format: int32 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • transport_zone_id (str or None) – Unique ID identifying the transport zone +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -23152,6 +74655,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of TransportZoneStatus) – Transport Zone Runtime Status Info Results
      • +
    +
    @@ -23164,6 +74700,18 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • end (long) – Virtual Local Area Network Identifier format: int64
      • +
    • start (long) – Virtual Local Area Network Identifier format: int64
      • +
    +
    @@ -23175,6 +74723,16 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:supported_algorithms (list of CryptoAlgorithm or None) – list of supported algorithms +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
    @@ -23186,6 +74744,65 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • key_algo (str or None) – Key algorithm contained in this certificate
      • +
    • passphrase (str or None) – Password for private key encryption
      • +
    • pem_encoded (str) – pem encoded certificate data
      • +
    • private_key (str or None) – private key data
      • +
    +
    @@ -23197,6 +74814,41 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • tunnels (list of TunnelProperties or None) – List of transport node tunnels +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -23209,6 +74861,20 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • ip_subnets (list of IPSubnet) – IP Tunnel port (commonly referred as VTI) subnet.
      • +
    • tunnel_port_id (str or None) – Logical route port identifier. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -23220,6 +74886,71 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • bfd (BFDProperties or None) – Detailed information about BFD configured on interface
      • +
    • egress_interface (str or None) – Corresponds to the interface where local_ip_address is routed. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • encap (str or None) –

      Possible values are:

      + +
      +
      Tunnel encap
      +

      This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    • last_updated_time (long or None) – Time at which the Tunnel status has been fetched last time. format: +int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • local_ip (str or None) – Local IP address of tunnel format: ip +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • name (str or None) – Name of tunnel +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • remote_ip (str or None) – Remote IP address of tunnel format: ip +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • remote_node_display_name (str or None) – Represents the display name of the remote transport node at the +other end of the tunnel. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • remote_node_id (str or None) – UUID of the remote transport node +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • status (str or None) –

      Possible values are:

      + +
      +
      Status of tunnel
      +

      This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    +
    ENCAP_GENEVE = 'GENEVE'
    @@ -23266,6 +74997,31 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    STATUS_DEGRADED = 'DEGRADED'
    @@ -23297,6 +75053,18 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • ip_addresses (list of str) – Subnet ip addresses format: ipv4
      • +
    • prefix_length (long) – Subnet Prefix Length format: int64
      • +
    +
    @@ -23308,43 +75076,19 @@ names.

    The arguments are used to initialize data attributes with the same names.

    -
    - -
    -
    -class com.vmware.nsx_policy.model_client.UdpPolicyLbMonitorProfile(receive=None, send=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='UdpPolicyLbMonitorProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, fall_count=None, interval=None, monitor_port=None, rise_count=None, timeout=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Active healthchecks are disabled by default and can be enabled for a server -pool by binding a health monitor to the Group through the PolicyLbRule -object. This represents active health monitoring over UDP. Active -healthchecks are initiated periodically, at a configurable interval, to -each member of the Group. Only if a healthcheck fails consecutively for a -specified number of times (fall_count) to a member will the member status -be marked DOWN. Once a member is DOWN, a specified number of consecutive -successful healthchecks (rise_count) will bring the member back to UP -state. After a healthcheck is initiated, if it does not complete within a -certain period, then also the healthcheck is considered to be unsuccessful. -Completing a healthcheck within timeout means establishing a connection -(TCP or SSL), if applicable, sending the request and receiving the -response, all within the configured timeout.

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    - -
    -
    -class com.vmware.nsx_policy.model_client.UdpPolicyLbVirtualServer(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='UdpPolicyLbVirtualServer', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, access_log_enabled=None, ip_address=None, lb_persistence_profile=None, ports=None, router_path=None, traffic_source=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Virtual server acts as a facade to an application, receives all client -connections over UDP and distributes them among the backend servers.

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    + +++ + + + +
    Parameters:
      +
    • count (long) – Total count per group by field value format: int64
      • +
    • group_by_field_value (str) – Group By Field Value
      • +
    • hits (list of vmware.vapi.struct.VapiStruct or None) – Hits per resource type
      • +
    +
    @@ -23356,6 +75100,40 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_update_timestamp (long or None) – Timestamp in milliseconds since epoch format: int64
      • +
    • results (list of VirtualMachine) – List of VMs which are not associated with any NSGroup
      • +
    +
    @@ -23369,6 +75147,63 @@ certificate

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • certificate_id (str) – Id of the stored certificate
      • +
    • principal_identity_id (str) – Unique ID of the principal
      • +
    +
    @@ -23380,6 +75215,29 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    UPGRADE_STATUS_FAILED = 'FAILED'
    @@ -23406,6 +75264,41 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of UpgradeHistory or None) – Upgrade history list +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -23418,6 +75311,25 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    @@ -23432,7 +75344,7 @@ names.

    -class com.vmware.nsx_policy.model_client.UplinkHostSwitchProfile(lags=None, mtu=None, named_teamings=None, teaming=None, transport_vlan=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='UplinkHostSwitchProfile', tags=None, required_capabilities=None)
    +class com.vmware.nsx_policy.model_client.UplinkHostSwitchProfile(lags=None, mtu=None, named_teamings=None, overlay_encap=None, teaming=None, transport_vlan=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='UplinkHostSwitchProfile', tags=None, required_capabilities=None)

    Bases: vmware.vapi.bindings.struct.VapiStruct

    Profile for uplink policies

    @@ -23440,6 +75352,97 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • lags (list of Lag or None) – list of LACP group
      • +
    • mtu (long or None) – Maximum Transmission Unit used for uplinks format: int32
      • +
    • named_teamings (list of NamedTeamingPolicy or None) – List of named uplink teaming policies that can be used by logical +switches
      • +
    • overlay_encap (str or None) –

      Possible values are:

      + +
      +
      The protocol used to encapsulate overlay traffic
      +
      • +
    • teaming (TeamingPolicy) – Default TeamingPolicy associated with this UplinkProfile
      • +
    • transport_vlan (long or None) – VLAN used for tagging Overlay traffic of associated HostSwitch +format: int64
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • required_capabilities (list of str or None) –
      • +
    +
    +
    +
    +OVERLAY_ENCAP_GENEVE = 'GENEVE'
    +
    + +
    +
    +OVERLAY_ENCAP_VXLAN = 'VXLAN'
    +
    +
    @@ -23452,6 +75455,20 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • alias (str or None) –
      • +
    • query (str or None) – Search query to be applied, if any. If query string is not +provided, it will be ignored.
      • +
    • url (str) – Url to fetch data from.
      • +
    +
    @@ -23464,6 +75481,22 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • roles (list of NsxRole or None) – Permissions +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • user_name (str or None) – User Name +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -23476,6 +75509,21 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • password (str or None) – The authentication password for login
      • +
    • thumbprint (str or None) – Thumbprint of the login server
      • +
    • username (str or None) – The username for login
      • +
    • credential_type (str) – Possible values are ‘UsernamePasswordLoginCredential’, +‘VerifiableAsymmetricLoginCredential’.
      • +
    +
    @@ -23487,6 +75535,20 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • active_vip_addresses (list of str) – Array of IP address subnets which will be used as floating IP +addresses. | These IPs will move and will be owned by Active node. +format: ipv4
      • +
    • prefix_length (long) – Subnet Prefix Length format: int64
      • +
    +
    @@ -23500,6 +75562,28 @@ VM to destination VM.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • dest_element_id (str or None) – Unique element ID of destination element to which the connection is +established. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • number_of_events (long or None) – Represents the number of events/flows between the source and +destination elements. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • src_element_id (str or None) – Unique element ID of source element from which the connection is +established. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -23513,16 +75597,101 @@ related to a VM.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    +
    +
    +RESOURCE_TYPE_EDGENODEELEMENT = 'EdgeNodeElement'
    +
    +
    RESOURCE_TYPE_GROUPELEMENT = 'GroupElement'
    +
    +
    +RESOURCE_TYPE_HOSTNODEELEMENT = 'HostNodeElement'
    +
    + +
    +
    +RESOURCE_TYPE_LBVIRTUALSERVERELEMENT = 'LBVirtualServerElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOADBALANCERSERVICEELEMENT = 'LoadBalancerServiceElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALROUTERPORTELEMENT = 'LogicalRouterPortElement'
    +
    +
    RESOURCE_TYPE_LOGICALSWITCHELEMENT = 'LogicalSwitchElement'
    +
    +
    +RESOURCE_TYPE_LOGICALSWITCHPORTELEMENT = 'LogicalSwitchPortElement'
    +
    +
    RESOURCE_TYPE_LOGICALT0ROUTERELEMENT = 'LogicalT0RouterElement'
    @@ -23538,6 +75707,11 @@ names.

    RESOURCE_TYPE_PROCESSELEMENT = 'ProcessElement'
    +
    +
    +RESOURCE_TYPE_VIRTUALNETWORKINTERFACEELEMENT = 'VirtualNetworkInterfaceElement'
    +
    +
    RESOURCE_TYPE_VMELEMENT = 'VMElement'
    @@ -23560,6 +75734,78 @@ sourceGroups allowed to have only with list of groups. {

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • operator (str) –

      Possible values are:

      + +

      Operation to check for value list for resource attribute of +constraint.

      +
      • +
    • values (list of str) – List of values.
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    +
    OPERATOR_EQUALS = 'EQUALS'
    @@ -23586,6 +75832,21 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • asymmetric_credential (str or None) – Asymmetric login credential
      • +
    • credential_key (str or None) – Credential key
      • +
    • credential_verifier (str or None) – Credential verifier
      • +
    • credential_type (str) – Possible values are ‘UsernamePasswordLoginCredential’, +‘VerifiableAsymmetricLoginCredential’.
      • +
    +
    @@ -23597,6 +75858,62 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • acceptable_versions (list of str) – List of component versions
      • +
    +
    @@ -23610,21 +75927,73 @@ fabric module and host type and host version.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    +
    +
    +HOST_TYPE_CENTOSKVM = 'CENTOSKVM'
    +
    + +
    +
    +HOST_TYPE_CENTOSSERVER = 'CENTOSSERVER'
    +
    +
    HOST_TYPE_ESXI = 'ESXI'
    +
    +
    +HOST_TYPE_RHELCONTAINER = 'RHELCONTAINER'
    +
    +
    HOST_TYPE_RHELKVM = 'RHELKVM'
    +
    +
    +HOST_TYPE_RHELSERVER = 'RHELSERVER'
    +
    +
    HOST_TYPE_UBUNTUKVM = 'UBUNTUKVM'
    +
    +
    +HOST_TYPE_UBUNTUSERVER = 'UBUNTUSERVER'
    +
    +
    @@ -23637,6 +76006,32 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • display_name (str or None) – User’s Full Name Or User Group’s Display Name +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • name (str or None) – Username Or Groupname +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • type (str or None) –

      Possible values are:

      + +
      +
      Type
      +

      This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    +
    TYPE_GROUP = 'remote_group'
    @@ -23658,6 +76053,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of VidmInfo) – List results
      • +
    +
    @@ -23670,17 +76098,129 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str) – Title of the widget.
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • exclude_roles (str or None) – Comma separated list of roles to which the shared view is not +visible. Allows user to prevent the visibility of a shared view to +the specified roles. User defined roles can also be specified in +the list. The roles can be obtained via GET /api/v1/aaa/roles. +Please visit API documentation for details about roles. If +include_roles is specified then exclude_roles cannot be specified.
      • +
    • include_roles (str or None) – Comma separated list of roles to which the shared view is visible. +Allows user to specify the visibility of a shared view to the +specified roles. User defined roles can also be specified in the +list. The roles can be obtained via GET /api/v1/aaa/roles. Please +visit API documentation for details about roles.
      • +
    • shared (bool or None) – Defaults to false. Set to true to publish the view to other users. +The widgets of a shared view are visible to other users.
      • +
    • weight (long or None) – Determines placement of view relative to other views. The lower the +weight, the higher it is in the placement order. format: int32
      • +
    • widgets (list of WidgetItem) – Array of widgets that are part of the view.
      • +
    +
    -class com.vmware.nsx_policy.model_client.VifAttachmentContext(app_id=None, parent_vif_id=None, traffic_tag=None, vif_type=None, allocate_addresses=None, resource_type='VifAttachmentContext')
    +class com.vmware.nsx_policy.model_client.VifAttachmentContext(app_id=None, parent_vif_id=None, traffic_tag=None, transport_node_uuid=None, vif_type=None, allocate_addresses=None, resource_type='VifAttachmentContext')

    Bases: vmware.vapi.bindings.struct.VapiStruct

    Tip

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • app_id (str or None) – An application ID used to identify / look up a child VIF behind a +parent VIF. Only effective when vif_type is CHILD.
      • +
    • parent_vif_id (str or None) – VIF ID of the parent VIF if vif_type is CHILD
      • +
    • traffic_tag (long or None) – Current we use VLAN id as the traffic tag. Only effective when +vif_type is CHILD. Each logical port inside a container must have a +unique traffic tag. If the traffic_tag is not unique, no error is +generated, but traffic will not be delivered to any port with a +non-unique tag. format: int32
      • +
    • transport_node_uuid (str or None) – Only effective when vif_type is INDEPENDENT. Each logical port +inside a bare metal server or container must have a transport node +UUID. We use transport node ID as transport node UUID.
      • +
    • vif_type (str) –

      Possible values are:

      + +
      +
      Type of the VIF attached to logical port
      +
      • +
    • allocate_addresses (str or None) –

      Possible values are:

      + +

      A flag to indicate whether to allocate addresses from allocation +pools bound to the parent logical switch.

      +
      • +
    • resource_type (str) – Used to identify which concrete class it is
      • +
    +
    VIF_TYPE_CHILD = 'CHILD'
    @@ -23698,6 +76238,145 @@ names.

    +
    +
    +class com.vmware.nsx_policy.model_client.VirtualEndpoint(service_names=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='VirtualEndpoint', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, target_ips=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    A VirtualEndpoint represents an IP (or nexthop) which is outside SDDC. It +represents a redirection target for RedirectionPolicy.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • service_names (list of str) – One VirtualEndpoint will be created per service name.
      • +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • parent_path (str or None) – Path of its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • path (str or None) – Absolute path of this object +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • relative_path (str or None) – Path relative from its parent +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • children (list of ChildPolicyConfigResource or None) – subtree for this type within policy tree containing nested +elements.
      • +
    • marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a +delete is invoked on them. They are marked for deletion and only +when all the realized entities for that intent object gets deleted, +the intent object is deleted. Objects that are marked for deletion +are not returned in GET call. One can use the search API to get +these objects. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • target_ips (list of IPInfo) – IPs where either inbound or outbound traffic is to be redirected.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.VirtualEndpointListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Collection of vitual endpoints under a tier-0

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of VirtualEndpoint) – All virtual endpoints under a tier-0
      • +
    +
    +
    +
    class com.vmware.nsx_policy.model_client.VirtualMachine(links=None, schema=None, self_=None, last_sync_time=None, description=None, display_name=None, resource_type=None, tags=None, compute_ids=None, external_id=None, host_id=None, local_id_on_host=None, power_state=None, source=None, type=None)
    @@ -23707,6 +76386,60 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • last_sync_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • compute_ids (list of str) – List of external compute ids of the virtual machine in the format +‘id-type-key:value’ , list of external compute ids +[‘uuid:xxxx-xxxx-xxxx-xxxx’, ‘moIdOnHost:moref-11’, +‘instanceUuid:xxxx-xxxx-xxxx-xxxx’]
      • +
    • external_id (str) – Current external id of this virtual machine in the system.
      • +
    • host_id (str or None) – Id of the host in which this virtual machine exists.
      • +
    • local_id_on_host (str) – Id of the vm unique within the host.
      • +
    • power_state (str) –

      Possible values are:

      + +
      +
      Current power state of this virtual machine in the system.
      +
      • +
    • source (ResourceReference or None) – Reference of the Host or Public Cloud Gateway that reported the VM
      • +
    • type (str or None) –

      Possible values are:

      + +
      +
      Virtual Machine type; Edge, Service VM or other.
      +

      This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    +
    POWER_STATE_UNKNOWN = 'UNKNOWN'
    @@ -23753,6 +76486,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of VirtualMachine) – VirtualMachine list results
      • +
    +
    @@ -23767,6 +76533,20 @@ for NSX T or a moid for NSX V

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • tags (list of Tag) – List of tags to be applied on the virtual machine
      • +
    • virtual_machine_id (str) – The identifier that is used in the enforcement point that uniquely +identifies the virtual machine. In case of NSXT it would be the +value of the external_id of the virtual machine.
      • +
    +
    @@ -23778,6 +76558,166 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • last_sync_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • device_key (str) – Device key of the virtual network interface.
      • +
    • device_name (str or None) – Device name of the virtual network interface.
      • +
    • external_id (str) – External Id of the virtual network inferface.
      • +
    • host_id (str) – Id of the host on which the vm exists.
      • +
    • ip_address_info (list of IpAddressInfo or None) – IP Addresses of the the virtual network interface, from various +sources.
      • +
    • lport_attachment_id (str or None) – LPort Attachment Id of the virtual network interface.
      • +
    • mac_address (str) – MAC address of the virtual network interface.
      • +
    • owner_vm_id (str) – Id of the vm to which this virtual network interface belongs.
      • +
    • vm_local_id_on_host (str) – Id of the vm unique within the host.
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.VirtualNetworkInterfaceElement(element_id=None, elements=None, resource_name=None, resource_type=None, device_key=None, device_name=None, ip_addresses=None, mac_address=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    Virtual Network Interface extends from Element class. This class contains +vnic information of a VM.

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters: +
    +
    +
    +RESOURCE_TYPE_EDGENODEELEMENT = 'EdgeNodeElement'
    +
    + +
    +
    +RESOURCE_TYPE_GROUPELEMENT = 'GroupElement'
    +
    + +
    +
    +RESOURCE_TYPE_HOSTNODEELEMENT = 'HostNodeElement'
    +
    + +
    +
    +RESOURCE_TYPE_LBVIRTUALSERVERELEMENT = 'LBVirtualServerElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOADBALANCERSERVICEELEMENT = 'LoadBalancerServiceElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALROUTERPORTELEMENT = 'LogicalRouterPortElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALSWITCHELEMENT = 'LogicalSwitchElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALSWITCHPORTELEMENT = 'LogicalSwitchPortElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALT0ROUTERELEMENT = 'LogicalT0RouterElement'
    +
    + +
    +
    +RESOURCE_TYPE_LOGICALT1ROUTERELEMENT = 'LogicalT1RouterElement'
    +
    + +
    +
    +RESOURCE_TYPE_PROCESSELEMENT = 'ProcessElement'
    +
    + +
    +
    +RESOURCE_TYPE_VIRTUALNETWORKINTERFACEELEMENT = 'VirtualNetworkInterfaceElement'
    +
    + +
    +
    +RESOURCE_TYPE_VMELEMENT = 'VMElement'
    +
    +
    @@ -23789,6 +76729,142 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of VirtualNetworkInterface) – VirtualNetworkInterface list results
      • +
    +
    +
    + +
    +
    +class com.vmware.nsx_policy.model_client.VirtualServiceInstance(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='VirtualServiceInstance', tags=None, on_failure_policy=None, service_id=None, transport_type=None)
    +

    Bases: vmware.vapi.bindings.struct.VapiStruct

    +

    VirtualServiceInstance is a custom instance to be used when NSX is not +handling the lifecycles of appliance/s and the user is not bringing their +own appliance (BYOD).

    +
    +

    Tip

    +

    The arguments are used to initialize data attributes with the same +names.

    +
    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      ServiceInstance is used when NSX handles the lifecyle of appliance. +Deployment and appliance related all the information is necessary. +ByodServiceInstance is a custom instance to be used when NSX is not +handling the lifecycles of appliance/s. User will manage their own +appliance (BYOD) to connect with NSX. VirtualServiceInstance is a a +custom instance to be used when NSX is not handling the lifecycle +of an appliance and when the user is not bringing their own +appliance.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • on_failure_policy (str or None) –

      Possible values are:

      + +

      Failure policy of the service instance - if it has to be different +from the service. By default the service instance inherits the +FailurePolicy of the service it belongs to.

      +
      • +
    • service_id (str or None) – The Service to which the service instance is associated. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • transport_type (str) –

      Possible values are:

      + +

      Transport to be used by this service instance for deploying the +Service-VM.

      +
      • +
    +
    @@ -23800,6 +76876,27 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    @@ -23812,6 +76909,14 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:vlan_ranges (list of TrunkVlanRange) – Trunk VLAN id ranges
    @@ -23825,6 +76930,15 @@ the partner appliance that needs to be configured by the NSX Manager.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:nic_infos (list of NicInfo) – Set of information of a VM on the network interfaces present on the +partner appliance that needs to be configured by the NSX Manager.
    @@ -23838,6 +76952,20 @@ migration.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • dest_network_id (str) – Only VLAN type of logical switch can be specified here, as +migration operation is only supported for these types.
      • +
    • src_interface_id (str) – The ID (for example, vmk0) of the vmkernal interface on ESX to +migrate.
      • +
    +
    @@ -23849,6 +76977,62 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • ranges (list of VniRange) – VNI range list results
      • +
    +
    @@ -23860,6 +77044,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of VniPool) – VNI pool list results
      • +
    +
    @@ -23872,11 +77089,33 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • end (long) – End value for vni range to be used for virtual networks format: +int64
      • +
    • start (long) – Start value for vni range to be used for virtual networks format: +int64
      • +
    +
    -class com.vmware.nsx_policy.model_client.VsphereClusterNodeVMDeploymentConfig(allow_ssh_root_login=None, compute_id=None, default_gateway_addresses=None, enable_ssh=None, host_id=None, hostname=None, management_network_id=None, management_port_subnets=None, storage_id=None, vc_id=None, placement_type='VsphereClusterNodeVMDeploymentConfig')
    +class com.vmware.nsx_policy.model_client.VsphereClusterNodeVMDeploymentConfig(allow_ssh_root_login=None, compute_id=None, default_gateway_addresses=None, dns_servers=None, enable_ssh=None, host_id=None, hostname=None, management_network_id=None, management_port_subnets=None, ntp_servers=None, storage_id=None, vc_id=None, placement_type='VsphereClusterNodeVMDeploymentConfig')

    Bases: vmware.vapi.bindings.struct.VapiStruct

    Config for deploying a cluster node VM through a Vcenter server

    @@ -23884,6 +77123,60 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • allow_ssh_root_login (bool or None) – If true, the root user will be allowed to log into the VM. Allowing +root SSH logins is not recommended for security reasons.
      • +
    • compute_id (str) – The cluster node VM will be deployed on the specified cluster or +resourcepool for specified VC server.
      • +
    • default_gateway_addresses (list of str or None) – The default gateway for the VM to be deployed must be specified if +all the other VMs it communicates with are not in the same subnet. +Do not specify this field and management_port_subnets to use DHCP. +Note: only single IPv4 default gateway address is supported and it +must belong to management network. IMPORTANT: Controllers deployed +using DHCP are currently not supported, so this parameter should be +specified for deploying Controllers. format: ip
      • +
    • dns_servers (list of str or None) – List of DNS servers. If DHCP is used, the default DNS servers +associated with the DHCP server will be used instead. format: ipv4
      • +
    • enable_ssh (bool or None) – If true, the SSH service will automatically be started on the VM. +Enabling SSH service is not recommended for security reasons.
      • +
    • host_id (str or None) – The cluster node VM will be deployed on the specified host in the +specified VC server within the cluster if host_id is specified. +Note: User must ensure that storage and specified networks are +accessible by this host.
      • +
    • hostname (str) – Desired host name/FQDN for the VM to be deployed
      • +
    • management_network_id (str) – Distributed portgroup identifier to which the management vnic of +cluster node VM will be connected.
      • +
    • management_port_subnets (list of IPSubnet or None) – IP Address and subnet configuration for the management port. Do not +specify this field and default_gateway_addresses to use DHCP. Note: +only one IPv4 address is supported for the management port. +IMPORTANT: Controllers deployed using DHCP are currently not +supported, so this parameter should be specified for deploying +Controllers.
      • +
    • ntp_servers (list of str or None) – List of NTP servers. To use hostnames, a DNS server must be +defined. If not using DHCP, a DNS server should be specified under +dns_servers. format: hostname-or-ipv4
      • +
    • storage_id (str) – The cluster node VM will be deployed on the specified datastore in +the specified VC server. User must ensure that storage is +accessible by the specified cluster/host.
      • +
    • vc_id (str) – The VC-specific identifiers will be resolved on this VC, so all +other identifiers specified in the config must belong to this +Vcenter server.
      • +
    • placement_type (str) –

      Possible values are:

      + +

      Specifies the config for the platform through which to deploy the +VM

      +
      • +
    +
    @@ -23899,6 +77192,52 @@ management_port_subnets, dns_servers and default_gateway_addresses.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • allow_ssh_root_login (bool or None) – Allowing root SSH logins is not recommended for security reasons.
      • +
    • compute_id (str) – The edge node vm will be deployed on the specified cluster or +resourcepool. Note - all the hosts must have nsx fabric prepared in +the specified cluster.
      • +
    • data_network_ids (list of str) – List of distributed portgroup or VLAN logical identifiers to which +the datapath serving vnics of edge node vm will be connected.
      • +
    • default_gateway_addresses (list of str or None) – The default gateway for edge node must be specified if all the +nodes it communicates with are not in the same subnet. Note: Only +single IPv4 default gateway address is supported and it must belong +to management network. format: ip
      • +
    • dns_servers (list of str or None) – List of DNS servers. format: ip
      • +
    • enable_ssh (bool or None) – Enabling SSH service is not recommended for security reasons.
      • +
    • host_id (str or None) – The edge node vm will be deployed on the specified Host within the +cluster if host_id is specified. Note - User must ensure that +storage and specified networks are accessible by this host.
      • +
    • hostname (str) – Host name or FQDN for edge node.
      • +
    • management_network_id (str) – Distributed portgroup identifier to which the management vnic of +edge node vm will be connected. This portgroup must have +connectivity with MP and CCP. A VLAN logical switch identifier may +also be specified.
      • +
    • management_port_subnets (list of IPSubnet or None) – IP Address and subnet configuration for the management port. Note: +only one IPv4 address is supported for the management port.
      • +
    • ntp_servers (list of str or None) – List of NTP servers. format: ip
      • +
    • search_domains (list of str or None) – List of domain names that are used to complete unqualified host +names.
      • +
    • storage_id (str) – The edge node vm will be deployed on the specified datastore. User +must ensure that storage is accessible by the specified +cluster/host.
      • +
    • vc_id (str) – The vc specific identifiers will be resolved on this VC. So all +other identifiers specified here must belong to this vcenter +server.
      • +
    • placement_type (str) –

      Possible values are:

      + +
      • +
    +
    @@ -23910,6 +77249,22 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • file_name (str or None) – File name set by HTTP server if API returns CSV result as a file.
      • +
    • last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has +never updated the data. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of VtepTableCsvRecord or None) –
      • +
    +
    @@ -23922,6 +77277,63 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str or None) – Defaults to ID if not set
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str or None) – The type of this resource.
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • pool_usage (VtepLabelPoolUsage or None) – Pool usage statistics
      • +
    • ranges (list of VtepLabelRange) – Array of ranges for virtual tunnel endpoint labels
      • +
    +
    @@ -23933,6 +77345,39 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of VtepLabelPool) – Virtual tunnel endpoint label pool list results
      • +
    +
    @@ -23945,6 +77390,25 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • allocated_ids (long or None) – Total number of allocated IDs in a pool format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • free_ids (long or None) – Total number of free IDs in a pool format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • total_ids (long or None) – Total number of IDs in a pool format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -23956,6 +77420,26 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • end (long) – End value for virtual tunnel endpoint label range format: int64
      • +
    • start (long) – Start value for virtual tunnel endpoint label range format: int64
      • +
    +
    @@ -23967,6 +77451,49 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has +never updated the data. format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • logical_switch_id (str or None) – The id of the logical Switch +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • results (list of VtepTableEntry or None) –
      • +
    • transport_node_id (str or None) – Transport node identifier +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -23978,6 +77505,20 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • segment_id (str or None) – The segment Id
      • +
    • vtep_ip (str or None) – The virtual tunnel endpoint IP address format: ip
      • +
    • vtep_label (long) – The virtual tunnel endpoint label format: int64
      • +
    • vtep_mac_address (str) – The virtual tunnel endpoint MAC address
      • +
    +
    @@ -23989,6 +77530,20 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • segment_id (str or None) – The segment Id
      • +
    • vtep_ip (str or None) – The virtual tunnel endpoint IP address format: ip
      • +
    • vtep_label (long or None) – The virtual tunnel endpoint label format: int64
      • +
    • vtep_mac_address (str or None) – The virtual tunnel endpoint MAC address
      • +
    +
    @@ -24001,6 +77556,28 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    @@ -24012,6 +77589,35 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters: +
    DAY_OF_WEEK_FRIDAY = 'FRIDAY'
    @@ -24061,6 +77667,88 @@ in-general.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • self (SelfResourceLink or None) – Link to this resource
      • +
    • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
      • +
    • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • description (str or None) – Description of this resource
      • +
    • display_name (str) – Title of the widget.
      • +
    • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • resource_type (str) –

      Possible values are:

      + +

      Supported visualization types are LabelValueConfiguration, +DonutConfiguration, GridConfiguration, StatsConfiguration, +MultiWidgetConfiguration and ContainerConfiguration.

      +
      • +
    • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
      • +
    • datasources (list of Datasource or None) – The ‘datasources’ represent the sources from which data will be +fetched. Currently, only NSX-API is supported as a ‘default’ +datasource. An example of specifying ‘default’ datasource along +with the urls to fetch data from is given at ‘example_request’ +section of ‘CreateWidgetConfiguration’ API.
      • +
    • drilldown_id (str or None) – Id of drilldown widget, if any. Id should be a valid id of an +existing widget. A widget is considered as drilldown widget when it +is associated with any other widget and provides more detailed +information about any data item from the parent widget.
      • +
    • footer (Footer or None) –
      • +
    • is_drilldown (bool or None) – Set to true if this widget should be used as a drilldown.
      • +
    • shared (bool or None) – Please use the property ‘shared’ of View instead of this. The +widgets of a shared view are visible to other users.
      • +
    • weight (long or None) – Specify relavite weight in WidgetItem for placement in a view. +Please see WidgetItem for details. format: int32
      • +
    +
    RESOURCE_TYPE_CONTAINERCONFIGURATION = 'ContainerConfiguration'
    @@ -24104,6 +77792,24 @@ multi-widget or a View.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • label (Label or None) – Applicable for ‘DonutConfiguration’ and ‘StatsConfiguration’ +reports only. If label is not specified, then it defaults to the +label of the donut or stats report.
      • +
    • weight (long or None) – Determines placement of widget or container relative to other +widgets and containers. The lower the weight, the higher it is in +the placement order. format: int32
      • +
    • widget_id (str) – Id of the widget configuration that is held by a multi-widget or a +container or a view.
      • +
    +
    @@ -24115,6 +77821,91 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • dsa_public_keyg (str or None) – One of the DSA cryptogaphic algorithm’s strength parameters, base +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • dsa_public_keyp (str or None) – One of the DSA cryptogaphic algorithm’s strength parameters, prime +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • dsa_public_keyq (str or None) – One of the DSA cryptogaphic algorithm’s strength parameters, +sub-prime +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • dsa_public_keyy (str or None) – One of the DSA cryptogaphic algorithm’s strength parameters +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • is_ca (bool or None) – True if this is a CA certificate +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • is_valid (bool or None) – True if this certificate is valid +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • issuer (str or None) – the certificate issuers complete distinguished name +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • issuer_cn (str or None) – the certificate issuer’s common name +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • not_after (long or None) – the time in epoch milliseconds at which the certificate becomes +invalid format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • not_before (long or None) – the time in epoch milliseconds at which the certificate becomes +valid format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • public_key_algo (str or None) –

      Possible values are:

      + +
      +
      Cryptographic algorithm used by the public key for data encryption
      +

      This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

      +
      • +
    • public_key_length (long or None) – size measured in bits of the public/private keys used in a +cryptographic algorithm format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • rsa_public_key_exponent (str or None) – An RSA public key is made up of the modulus and the public +exponent. Exponent is a power number +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • rsa_public_key_modulus (str or None) – An RSA public key is made up of the modulus and the public +exponent. Modulus is wrap around number +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • serial_number (str or None) – certificate’s serial number +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • signature (str or None) – the signature value(the raw signature bits) used for signing and +validate the cert +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • signature_algorithm (str or None) – the algorithm used by the Certificate Authority to sign the +certificate +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • subject (str or None) – the certificate owners complete distinguished name +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • subject_cn (str or None) – the certificate owner’s common name +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • version (str or None) – Certificate version (default v1) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    PUBLIC_KEY_ALGO_DSA = 'DSA'
    @@ -24137,6 +77928,28 @@ names.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • crl_entries (list of X509CrlEntry or None) – list of X509CrlEntry +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • issuer (str or None) – Issuer’s distinguished name(DN) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • next_update (str or None) – Next update time for the CRL +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • version (str or None) – CRL’s version number either 1 or 2 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -24150,6 +77963,22 @@ number.

    The arguments are used to initialize data attributes with the same names.

    + +++ + + + +
    Parameters:
      +
    • revocation_date (str or None) – Revocation date +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    • serial_number (str or None) – the revoked certificate’s serial number +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
      • +
    +
    @@ -24159,6 +77988,14 @@ names.

    class com.vmware.nsx_policy.tasks_client.Response(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    get(task_id)
    @@ -24198,6 +78035,190 @@ Not Found
    class com.vmware.nsx_policy.tasks_client.StubFactory(stub_config)

    Bases: vmware.vapi.bindings.stub.StubFactoryBase

    +

    Initialize StubFactoryBase

    + +++ + + + +
    Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
    +
    + + +
    +

    com.vmware.nsx_policy.telemetry_client module

    +
    +
    +class com.vmware.nsx_policy.telemetry_client.Agreement(config)
    +

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    +
    +
    +get()
    +

    Returns telemetry agreement information.

    + +++ + + + + + + + + + + + + + + + +
    Return type:com.vmware.nsx_policy.model_client.TelemetryAgreement
    Returns:com.vmware.nsx_policy.model.TelemetryAgreement
    Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
    Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
    Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
    Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
    Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
    +
    + +
    +
    +update(telemetry_agreement)
    +

    Set telemetry agreement information.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:telemetry_agreement (com.vmware.nsx_policy.model_client.TelemetryAgreement) – (required)
    Return type:com.vmware.nsx_policy.model_client.TelemetryAgreement
    Returns:com.vmware.nsx_policy.model.TelemetryAgreement
    Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
    Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
    Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
    Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
    Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.telemetry_client.Config(config)
    +

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    +
    +
    +get()
    +

    Returns the telemetry configuration.

    + +++ + + + + + + + + + + + + + + + +
    Return type:com.vmware.nsx_policy.model_client.TelemetryConfig
    Returns:com.vmware.nsx_policy.model.TelemetryConfig
    Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
    Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
    Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
    Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
    Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
    +
    + +
    +
    +update(telemetry_config)
    +

    Updates or creates the telemetry configuration, and returns the new +configuration.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:telemetry_config (com.vmware.nsx_policy.model_client.TelemetryConfig) – (required)
    Return type:com.vmware.nsx_policy.model_client.TelemetryConfig
    Returns:com.vmware.nsx_policy.model.TelemetryConfig
    Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
    Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
    Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
    Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
    Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.telemetry_client.StubFactory(stub_config)
    +

    Bases: vmware.vapi.bindings.stub.StubFactoryBase

    +

    Initialize StubFactoryBase

    + +++ + + + +
    Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
    @@ -24207,6 +78228,14 @@ Not Found
    class com.vmware.nsx_policy.trust_management_client.Certificates(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    LIST_TYPE_CERTIFICATE = 'cluster_api_certificate'
    @@ -24395,6 +78424,14 @@ Not Found

    class com.vmware.nsx_policy.trust_management_client.Crls(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    LIST_TYPE_CERTIFICATE = 'cluster_api_certificate'
    @@ -24617,6 +78654,14 @@ Not Found

    class com.vmware.nsx_policy.trust_management_client.Csrs(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    create(csr)
    @@ -24871,6 +78916,14 @@ Not Found

    class com.vmware.nsx_policy.trust_management_client.PrincipalIdentities(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    create(principal_identity)
    @@ -25037,6 +79090,15 @@ Not Found
    class com.vmware.nsx_policy.trust_management_client.StubFactory(stub_config)

    Bases: vmware.vapi.bindings.stub.StubFactoryBase

    +

    Initialize StubFactoryBase

    + +++ + + + +
    Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
    @@ -25046,12 +79108,29 @@ Not Found
    class com.vmware.nsx_policy.upgrade_client.StubFactory(stub_config)

    Bases: vmware.vapi.bindings.stub.StubFactoryBase

    +

    Initialize StubFactoryBase

    + +++ + + + +
    Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
    class com.vmware.nsx_policy.upgrade_client.VersionWhitelist(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    get(component_type)
    @@ -25181,7 +79260,7 @@ Not Found

    - © Copyright 2018, VMware, Inc.. + © Copyright 2018, VMware, Inc.

    @@ -25200,33 +79279,22 @@ Not Found

    - - - - + + + + + + + + - - - - + diff --git a/nsx/nsx_policy/com.vmware.nsx_policy.infra.domains.groups.html b/nsx/nsx_policy/com.vmware.nsx_policy.infra.domains.groups.html index c98b42e1..c24e6b9e 100644 --- a/nsx/nsx_policy/com.vmware.nsx_policy.infra.domains.groups.html +++ b/nsx/nsx_policy/com.vmware.nsx_policy.infra.domains.groups.html @@ -8,7 +8,7 @@ - com.vmware.nsx_policy.infra.domains.groups package — NSX-T Policy SDK 2.2.0.0.0 documentation + com.vmware.nsx_policy.infra.domains.groups package — NSX-T Policy SDK 2.3.0.0.1 documentation @@ -24,12 +24,11 @@ - - + - + @@ -59,7 +58,7 @@
    - 2.2.0.0.0 + 2.3.0.0.1
    @@ -91,6 +90,7 @@
  • Subpackages
  • Submodules
  • com.vmware.nsx_policy_client module
    • +
  • com.vmware.nsx_policy_client_for_vmc module
    • @@ -175,6 +175,91 @@

    com.vmware.nsx_policy.infra.domains.groups package

    Submodules

    +
    +
    +

    com.vmware.nsx_policy.infra.domains.groups.members_client module

    +
    +
    +class com.vmware.nsx_policy.infra.domains.groups.members_client.IpAddresses(config)
    +

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    +
    +
    +list(domain_id, group_id, enforcement_point_path, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    +

    Get IP addresses that belong to this Group

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:
      +
    • domain_id (str) – Domain id (required)
      • +
    • group_id (str) – Group Id (required)
      • +
    • enforcement_point_path (str) – String Path of the enforcement point (required)
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
      • +
    • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
      • +
    • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
      • +
    • sort_ascending (bool or None) – (optional)
      • +
    • sort_by (str or None) – Field by which records are sorted (optional)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.PolicyGroupIPMembersListResult

    +
    Returns:

    com.vmware.nsx_policy.model.PolicyGroupIPMembersListResult

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.infra.domains.groups.members_client.StubFactory(stub_config)
    +

    Bases: vmware.vapi.bindings.stub.StubFactoryBase

    +

    Initialize StubFactoryBase

    + +++ + + + +
    Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
    +
    +

    com.vmware.nsx_policy.infra.domains.groups.statistics_client module

    @@ -182,12 +267,29 @@
    class com.vmware.nsx_policy.infra.domains.groups.statistics_client.StubFactory(stub_config)

    Bases: vmware.vapi.bindings.stub.StubFactoryBase

    +

    Initialize StubFactoryBase

    + +++ + + + +
    Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
    class com.vmware.nsx_policy.infra.domains.groups.statistics_client.VirtualMachines(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    list(domain_id, group_id, cursor=None, enforcement_point_path=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    @@ -255,7 +357,7 @@ Not Found

    -
    -

    com.vmware.nsx_policy.infra.domains.edge_communication_maps_client module

    +
    +

    com.vmware.nsx_policy.infra.domains.gateway_policies_client module

    -
    -class com.vmware.nsx_policy.infra.domains.edge_communication_maps_client.CommunicationEntries(config)
    +
    +class com.vmware.nsx_policy.infra.domains.gateway_policies_client.Rules(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    -
    -delete(domain_id, edge_communication_map_id, communication_entry_id)
    -

    Delete CommunicationEntry

    +
    +delete(domain_id, gateway_policy_id, rule_id)
    +

    Delete Rule

    @@ -545,24 +571,24 @@ Not Found

    -
    -get(domain_id, edge_communication_map_id, communication_entry_id)
    -

    Read CommunicationEntry

    +
    +get(domain_id, gateway_policy_id, rule_id)
    +

    Read rule

    Parameters:
    • domain_id (str) – (required)
      • -
    • edge_communication_map_id (str) – (required)
      • -
    • communication_entry_id (str) – (required)
      • +
    • gateway_policy_id (str) – (required)
      • +
    • rule_id (str) – (required)
    - -
    Parameters:
    • domain_id (str) – (required)
      • -
    • edge_communication_map_id (str) – (required)
      • -
    • communication_entry_id (str) – (required)
      • +
    • gateway_policy_id (str) – (required)
      • +
    • rule_id (str) – (required)
    Return type:

    com.vmware.nsx_policy.model_client.CommunicationEntry

    +
    Return type:

    com.vmware.nsx_policy.model_client.Rule
    Returns:

    com.vmware.nsx_policy.model.CommunicationEntry

    +
    Returns:

    com.vmware.nsx_policy.model.Rule
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable @@ -590,16 +616,16 @@ Not Found

    -
    -list(domain_id, edge_communication_map_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    -

    List CommunicationEntries

    +
    +list(domain_id, gateway_policy_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    +

    List Rules

    - -
    Parameters:
    • domain_id (str) – (required)
      • -
    • edge_communication_map_id (str) – (required)
      • +
    • gateway_policy_id (str) – (required)
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
    • included_fields (str or None) – Comma separated list of fields that should be included in query @@ -611,10 +637,10 @@ fewer) (optional, default to 1000)
    Return type:

    com.vmware.nsx_policy.model_client.CommunicationEntryListResult

    +
    Return type:

    com.vmware.nsx_policy.model_client.RuleListResult
    Returns:

    com.vmware.nsx_policy.model.CommunicationEntryListResult

    +
    Returns:

    com.vmware.nsx_policy.model.RuleListResult
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable @@ -642,20 +668,19 @@ Not Found

    -
    -patch(domain_id, edge_communication_map_id, communication_entry_id, communication_entry)
    -

    Update the edge CommunicationEntry. If a CommunicationEntry with the -entry-id is not already present, this API fails with a 404. Creation of -CommunicationEntries is not allowed using this API.

    +
    +patch(domain_id, gateway_policy_id, rule_id, rule)
    +

    Update the gateway rule. If a rule with the rule-id is not already +present, then create new rule.

    @@ -684,27 +709,26 @@ Not Found

    -
    -update(domain_id, edge_communication_map_id, communication_entry_id, communication_entry)
    -

    Update the edge CommunicationEntry. If a CommunicationEntry with the -entry-id is not already present, this API fails with a 404. Creation of -CommunicationEntries is not allowed using this API.

    +
    +update(domain_id, gateway_policy_id, rule_id, rule)
    +

    Update the gateway rule. If a rule with the rule-id is not already +present, create new rule.

    Parameters:
    - -
    Parameters:
    Return type:

    com.vmware.nsx_policy.model_client.CommunicationEntry

    +
    Return type:

    com.vmware.nsx_policy.model_client.Rule
    Returns:

    com.vmware.nsx_policy.model.CommunicationEntry

    +
    Returns:

    com.vmware.nsx_policy.model.Rule
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable @@ -734,9 +758,18 @@ Not Found

    -
    -class com.vmware.nsx_policy.infra.domains.edge_communication_maps_client.StubFactory(stub_config)
    +
    +class com.vmware.nsx_policy.infra.domains.gateway_policies_client.StubFactory(stub_config)

    Bases: vmware.vapi.bindings.stub.StubFactoryBase

    +

    Initialize StubFactoryBase

    + +++ + + + +
    Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
    @@ -746,6 +779,14 @@ Not Found

    class com.vmware.nsx_policy.infra.domains.groups_client.PortMirroringInstances(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    delete(domain_id, group_id, port_mirroring_instance_id)
    @@ -980,27 +1021,44 @@ Not Found

    class com.vmware.nsx_policy.infra.domains.groups_client.StubFactory(stub_config)

    Bases: vmware.vapi.bindings.stub.StubFactoryBase

    +

    Initialize StubFactoryBase

    + +++ + + + +
    Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
    -
    -

    com.vmware.nsx_policy.infra.domains.redirection_communication_maps_client module

    +
    +

    com.vmware.nsx_policy.infra.domains.redirection_policies_client module

    -
    -class com.vmware.nsx_policy.infra.domains.redirection_communication_maps_client.CommunicationEntries(config)
    +
    +class com.vmware.nsx_policy.infra.domains.redirection_policies_client.Rules(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    -
    -delete(domain_id, redirection_map_id, communication_entry_id)
    -

    Delete RedirectionCommunicationEntry

    +
    +delete(domain_id, redirection_policy_id, rule_id)
    +

    Delete RedirectionRule

    @@ -1029,24 +1087,25 @@ Not Found

    -
    -get(domain_id, redirection_map_id, communication_entry_id)
    -

    Read communication entry

    +
    +get(domain_id, redirection_policy_id, rule_id)
    +

    Read redirection rule for the given redirection policy and redirection +rule id.

    Parameters:
    • domain_id (str) – Domain ID (required)
      • -
    • redirection_map_id (str) – Redirection Map ID (required)
      • -
    • communication_entry_id (str) – RedirectionCommunicationEntry ID (required)
      • +
    • redirection_policy_id (str) – Redirection policy ID (required)
      • +
    • rule_id (str) – RedirectionRule ID (required)
    - - @@ -287,9 +307,18 @@ Not Found

    -
    -class com.vmware.nsx_policy.infra.providers.l2vpn_context.l2vpns_client.StubFactory(stub_config)
    +
    +class com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.l2vpns_client.StubFactory(stub_config)

    Bases: vmware.vapi.bindings.stub.StubFactoryBase

    +

    Initialize StubFactoryBase

    +
    Parameters:
    • domain_id (str) – Domain id (required)
      • -
    • redirection_map_id (str) – Redirection map id (required)
      • -
    • communication_entry_id (str) – Communication entry id (required)
      • +
    • redirection_policy_id (str) – Redirection policy id (required)
      • +
    • rule_id (str) – Redirection rule id (required)
    Return type:

    com.vmware.nsx_policy.model_client.RedirectionCommunicationEntry

    +
    Return type:

    com.vmware.nsx_policy.model_client.RedirectionRule
    Returns:

    com.vmware.nsx_policy.model.RedirectionCommunicationEntry

    +
    Returns:

    com.vmware.nsx_policy.model.RedirectionRule
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable @@ -1074,16 +1133,16 @@ Not Found

    -
    -list(domain_id, redirection_map_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    -

    List communication entries

    +
    +list(domain_id, redirection_policy_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    +

    List all the redirection rules for given redirection policy id.

    - - @@ -233,12 +244,20 @@ Not Found

    -
    -class com.vmware.nsx_policy.infra.providers.l2vpn_context.l2vpns_client.Statistics(config)
    +
    +class com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.l2vpns_client.Statistics(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    +
    Parameters:
    • domain_id (str) – Domain id (required)
      • -
    • redirection_map_id (str) – Redirection map id (required)
      • +
    • redirection_policy_id (str) – Redirection policy id (required)
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
    • included_fields (str or None) – Comma separated list of fields that should be included in query @@ -1095,10 +1154,10 @@ fewer) (optional, default to 1000)
    Return type:

    com.vmware.nsx_policy.model_client.RedirectionCommunicationEntryListResult

    +
    Return type:

    com.vmware.nsx_policy.model_client.RedirectionRuleListResult
    Returns:

    com.vmware.nsx_policy.model.RedirectionCommunicationEntryListResult

    +
    Returns:

    com.vmware.nsx_policy.model.RedirectionRuleListResult
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable @@ -1126,19 +1185,19 @@ Not Found

    -
    -patch(domain_id, redirection_map_id, communication_entry_id, redirection_communication_entry)
    -

    Create a communication entry with the communication-entry-id is not -already present, otherwise update the communication entry.

    +
    +patch(domain_id, redirection_policy_id, rule_id, redirection_rule)
    +

    This API creates a redirection rule with given rule-id if it is not +already present, otherwise update it if it already exists.

    @@ -1167,26 +1226,26 @@ Not Found

    -
    -update(domain_id, redirection_map_id, communication_entry_id, redirection_communication_entry)
    -

    Create a communication entry with the communication-entry-id is not -already present, otherwise update the communication entry.

    +
    +update(domain_id, redirection_policy_id, rule_id, redirection_rule)
    +

    This API creates a redirection rule with given rule-id if it is not +already present, otherwise update it if it already exists.

    Parameters:
    - - @@ -265,6 +276,15 @@ Not Found

    class com.vmware.nsx_policy.infra.realized_state.enforcement_points.ops.domains_client.StubFactory(stub_config)

    Bases: vmware.vapi.bindings.stub.StubFactoryBase

    +

    Initialize StubFactoryBase

    +
    Parameters:
    Return type:

    com.vmware.nsx_policy.model_client.RedirectionCommunicationEntry

    +
    Return type:

    com.vmware.nsx_policy.model_client.RedirectionRule
    Returns:

    com.vmware.nsx_policy.model.RedirectionCommunicationEntry

    +
    Returns:

    com.vmware.nsx_policy.model.RedirectionRule
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable @@ -1216,9 +1275,18 @@ Not Found

    -
    -class com.vmware.nsx_policy.infra.domains.redirection_communication_maps_client.StubFactory(stub_config)
    +
    +class com.vmware.nsx_policy.infra.domains.redirection_policies_client.StubFactory(stub_config)

    Bases: vmware.vapi.bindings.stub.StubFactoryBase

    +

    Initialize StubFactoryBase

    + +++ + + + +
    Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
    @@ -1244,7 +1312,7 @@ Not Found

    - © Copyright 2018, VMware, Inc.. + © Copyright 2018, VMware, Inc.

    @@ -1263,33 +1331,22 @@ Not Found

    - - - - + + + + + + + + - - - - + diff --git a/nsx/nsx_policy/com.vmware.nsx_policy.infra.html b/nsx/nsx_policy/com.vmware.nsx_policy.infra.html index cda313dc..f3e9a7d7 100644 --- a/nsx/nsx_policy/com.vmware.nsx_policy.infra.html +++ b/nsx/nsx_policy/com.vmware.nsx_policy.infra.html @@ -8,7 +8,7 @@ - com.vmware.nsx_policy.infra package — NSX-T Policy SDK 2.2.0.0.0 documentation + com.vmware.nsx_policy.infra package — NSX-T Policy SDK 2.3.0.0.1 documentation @@ -24,8 +24,7 @@ - - + @@ -59,7 +58,7 @@
    - 2.2.0.0.0 + 2.3.0.0.1
    @@ -91,6 +90,7 @@
  • Subpackages
  • Submodules
  • com.vmware.nsx_policy_client module
    • +
  • com.vmware.nsx_policy_client_for_vmc module
    • @@ -177,6 +177,7 @@
  • Subpackages -
    • -
  • com.vmware.nsx_policy.infra.networks package -
    • -
  • com.vmware.nsx_policy.infra.providers package
  • com.vmware.nsx_policy.infra.realized_state package
    • +
  • com.vmware.nsx_policy.infra.tier_0s package +
    • +
  • com.vmware.nsx_policy.infra.tier_1s package +
    • @@ -248,6 +258,14 @@
    class com.vmware.nsx_policy.infra.deployment_zones_client.EnforcementPoints(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    delete(deployment_zone_id, enforcementpoint_id)
    @@ -473,6 +491,15 @@ Not Found

    class com.vmware.nsx_policy.infra.deployment_zones_client.StubFactory(stub_config)

    Bases: vmware.vapi.bindings.stub.StubFactoryBase

    +

    Initialize StubFactoryBase

    + +++ + + + +
    Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
    @@ -482,6 +509,14 @@ Not Found

    class com.vmware.nsx_policy.infra.domains_client.CommunicationMaps(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    REVISE_OPERATION_AFTER = 'insert_after'
    @@ -778,6 +813,14 @@ Not Found

    class com.vmware.nsx_policy.infra.domains_client.DiscoverySessions(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    delete(domain_id, discovery_session_id)
    @@ -1001,6 +1044,14 @@ Not Found

    class com.vmware.nsx_policy.infra.domains_client.DomainDeploymentMaps(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    delete(domain_id, domain_deployment_map_id)
    @@ -1223,27 +1274,35 @@ Not Found

    -
    -class com.vmware.nsx_policy.infra.domains_client.EdgeCommunicationMaps(config)
    +
    +class com.vmware.nsx_policy.infra.domains_client.GatewayPolicies(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    -
    -get(domain_id, edge_communication_map_id)
    -

    Read Edge FW ns-communication-map for a domain.

    +
    +get(domain_id, gateway_policy_id)
    +

    Read gateway policy for a domain.

    - -
    class com.vmware.nsx_policy.infra.services_client.ServiceEntries(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    +
    Parameters:
    • domain_id (str) – (required)
      • -
    • edge_communication_map_id (str) – (required)
      • +
    • gateway_policy_id (str) – (required)
    Return type:

    com.vmware.nsx_policy.model_client.EdgeCommunicationMap

    +
    Return type:

    com.vmware.nsx_policy.model_client.GatewayPolicy
    Returns:

    com.vmware.nsx_policy.model.EdgeCommunicationMap

    +
    Returns:

    com.vmware.nsx_policy.model.GatewayPolicy
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable @@ -1271,18 +1330,18 @@ Not Found

    -
    -patch(domain_id, edge_communication_map_id, edge_communication_map)
    -

    Update the communication map for a domain. This is a full replace. All -the CommunicationEntries are replaced.

    +
    +patch(domain_id, gateway_policy_id, gateway_policy)
    +

    Update the gateway policy for a domain. This is a full replace. All the +rules are replaced.

    @@ -1311,25 +1370,25 @@ Not Found

    -
    -update(domain_id, edge_communication_map_id, edge_communication_map)
    -

    Update the communication map for a domain. This is a full replace. All -the CommunicationEntries are replaced.

    +
    +update(domain_id, gateway_policy_id, gateway_policy)
    +

    Update the gateway policy for a domain. This is a full replace. All the +rules are replaced.

    Parameters:
    - -
    class com.vmware.nsx_policy.infra.realized_state_client.StubFactory(stub_config)

    Bases: vmware.vapi.bindings.stub.StubFactoryBase

    +

    Initialize StubFactoryBase

    +
    Parameters:
    Return type:

    com.vmware.nsx_policy.model_client.EdgeCommunicationMap

    +
    Return type:

    com.vmware.nsx_policy.model_client.GatewayPolicy
    Returns:

    com.vmware.nsx_policy.model.EdgeCommunicationMap

    +
    Returns:

    com.vmware.nsx_policy.model.GatewayPolicy
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable @@ -1362,6 +1421,14 @@ Not Found

    class com.vmware.nsx_policy.infra.domains_client.Groups(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    delete(domain_id, group_id, force=None)
    @@ -1586,20 +1653,28 @@ Not Found

    -
    -class com.vmware.nsx_policy.infra.domains_client.RedirectionCommunicationMaps(config)
    +
    +class com.vmware.nsx_policy.infra.domains_client.RedirectionPolicies(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    -
    -delete(domain_id, redirection_map_id)
    -

    Delete redirection communication map.

    +
    +delete(domain_id, redirection_policy_id)
    +

    Delete redirection policy.

    @@ -1628,23 +1703,23 @@ Not Found

    -
    -get(domain_id, redirection_map_id)
    -

    Read redirection communication map.

    +
    +get(domain_id, redirection_policy_id)
    +

    Read redirection policy.

    Parameters:
    • domain_id (str) – Domain id (required)
      • -
    • redirection_map_id (str) – Redirection map id (required)
      • +
    • redirection_policy_id (str) – Redirection policy id (required)
    - -
    class com.vmware.nsx_policy.infra.realized_state_client.RealizedEntity(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    +
    Parameters:
    • domain_id (str) – Domain id (required)
      • -
    • redirection_map_id (str) – Redirection map id (required)
      • +
    • redirection_policy_id (str) – Redirection policy id (required)
    Return type:

    com.vmware.nsx_policy.model_client.RedirectionCommunicationMap

    +
    Return type:

    com.vmware.nsx_policy.model_client.RedirectionPolicy
    Returns:

    com.vmware.nsx_policy.model.RedirectionCommunicationMap

    +
    Returns:

    com.vmware.nsx_policy.model.RedirectionPolicy
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable @@ -1672,17 +1747,68 @@ Not Found

    -
    -patch(domain_id, redirection_map_id, redirection_communication_map)
    -

    Create or update the redirection communication map.

    +
    +list(domain_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    +

    List redirection policies for a domain

    + + + + + + + + + + + + + + + + +
    Parameters:
    • domain_id (str) – Domain id (required)
      • -
    • redirection_map_id (str) – Redirection map id (required)
      • -
    • redirection_communication_map (com.vmware.nsx_policy.model_client.RedirectionCommunicationMap) – (required)
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
      • +
    • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
      • +
    • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
      • +
    • sort_ascending (bool or None) – (optional)
      • +
    • sort_by (str or None) – Field by which records are sorted (optional)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.RedirectionPolicyListResult

    +
    Returns:

    com.vmware.nsx_policy.model.RedirectionPolicyListResult

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +patch(domain_id, redirection_policy_id, redirection_policy)
    +

    Create or update the redirection policy.

    + +++ + @@ -1711,24 +1837,24 @@ Not Found

    -
    -update(domain_id, redirection_map_id, redirection_communication_map)
    -

    Create or update the redirection communication map.

    +
    +update(domain_id, redirection_policy_id, redirection_policy)
    +

    Create or update the redirection policy.

    Parameters:
    - -
    class com.vmware.nsx_policy.infra.partner_services_client.StubFactory(stub_config)

    Bases: vmware.vapi.bindings.stub.StubFactoryBase

    -
    - - -
    -

    com.vmware.nsx_policy.infra.providers_client module

    -
    -
    -class com.vmware.nsx_policy.infra.providers_client.Bgp(config)
    -

    Bases: vmware.vapi.bindings.stub.VapiInterface

    -
    -
    -get(provider_id)
    -

    Read BGP routing config

    +

    Initialize StubFactoryBase

    Parameters:
    Return type:

    com.vmware.nsx_policy.model_client.RedirectionCommunicationMap

    +
    Return type:

    com.vmware.nsx_policy.model_client.RedirectionPolicy
    Returns:

    com.vmware.nsx_policy.model.RedirectionCommunicationMap

    +
    Returns:

    com.vmware.nsx_policy.model.RedirectionPolicy
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable @@ -1761,860 +1887,17 @@ Not Found

    class com.vmware.nsx_policy.infra.domains_client.StubFactory(stub_config)

    Bases: vmware.vapi.bindings.stub.StubFactoryBase

    -
    - - -
    -

    com.vmware.nsx_policy.infra.networks_client module

    -
    -
    -class com.vmware.nsx_policy.infra.networks_client.DnsForwarder(config)
    -

    Bases: vmware.vapi.bindings.stub.VapiInterface

    -
    -
    -delete(network_id)
    -

    Delete DNS configuration for network instance

    +

    Initialize StubFactoryBase

    - - - - - - - - - - - +
    Parameters:network_id (str) – Network ID (required)
    Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable
    Raise:com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed
    Raise:com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error
    Raise:com.vmware.vapi.std.errors_client.Unauthorized -Forbidden
    Raise:com.vmware.vapi.std.errors_client.NotFound -Not Found
    Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
    -
    -
    -get(network_id)
    -

    Read the DNS Forwarder for the given Network instance

    - --- - - - - - - - - - - - - - - - - - -
    Parameters:network_id (str) – Network ID (required)
    Return type:com.vmware.nsx_policy.model_client.PolicyDnsForwarder
    Returns:com.vmware.nsx_policy.model.PolicyDnsForwarder
    Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable
    Raise:com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed
    Raise:com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error
    Raise:com.vmware.vapi.std.errors_client.Unauthorized -Forbidden
    Raise:com.vmware.vapi.std.errors_client.NotFound -Not Found
    -
    - -
    -
    -patch(network_id, policy_dns_forwarder)
    -

    Update the DNS Forwarder

    - --- - - - - - - - - - - - - - -
    Parameters: -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -update(network_id, policy_dns_forwarder)
    -

    Update the DNS Forwarder

    - --- - - - - - - - - - - - - - - - - - -
    Parameters: -
    Return type:

    com.vmware.nsx_policy.model_client.PolicyDnsForwarder

    -
    Returns:

    com.vmware.nsx_policy.model.PolicyDnsForwarder

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    - -
    -
    -class com.vmware.nsx_policy.infra.networks_client.IpfixSwitchCollectionInstances(config)
    -

    Bases: vmware.vapi.bindings.stub.VapiInterface

    -
    -
    -delete(network_id, ipfix_switch_collection_instance_id)
    -

    API deletes IPFIX Switch Collection Instance.Flow forwarding to -selected collector will be stopped.

    - --- - - - - - - - - - - - - - -
    Parameters:
      -
    • network_id (str) – Network ID (required)
      • -
    • ipfix_switch_collection_instance_id (str) – IPFIX Switch Collection Instance ID (required)
      • -
    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -get(network_id, ipfix_switch_collection_instance_id)
    -

    API will return details of IPFIX switch collection. If instance does -not exist, it will return 404.

    - --- - - - - - - - - - - - - - - - - - -
    Parameters:
      -
    • network_id (str) – Network ID (required)
      • -
    • ipfix_switch_collection_instance_id (str) – IPFIX switch collection id (required)
      • -
    -
    Return type:

    com.vmware.nsx_policy.model_client.IPFIXSwitchCollectionInstance

    -
    Returns:

    com.vmware.nsx_policy.model.IPFIXSwitchCollectionInstance

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -list(network_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    -

    API provides list IPFIX Switch collection instances available on -selected logical switch.

    - --- - - - - - - - - - - - - - - - - - -
    Parameters:
      -
    • network_id (str) – Network ID (required)
      • -
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied -by current result page) (optional)
      • -
    • included_fields (str or None) – Comma separated list of fields that should be included in query -result (optional)
      • -
    • page_size (long or None) – Maximum number of results to return in this page (server may return -fewer) (optional, default to 1000)
      • -
    • sort_ascending (bool or None) – (optional)
      • -
    • sort_by (str or None) – Field by which records are sorted (optional)
      • -
    -
    Return type:

    com.vmware.nsx_policy.model_client.IPFIXSwitchCollectionInstanceListResult

    -
    Returns:

    com.vmware.nsx_policy.model.IPFIXSwitchCollectionInstanceListResult

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -patch(network_id, ipfix_switch_collection_instance_id, i_pfix_switch_collection_instance)
    -

    Create a new IPFIX switch collection instance if the IPFIX switch -collection instance with given id does not already exist. If the IPFIX -switch collection instance with the given id already exists, patch with -the existing IPFIX switch collection instance.

    - --- - - - - - - - - - - - - - -
    Parameters: -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -update(network_id, ipfix_switch_collection_instance_id, i_pfix_switch_collection_instance)
    -

    Create or replace IPFIX switch collection instance. Instance will start -forwarding data to provided IPFIX collector.

    - --- - - - - - - - - - - - - - - - - - -
    Parameters: -
    Return type:

    com.vmware.nsx_policy.model_client.IPFIXSwitchCollectionInstance

    -
    Returns:

    com.vmware.nsx_policy.model.IPFIXSwitchCollectionInstance

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    - -
    -
    -class com.vmware.nsx_policy.infra.networks_client.Segments(config)
    -

    Bases: vmware.vapi.bindings.stub.VapiInterface

    -
    -
    -delete(network_id, segment_id)
    -

    Delete segment

    - --- - - - - - - - - - - - - - -
    Parameters:
      -
    • network_id (str) – Network ID (required)
      • -
    • segment_id (str) – Segment ID (required)
      • -
    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -get(network_id, segment_id)
    -

    Read segment

    - --- - - - - - - - - - - - - - - - - - -
    Parameters:
      -
    • network_id (str) – Network ID (required)
      • -
    • segment_id (str) – Segment ID (required)
      • -
    -
    Return type:

    com.vmware.nsx_policy.model_client.Segment

    -
    Returns:

    com.vmware.nsx_policy.model.Segment

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -list(network_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    -

    Paginated list of all segments under network instance

    - --- - - - - - - - - - - - - - - - - - -
    Parameters:
      -
    • network_id (str) – Network ID (required)
      • -
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied -by current result page) (optional)
      • -
    • included_fields (str or None) – Comma separated list of fields that should be included in query -result (optional)
      • -
    • page_size (long or None) – Maximum number of results to return in this page (server may return -fewer) (optional, default to 1000)
      • -
    • sort_ascending (bool or None) – (optional)
      • -
    • sort_by (str or None) – Field by which records are sorted (optional)
      • -
    -
    Return type:

    com.vmware.nsx_policy.model_client.SegmentListResult

    -
    Returns:

    com.vmware.nsx_policy.model.SegmentListResult

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -patch(network_id, segment_id, segment)
    -

    If segment with the segment-id is not already present, create a new -segment. If it already exists, update the segment with specified -attributes.

    - --- - - - - - - - - - - - - - - - - - -
    Parameters: -
    Return type:

    com.vmware.nsx_policy.model_client.Segment

    -
    Returns:

    com.vmware.nsx_policy.model.Segment

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -update(network_id, segment_id, segment)
    -

    If segment with the segment-id is not already present, create a new -segment. If it already exists, replace the segment with this object.

    - --- - - - - - - - - - - - - - - - - - -
    Parameters: -
    Return type:

    com.vmware.nsx_policy.model_client.Segment

    -
    Returns:

    com.vmware.nsx_policy.model.Segment

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    - -
    -
    -class com.vmware.nsx_policy.infra.networks_client.StaticRoutes(config)
    -

    Bases: vmware.vapi.bindings.stub.VapiInterface

    -
    -
    -delete(network_id, route_id)
    -

    Delete network static routes

    - --- - - - - - - - - - - - - - -
    Parameters:
      -
    • network_id (str) – Network ID (required)
      • -
    • route_id (str) – Route ID (required)
      • -
    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -get(network_id, route_id)
    -

    Read network static routes

    - --- - - - - - - - - - - - - - - - - - -
    Parameters:
      -
    • network_id (str) – Network ID (required)
      • -
    • route_id (str) – Route ID (required)
      • -
    -
    Return type:

    com.vmware.nsx_policy.model_client.StaticRoutes

    -
    Returns:

    com.vmware.nsx_policy.model.StaticRoutes

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -list(network_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    -

    Paginated list of all Network Static Routes

    - --- - - - - - - - - - - - - - - - - - -
    Parameters:
      -
    • network_id (str) – Network ID (required)
      • -
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied -by current result page) (optional)
      • -
    • included_fields (str or None) – Comma separated list of fields that should be included in query -result (optional)
      • -
    • page_size (long or None) – Maximum number of results to return in this page (server may return -fewer) (optional, default to 1000)
      • -
    • sort_ascending (bool or None) – (optional)
      • -
    • sort_by (str or None) – Field by which records are sorted (optional)
      • -
    -
    Return type:

    com.vmware.nsx_policy.model_client.StaticRoutesListResult

    -
    Returns:

    com.vmware.nsx_policy.model.StaticRoutesListResult

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -patch(network_id, route_id, static_routes)
    -

    If static routes for route-id are not already present, create static -routes. If it already exists, update static routes for route-id.

    - --- - - - - - - - - - - - - - - - - - -
    Parameters: -
    Return type:

    com.vmware.nsx_policy.model_client.StaticRoutes

    -
    Returns:

    com.vmware.nsx_policy.model.StaticRoutes

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -update(network_id, route_id, static_routes)
    -

    If static routes for route-id are not already present, create static -routes. If it already exists, replace the static routes for route-id.

    - --- - - - - - - - - - - - - - - - - - -
    Parameters: -
    Return type:

    com.vmware.nsx_policy.model_client.StaticRoutes

    -
    Returns:

    com.vmware.nsx_policy.model.StaticRoutes

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    - -
    -
    -class com.vmware.nsx_policy.infra.networks_client.StubFactory(stub_config)
    -

    Bases: vmware.vapi.bindings.stub.StubFactoryBase

    -
    -

    com.vmware.nsx_policy.infra.partner_services_client module

    @@ -2622,6 +1905,14 @@ Not Found

    class com.vmware.nsx_policy.infra.partner_services_client.Eula(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    create(service_name)
    @@ -2701,2203 +1992,17 @@ Unauthorized
    - - - - - - - - - - - - - - - +
    Parameters:provider_id (str) – (required)
    Return type:com.vmware.nsx_policy.model_client.BgpRoutingConfig
    Returns:com.vmware.nsx_policy.model.BgpRoutingConfig
    Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable
    Raise:com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed
    Raise:com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error
    Raise:com.vmware.vapi.std.errors_client.Unauthorized -Forbidden
    Raise:com.vmware.vapi.std.errors_client.NotFound -Not Found
    Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
    -
    -
    -patch(provider_id, bgp_routing_config)
    -

    If an BGP routing config not present, create BGP routing config. If it -already exists, update the routing config.

    - --- - - - - - - - - - - - - - - - - - -
    Parameters: -
    Return type:

    com.vmware.nsx_policy.model_client.BgpRoutingConfig

    -
    Returns:

    com.vmware.nsx_policy.model.BgpRoutingConfig

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -update(provider_id, bgp_routing_config)
    -

    If BGP routing config is not already present, create BGP routing -config. If it already exists, replace the BGP routing config with this -object.

    - --- - - - - - - - - - - - - - - - - - -
    Parameters: -
    Return type:

    com.vmware.nsx_policy.model_client.BgpRoutingConfig

    -
    Returns:

    com.vmware.nsx_policy.model.BgpRoutingConfig

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - - - -
    -
    -class com.vmware.nsx_policy.infra.providers_client.ByodServiceInstances(config)
    -

    Bases: vmware.vapi.bindings.stub.VapiInterface

    -
    -
    -delete(provider_id, service_instance_id)
    -

    Delete policy service instance

    - --- - - - - - - - - - - - - - -
    Parameters:
      -
    • provider_id (str) – Provider id (required)
      • -
    • service_instance_id (str) – Service instance id (required)
      • -
    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -get(provider_id, service_instance_id)
    -

    Read byod service instance

    - --- - - - - - - - - - - - - - - - - - -
    Parameters:
      -
    • provider_id (str) – Provider id (required)
      • -
    • service_instance_id (str) – Service instance id (required)
      • -
    -
    Return type:

    com.vmware.nsx_policy.model_client.ByodPolicyServiceInstance

    -
    Returns:

    com.vmware.nsx_policy.model.ByodPolicyServiceInstance

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -list(provider_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    -

    Read all service instance objects under a provider

    - --- - - - - - - - - - - - - - - - - - -
    Parameters:
      -
    • provider_id (str) – Provider id (required)
      • -
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied -by current result page) (optional)
      • -
    • included_fields (str or None) – Comma separated list of fields that should be included in query -result (optional)
      • -
    • page_size (long or None) – Maximum number of results to return in this page (server may return -fewer) (optional, default to 1000)
      • -
    • sort_ascending (bool or None) – (optional)
      • -
    • sort_by (str or None) – Field by which records are sorted (optional)
      • -
    -
    Return type:

    com.vmware.nsx_policy.model_client.ByodPolicyServiceInstanceListResult

    -
    Returns:

    com.vmware.nsx_policy.model.ByodPolicyServiceInstanceListResult

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -patch(provider_id, service_instance_id, byod_policy_service_instance)
    -

    Create Service Instance.

    - --- - - - - - - - - - - - - - -
    Parameters: -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -update(provider_id, service_instance_id, byod_policy_service_instance)
    -

    Create service instance.

    - --- - - - - - - - - - - - - - - - - - -
    Parameters: -
    Return type:

    com.vmware.nsx_policy.model_client.ByodPolicyServiceInstance

    -
    Returns:

    com.vmware.nsx_policy.model.ByodPolicyServiceInstance

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    - -
    -
    -class com.vmware.nsx_policy.infra.providers_client.Groups(config)
    -

    Bases: vmware.vapi.bindings.stub.VapiInterface

    -
    -
    -delete(provider_id, group_id)
    -

    Delete the Group under Provider.

    - --- - - - - - - - - - - - - - -
    Parameters:
      -
    • provider_id (str) – (required)
      • -
    • group_id (str) – (required)
      • -
    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -get(provider_id, group_id)
    -

    Read Provider Group

    - --- - - - - - - - - - - - - - - - - - -
    Parameters:
      -
    • provider_id (str) – (required)
      • -
    • group_id (str) – (required)
      • -
    -
    Return type:

    com.vmware.nsx_policy.model_client.Group

    -
    Returns:

    com.vmware.nsx_policy.model.Group

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -list(provider_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    -

    Paginated list of all Groups for Provider.

    - --- - - - - - - - - - - - - - - - - - -
    Parameters:
      -
    • provider_id (str) – (required)
      • -
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied -by current result page) (optional)
      • -
    • included_fields (str or None) – Comma separated list of fields that should be included in query -result (optional)
      • -
    • page_size (long or None) – Maximum number of results to return in this page (server may return -fewer) (optional, default to 1000)
      • -
    • sort_ascending (bool or None) – (optional)
      • -
    • sort_by (str or None) – Field by which records are sorted (optional)
      • -
    -
    Return type:

    com.vmware.nsx_policy.model_client.GroupListResult

    -
    Returns:

    com.vmware.nsx_policy.model.GroupListResult

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -patch(provider_id, group_id, group)
    -

    If a Group with the group-id is not already present, create a new Group -under the provider-id. Update if exists. The API valiates that Provider -is present before creating the Group.

    - --- - - - - - - - - - - - - - -
    Parameters: -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -update(provider_id, group_id, group)
    -

    If a Group with the group-id is not already present, create a new Group -under the provider-id. Update if exists. The API valiates that Provider -is present before creating the Group.

    - --- - - - - - - - - - - - - - - - - - -
    Parameters: -
    Return type:

    com.vmware.nsx_policy.model_client.Group

    -
    Returns:

    com.vmware.nsx_policy.model.Group

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    - -
    -
    -class com.vmware.nsx_policy.infra.providers_client.Interfaces(config)
    -

    Bases: vmware.vapi.bindings.stub.VapiInterface

    -
    -
    -delete(provider_id, interface_id)
    -

    Delete provider interface

    - --- - - - - - - - - - - - - - -
    Parameters:
      -
    • provider_id (str) – Provider ID (required)
      • -
    • interface_id (str) – Interface ID (required)
      • -
    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -get(provider_id, interface_id)
    -

    Read provider interface

    - --- - - - - - - - - - - - - - - - - - -
    Parameters:
      -
    • provider_id (str) – Provider ID (required)
      • -
    • interface_id (str) – Interface ID (required)
      • -
    -
    Return type:

    com.vmware.nsx_policy.model_client.ProviderInterface

    -
    Returns:

    com.vmware.nsx_policy.model.ProviderInterface

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -list(provider_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    -

    Paginated list of all Provider Interfaces

    - --- - - - - - - - - - - - - - - - - - -
    Parameters:
      -
    • provider_id (str) – Provider ID (required)
      • -
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied -by current result page) (optional)
      • -
    • included_fields (str or None) – Comma separated list of fields that should be included in query -result (optional)
      • -
    • page_size (long or None) – Maximum number of results to return in this page (server may return -fewer) (optional, default to 1000)
      • -
    • sort_ascending (bool or None) – (optional)
      • -
    • sort_by (str or None) – Field by which records are sorted (optional)
      • -
    -
    Return type:

    com.vmware.nsx_policy.model_client.ProviderInterfaceListResult

    -
    Returns:

    com.vmware.nsx_policy.model.ProviderInterfaceListResult

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -patch(provider_id, interface_id, provider_interface)
    -

    If an interface with the interface-id is not already present, create a -new interface. If it already exists, update the interface for specified -attributes.

    - --- - - - - - - - - - - - - - - - - - -
    Parameters: -
    Return type:

    com.vmware.nsx_policy.model_client.ProviderInterface

    -
    Returns:

    com.vmware.nsx_policy.model.ProviderInterface

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -update(provider_id, interface_id, provider_interface)
    -

    If an interface with the interface-id is not already present, create a -new interface. If it already exists, replace the interface with this -object.

    - --- - - - - - - - - - - - - - - - - - -
    Parameters: -
    Return type:

    com.vmware.nsx_policy.model_client.ProviderInterface

    -
    Returns:

    com.vmware.nsx_policy.model.ProviderInterface

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    - -
    -
    -class com.vmware.nsx_policy.infra.providers_client.L2vpnContext(config)
    -

    Bases: vmware.vapi.bindings.stub.VapiInterface

    -
    -
    -get(provider_id)
    -

    Read L2Vpn Context.

    - --- - - - - - - - - - - - - - - - - - -
    Parameters:provider_id (str) – Provider id (required)
    Return type:com.vmware.nsx_policy.model_client.L2VpnContext
    Returns:com.vmware.nsx_policy.model.L2VpnContext
    Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable
    Raise:com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed
    Raise:com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error
    Raise:com.vmware.vapi.std.errors_client.Unauthorized -Forbidden
    Raise:com.vmware.vapi.std.errors_client.NotFound -Not Found
    -
    - -
    - -
    -
    -class com.vmware.nsx_policy.infra.providers_client.L3vpnContext(config)
    -

    Bases: vmware.vapi.bindings.stub.VapiInterface

    -
    -
    -get(provider_id)
    -

    Read the L3Vpn Context under provider.

    - --- - - - - - - - - - - - - - - - - - -
    Parameters:provider_id (str) – Provider id (required)
    Return type:com.vmware.nsx_policy.model_client.L3VpnContext
    Returns:com.vmware.nsx_policy.model.L3VpnContext
    Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable
    Raise:com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed
    Raise:com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error
    Raise:com.vmware.vapi.std.errors_client.Unauthorized -Forbidden
    Raise:com.vmware.vapi.std.errors_client.NotFound -Not Found
    -
    - -
    -
    -patch(provider_id, l3_vpn_context)
    -

    Create the new L3Vpn Context under provider if it does not exist. If -the L3Vpn Context already exists under provider, merge with the the -existing one. This is a patch. If the passed L3VpnContext has new -L3VpnRules, add them to the existing L3VpnContext. If the passed -L3VpnContext also has existing L3VpnRules, update the existing -L3VpnRules.

    - --- - - - - - - - - - - - - - -
    Parameters: -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -update(provider_id, l3_vpn_context)
    -

    Create the new L3Vpn Context under provider if it does not exist. If -the L3Vpn Context already exists under provider, replace the the -existing one. This is a full replace.

    - --- - - - - - - - - - - - - - - - - - -
    Parameters: -
    Return type:

    com.vmware.nsx_policy.model_client.L3VpnContext

    -
    Returns:

    com.vmware.nsx_policy.model.L3VpnContext

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    - -
    -
    -class com.vmware.nsx_policy.infra.providers_client.L3vpns(config)
    -

    Bases: vmware.vapi.bindings.stub.VapiInterface

    -
    -
    -LIST_L3VPN_SESSION_POLICYBASEDL3VPNSESSION = 'PolicyBasedL3VpnSession'
    -

    Possible value for l3vpnSession of method L3vpns.list().

    -
    - -
    -
    -LIST_L3VPN_SESSION_ROUTEBASEDL3VPNSESSION = 'RouteBasedL3VpnSession'
    -

    Possible value for l3vpnSession of method L3vpns.list().

    -
    - -
    -
    -delete(provider_id, l3vpn_id)
    -

    Delete the L3Vpn with the given id.

    - --- - - - - - - - - - - - - - -
    Parameters:
      -
    • provider_id (str) – Provider id (required)
      • -
    • l3vpn_id (str) – L3Vpn id (required)
      • -
    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -get(provider_id, l3vpn_id)
    -

    Read the L3Vpn with the given id. No sensitive data is returned as part -of the response.

    - --- - - - - - - - - - - - - - - - - - -
    Parameters:
      -
    • provider_id (str) – Provider id (required)
      • -
    • l3vpn_id (str) – L3Vpn id (required)
      • -
    -
    Return type:

    com.vmware.nsx_policy.model_client.L3Vpn

    -
    Returns:

    com.vmware.nsx_policy.model.L3Vpn

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -list(provider_id, cursor=None, included_fields=None, l3vpn_session=None, page_size=None, sort_ascending=None, sort_by=None)
    -

    Paginated list of L3Vpns.

    - --- - - - - - - - - - - - - - - - - - -
    Parameters:
      -
    • provider_id (str) – Provider id (required)
      • -
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied -by current result page) (optional)
      • -
    • included_fields (str or None) – Comma separated list of fields that should be included in query -result (optional)
      • -
    • l3vpn_session (str or None) – Resource type of L3Vpn Session (optional)
      • -
    • page_size (long or None) – Maximum number of results to return in this page (server may return -fewer) (optional, default to 1000)
      • -
    • sort_ascending (bool or None) – (optional)
      • -
    • sort_by (str or None) – Field by which records are sorted (optional)
      • -
    -
    Return type:

    com.vmware.nsx_policy.model_client.L3VpnListResult

    -
    Returns:

    com.vmware.nsx_policy.model.L3VpnListResult

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -patch(provider_id, l3vpn_id, l3_vpn)
    -

    Create the new L3Vpn if it does not exist. If the L3Vpn already exists, -merge with the the existing one. This is a patch. - If the passed L3Vpn -is a policy-based one and has new L3VpnRules, add them to the existing -L3VpnRules. - If the passed L3Vpn is a policy-based one and also has -existing L3VpnRules, update the existing L3VpnRules.

    - --- - - - - - - - - - - - - - -
    Parameters: -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -showsensitivedata(provider_id, l3vpn_id)
    -

    Read the L3Vpn with the given id. Sensitive data is returned as part of -the response.

    - --- - - - - - - - - - - - - - - - - - -
    Parameters:
      -
    • provider_id (str) – Provider id (required)
      • -
    • l3vpn_id (str) – L3Vpn id (required)
      • -
    -
    Return type:

    com.vmware.nsx_policy.model_client.L3Vpn

    -
    Returns:

    com.vmware.nsx_policy.model.L3Vpn

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -update(provider_id, l3vpn_id, l3_vpn)
    -

    Create a new L3Vpn if the L3Vpn with given id does not already exist. -If the L3Vpn with the given id already exists, replace the existing -L3Vpn. This a full replace.

    - --- - - - - - - - - - - - - - - - - - -
    Parameters: -
    Return type:

    com.vmware.nsx_policy.model_client.L3Vpn

    -
    Returns:

    com.vmware.nsx_policy.model.L3Vpn

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    - -
    -
    -class com.vmware.nsx_policy.infra.providers_client.ProviderDeploymentMaps(config)
    -

    Bases: vmware.vapi.bindings.stub.VapiInterface

    -
    -
    -delete(provider_id, provider_deployment_map_id)
    -

    Delete Provider Deployment Map

    - --- - - - - - - - - - - - - - -
    Parameters:
      -
    • provider_id (str) – Provider ID (required)
      • -
    • provider_deployment_map_id (str) – provider-deployment-map-id (required)
      • -
    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -get(provider_id, provider_deployment_map_id)
    -

    Read a Provider Deployment Map

    - --- - - - - - - - - - - - - - - - - - -
    Parameters:
      -
    • provider_id (str) – Provider ID (required)
      • -
    • provider_deployment_map_id (str) – Provider Deployment Map id (required)
      • -
    -
    Return type:

    com.vmware.nsx_policy.model_client.ProviderDeploymentMap

    -
    Returns:

    com.vmware.nsx_policy.model.ProviderDeploymentMap

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -list(provider_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    -

    Paginated list of all Provider Deployment Entries.

    - --- - - - - - - - - - - - - - - - - - -
    Parameters:
      -
    • provider_id (str) – Provider ID (required)
      • -
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied -by current result page) (optional)
      • -
    • included_fields (str or None) – Comma separated list of fields that should be included in query -result (optional)
      • -
    • page_size (long or None) – Maximum number of results to return in this page (server may return -fewer) (optional, default to 1000)
      • -
    • sort_ascending (bool or None) – (optional)
      • -
    • sort_by (str or None) – Field by which records are sorted (optional)
      • -
    -
    Return type:

    com.vmware.nsx_policy.model_client.ProviderDeploymentMapListResult

    -
    Returns:

    com.vmware.nsx_policy.model.ProviderDeploymentMapListResult

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -patch(provider_id, provider_deployment_map_id, provider_deployment_map)
    -

    If the passed Provider Deployment Map does not already exist, create a -new Provider Deployment Map. If it already exists, patch it.

    - --- - - - - - - - - - - - - - - - - - -
    Parameters: -
    Return type:

    com.vmware.nsx_policy.model_client.ProviderDeploymentMap

    -
    Returns:

    com.vmware.nsx_policy.model.ProviderDeploymentMap

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -update(provider_id, provider_deployment_map_id, provider_deployment_map)
    -

    If the passed Provider Deployment Map does not already exist, create a -new Provider Deployment Map. If it already exists, replace it.

    - --- - - - - - - - - - - - - - - - - - -
    Parameters: -
    Return type:

    com.vmware.nsx_policy.model_client.ProviderDeploymentMap

    -
    Returns:

    com.vmware.nsx_policy.model.ProviderDeploymentMap

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    - -
    -
    -class com.vmware.nsx_policy.infra.providers_client.ServiceInstances(config)
    -

    Bases: vmware.vapi.bindings.stub.VapiInterface

    -
    -
    -delete(provider_id, service_instance_id)
    -

    Delete policy service instance

    - --- - - - - - - - - - - - - - -
    Parameters:
      -
    • provider_id (str) – Provider id (required)
      • -
    • service_instance_id (str) – Service instance id (required)
      • -
    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -get(provider_id, service_instance_id)
    -

    Read service instance

    - --- - - - - - - - - - - - - - - - - - -
    Parameters:
      -
    • provider_id (str) – Provider id (required)
      • -
    • service_instance_id (str) – Service instance id (required)
      • -
    -
    Return type:

    com.vmware.nsx_policy.model_client.PolicyServiceInstance

    -
    Returns:

    com.vmware.nsx_policy.model.PolicyServiceInstance

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -list(provider_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    -

    Read all service instance objects under a provider

    - --- - - - - - - - - - - - - - - - - - -
    Parameters:
      -
    • provider_id (str) – Provider id (required)
      • -
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied -by current result page) (optional)
      • -
    • included_fields (str or None) – Comma separated list of fields that should be included in query -result (optional)
      • -
    • page_size (long or None) – Maximum number of results to return in this page (server may return -fewer) (optional, default to 1000)
      • -
    • sort_ascending (bool or None) – (optional)
      • -
    • sort_by (str or None) – Field by which records are sorted (optional)
      • -
    -
    Return type:

    com.vmware.nsx_policy.model_client.PolicyServiceInstanceListResult

    -
    Returns:

    com.vmware.nsx_policy.model.PolicyServiceInstanceListResult

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -patch(provider_id, service_instance_id, policy_service_instance)
    -

    Create Service Instance.

    - --- - - - - - - - - - - - - - -
    Parameters: -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -update(provider_id, service_instance_id, policy_service_instance)
    -

    Create service instance.

    - --- - - - - - - - - - - - - - - - - - -
    Parameters: -
    Return type:

    com.vmware.nsx_policy.model_client.PolicyServiceInstance

    -
    Returns:

    com.vmware.nsx_policy.model.PolicyServiceInstance

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    - -
    -
    -class com.vmware.nsx_policy.infra.providers_client.ServiceInterfaces(config)
    -

    Bases: vmware.vapi.bindings.stub.VapiInterface

    -
    -
    -delete(provider_id, interface_id)
    -

    Delete service interface

    - --- - - - - - - - - - - - - - -
    Parameters:
      -
    • provider_id (str) – Provider ID (required)
      • -
    • interface_id (str) – Interface ID (required)
      • -
    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -get(provider_id, interface_id)
    -

    Read service interface

    - --- - - - - - - - - - - - - - - - - - -
    Parameters:
      -
    • provider_id (str) – Provider ID (required)
      • -
    • interface_id (str) – Interface ID (required)
      • -
    -
    Return type:

    com.vmware.nsx_policy.model_client.ServiceInterface

    -
    Returns:

    com.vmware.nsx_policy.model.ServiceInterface

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -list(provider_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    -

    Paginated list of all Service Interfaces

    - --- - - - - - - - - - - - - - - - - - -
    Parameters:
      -
    • provider_id (str) – Provider ID (required)
      • -
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied -by current result page) (optional)
      • -
    • included_fields (str or None) – Comma separated list of fields that should be included in query -result (optional)
      • -
    • page_size (long or None) – Maximum number of results to return in this page (server may return -fewer) (optional, default to 1000)
      • -
    • sort_ascending (bool or None) – (optional)
      • -
    • sort_by (str or None) – Field by which records are sorted (optional)
      • -
    -
    Return type:

    com.vmware.nsx_policy.model_client.ServiceInterfaceListResult

    -
    Returns:

    com.vmware.nsx_policy.model.ServiceInterfaceListResult

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -patch(provider_id, interface_id, service_interface)
    -

    If an interface with the interface-id is not already present, create a -new interface. If it already exists, update the interface for specified -attributes.

    - --- - - - - - - - - - - - - - - - - - -
    Parameters: -
    Return type:

    com.vmware.nsx_policy.model_client.ServiceInterface

    -
    Returns:

    com.vmware.nsx_policy.model.ServiceInterface

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -update(provider_id, interface_id, service_interface)
    -

    If an interface with the interface-id is not already present, create a -new interface. If it already exists, replace the interface with this -object.

    - --- - - - - - - - - - - - - - - - - - -
    Parameters: -
    Return type:

    com.vmware.nsx_policy.model_client.ServiceInterface

    -
    Returns:

    com.vmware.nsx_policy.model.ServiceInterface

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    - -
    -
    -class com.vmware.nsx_policy.infra.providers_client.StaticRoutes(config)
    -

    Bases: vmware.vapi.bindings.stub.VapiInterface

    -
    -
    -delete(provider_id, route_id)
    -

    Delete provider static routes

    - --- - - - - - - - - - - - - - -
    Parameters:
      -
    • provider_id (str) – Provider ID (required)
      • -
    • route_id (str) – Route ID (required)
      • -
    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -get(provider_id, route_id)
    -

    Read provider static routes

    - --- - - - - - - - - - - - - - - - - - -
    Parameters:
      -
    • provider_id (str) – Provider ID (required)
      • -
    • route_id (str) – Route ID (required)
      • -
    -
    Return type:

    com.vmware.nsx_policy.model_client.StaticRoutes

    -
    Returns:

    com.vmware.nsx_policy.model.StaticRoutes

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -list(provider_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    -

    Paginated list of all Provider Static Routes

    - --- - - - - - - - - - - - - - - - - - -
    Parameters:
      -
    • provider_id (str) – Provider ID (required)
      • -
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied -by current result page) (optional)
      • -
    • included_fields (str or None) – Comma separated list of fields that should be included in query -result (optional)
      • -
    • page_size (long or None) – Maximum number of results to return in this page (server may return -fewer) (optional, default to 1000)
      • -
    • sort_ascending (bool or None) – (optional)
      • -
    • sort_by (str or None) – Field by which records are sorted (optional)
      • -
    -
    Return type:

    com.vmware.nsx_policy.model_client.StaticRoutesListResult

    -
    Returns:

    com.vmware.nsx_policy.model.StaticRoutesListResult

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -patch(provider_id, route_id, static_routes)
    -

    If static routes for route-id are not already present, create static -routes. If it already exists, update static routes for route-id.

    - --- - - - - - - - - - - - - - - - - - -
    Parameters: -
    Return type:

    com.vmware.nsx_policy.model_client.StaticRoutes

    -
    Returns:

    com.vmware.nsx_policy.model.StaticRoutes

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    -
    -update(provider_id, route_id, static_routes)
    -

    If static routes for route-id are not already present, create static -routes. If it already exists, replace the static routes for route-id.

    - --- - - - - - - - - - - - - - - - - - -
    Parameters: -
    Return type:

    com.vmware.nsx_policy.model_client.StaticRoutes

    -
    Returns:

    com.vmware.nsx_policy.model.StaticRoutes

    -
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

    -
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

    -
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

    -
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    Raise:

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    - -
    - -
    -
    -class com.vmware.nsx_policy.infra.providers_client.StubFactory(stub_config)
    -

    Bases: vmware.vapi.bindings.stub.StubFactoryBase

    -
    -

    com.vmware.nsx_policy.infra.realized_state_client module

    @@ -4905,6 +2010,14 @@ Not Found

    class com.vmware.nsx_policy.infra.realized_state_client.EnforcementPoints(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    get(enforcement_point_name)
    @@ -4996,6 +2109,14 @@ Not Found

    class com.vmware.nsx_policy.infra.realized_state_client.RealizedEntities(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    list(intent_path)
    @@ -5035,6 +2156,14 @@ Not Found
    +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    get(realized_path=None)
    @@ -5113,6 +2242,14 @@ Not Found

    class com.vmware.nsx_policy.infra.realized_state_client.Status(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    get(intent_path)
    @@ -5153,6 +2290,15 @@ Not Found
    +++ + + + +
    Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
    @@ -5162,6 +2308,14 @@ Not Found
    +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    delete(service_id, service_entry_id)
    @@ -5397,6 +2551,1939 @@ Not Found

    class com.vmware.nsx_policy.infra.services_client.StubFactory(stub_config)

    Bases: vmware.vapi.bindings.stub.StubFactoryBase

    +

    Initialize StubFactoryBase

    + +++ + + + +
    Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
    +
    + + +
    +

    com.vmware.nsx_policy.infra.tier_0s_client module

    +
    +
    +class com.vmware.nsx_policy.infra.tier_0s_client.Groups(config)
    +

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    +
    +
    +delete(tier0_id, group_id)
    +

    Delete the Group under Tier-0.

    + +++ + + + + + + + + + + + + + +
    Parameters:
      +
    • tier0_id (str) – (required)
      • +
    • group_id (str) – (required)
      • +
    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +get(tier0_id, group_id)
    +

    Read Tier-0 Group

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:
      +
    • tier0_id (str) – (required)
      • +
    • group_id (str) – (required)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.Group

    +
    Returns:

    com.vmware.nsx_policy.model.Group

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +list(tier0_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    +

    Paginated list of all Groups for Tier-0.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:
      +
    • tier0_id (str) – (required)
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
      • +
    • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
      • +
    • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
      • +
    • sort_ascending (bool or None) – (optional)
      • +
    • sort_by (str or None) – Field by which records are sorted (optional)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.GroupListResult

    +
    Returns:

    com.vmware.nsx_policy.model.GroupListResult

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +patch(tier0_id, group_id, group)
    +

    If a Group with the group-id is not already present, create a new Group +under the tier0-id. Update if exists. The API valiates that Tier-0 is +present before creating the Group.

    + +++ + + + + + + + + + + + + + +
    Parameters: +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +update(tier0_id, group_id, group)
    +

    If a Group with the group-id is not already present, create a new Group +under the tier0-id. Update if exists. The API valiates that Tier-0 is +present before creating the Group.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters: +
    Return type:

    com.vmware.nsx_policy.model_client.Group

    +
    Returns:

    com.vmware.nsx_policy.model.Group

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.infra.tier_0s_client.LocaleServices(config)
    +

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    +
    +
    +delete(tier0_id, locale_services_id)
    +

    Delete tier-0 locale-services

    + +++ + + + + + + + + + + + + + +
    Parameters:
      +
    • tier0_id (str) – (required)
      • +
    • locale_services_id (str) – (required)
      • +
    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +get(tier0_id, locale_services_id)
    +

    Read tier-0s locale-services

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:
      +
    • tier0_id (str) – (required)
      • +
    • locale_services_id (str) – (required)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.LocaleServices

    +
    Returns:

    com.vmware.nsx_policy.model.LocaleServices

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +list(tier0_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    +

    Paginated list of all tier-0 locale-services

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:
      +
    • tier0_id (str) – (required)
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
      • +
    • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
      • +
    • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
      • +
    • sort_ascending (bool or None) – (optional)
      • +
    • sort_by (str or None) – Field by which records are sorted (optional)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.LocaleServicesListResult

    +
    Returns:

    com.vmware.nsx_policy.model.LocaleServicesListResult

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +patch(tier0_id, locale_services_id, locale_services)
    +

    If a tier-0 locale-services with the locale-services-id is not already +present, create a new locale-services. If it already exists, update +tier-0 locale-services with specified attributes.

    + +++ + + + + + + + + + + + + + +
    Parameters: +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +update(tier0_id, locale_services_id, locale_services)
    +

    If a tier-0 locale-services with the locale-services-id is not already +present, create a new locale-services. If it already exists, replace +the tier-0 locale-services instance with the new object.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters: +
    Return type:

    com.vmware.nsx_policy.model_client.LocaleServices

    +
    Returns:

    com.vmware.nsx_policy.model.LocaleServices

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.infra.tier_0s_client.PrefixLists(config)
    +

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    +
    +
    +delete(tier0_id, prefix_list_id)
    +

    Delete a prefix list

    + +++ + + + + + + + + + + + + + +
    Parameters:
      +
    • tier0_id (str) – Tier-0 ID (required)
      • +
    • prefix_list_id (str) – Prefix List ID (required)
      • +
    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +get(tier0_id, prefix_list_id)
    +

    Read a prefix list

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:
      +
    • tier0_id (str) – Tier-0 ID (required)
      • +
    • prefix_list_id (str) – Prefix List ID (required)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.PrefixList

    +
    Returns:

    com.vmware.nsx_policy.model.PrefixList

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +list(tier0_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    +

    Paginated list of all prefix lists

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:
      +
    • tier0_id (str) – Tier-0 ID (required)
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
      • +
    • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
      • +
    • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
      • +
    • sort_ascending (bool or None) – (optional)
      • +
    • sort_by (str or None) – Field by which records are sorted (optional)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.PrefixListResult

    +
    Returns:

    com.vmware.nsx_policy.model.PrefixListResult

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +patch(tier0_id, prefix_list_id, prefix_list)
    +

    If prefix list for prefix-list-id is not already present, create a +prefix list. If it already exists, update prefix list for +prefix-list-id.

    + +++ + + + + + + + + + + + + + +
    Parameters: +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +update(tier0_id, prefix_list_id, prefix_list)
    +

    If prefix list for prefix-list-id is not already present, create a +prefix list. If it already exists, replace the prefix list for +prefix-list-id.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters: +
    Return type:

    com.vmware.nsx_policy.model_client.PrefixList

    +
    Returns:

    com.vmware.nsx_policy.model.PrefixList

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.infra.tier_0s_client.RoutingTable(config)
    +

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    +
    +
    +LIST_ROUTE_SOURCE_BGP = 'BGP'
    +

    Possible value for routeSource of method RoutingTable.list().

    +
    + +
    +
    +LIST_ROUTE_SOURCE_CONNECTED = 'CONNECTED'
    +

    Possible value for routeSource of method RoutingTable.list().

    +
    + +
    +
    +LIST_ROUTE_SOURCE_STATIC = 'STATIC'
    +

    Possible value for routeSource of method RoutingTable.list().

    +
    + +
    +
    +list(tier0_id, cursor=None, edge_id=None, enforcement_point_path=None, included_fields=None, page_size=None, route_source=None, sort_ascending=None, sort_by=None)
    +

    Get routing table from tier-0

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:
      +
    • tier0_id (str) – (required)
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
      • +
    • edge_id (str or None) – UUID of edge node (optional)
      • +
    • enforcement_point_path (str or None) – String Path of the enforcement point (optional)
      • +
    • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
      • +
    • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
      • +
    • route_source (str or None) – Filter routes based on the source from which route is learned +(optional)
      • +
    • sort_ascending (bool or None) – (optional)
      • +
    • sort_by (str or None) – Field by which records are sorted (optional)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.RoutingTableListResult

    +
    Returns:

    com.vmware.nsx_policy.model.RoutingTableListResult

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.infra.tier_0s_client.StaticRoutes(config)
    +

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    +
    +
    +delete(tier0_id, route_id)
    +

    Delete tier-0 static routes

    + +++ + + + + + + + + + + + + + +
    Parameters:
      +
    • tier0_id (str) – Tier-0 ID (required)
      • +
    • route_id (str) – Route ID (required)
      • +
    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +get(tier0_id, route_id)
    +

    Read tier-0 static routes

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:
      +
    • tier0_id (str) – Tier-0 ID (required)
      • +
    • route_id (str) – Route ID (required)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.StaticRoutes

    +
    Returns:

    com.vmware.nsx_policy.model.StaticRoutes

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +list(tier0_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    +

    Paginated list of all Tier-0 Static Routes

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:
      +
    • tier0_id (str) – Tier-0 ID (required)
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
      • +
    • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
      • +
    • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
      • +
    • sort_ascending (bool or None) – (optional)
      • +
    • sort_by (str or None) – Field by which records are sorted (optional)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.StaticRoutesListResult

    +
    Returns:

    com.vmware.nsx_policy.model.StaticRoutesListResult

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +patch(tier0_id, route_id, static_routes)
    +

    If static routes for route-id are not already present, create static +routes. If it already exists, update static routes for route-id.

    + +++ + + + + + + + + + + + + + +
    Parameters: +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +update(tier0_id, route_id, static_routes)
    +

    If static routes for route-id are not already present, create static +routes. If it already exists, replace the static routes for route-id.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters: +
    Return type:

    com.vmware.nsx_policy.model_client.StaticRoutes

    +
    Returns:

    com.vmware.nsx_policy.model.StaticRoutes

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.infra.tier_0s_client.StubFactory(stub_config)
    +

    Bases: vmware.vapi.bindings.stub.StubFactoryBase

    +

    Initialize StubFactoryBase

    + +++ + + + +
    Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
    +
    + +
    +
    +

    com.vmware.nsx_policy.infra.tier_1s_client module

    +
    +
    +class com.vmware.nsx_policy.infra.tier_1s_client.DnsForwarder(config)
    +

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    +
    +
    +delete(tier1_id)
    +

    Delete DNS configuration for tier-1 instance

    + +++ + + + + + + + + + + + + + +
    Parameters:tier1_id (str) – Tier-1 ID (required)
    Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
    Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
    Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
    Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
    Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
    +
    + +
    +
    +get(tier1_id)
    +

    Read the DNS Forwarder for the given tier-1 instance

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:tier1_id (str) – Tier-1 ID (required)
    Return type:com.vmware.nsx_policy.model_client.PolicyDnsForwarder
    Returns:com.vmware.nsx_policy.model.PolicyDnsForwarder
    Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
    Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
    Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
    Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
    Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
    +
    + +
    +
    +patch(tier1_id, policy_dns_forwarder)
    +

    Update the DNS Forwarder

    + +++ + + + + + + + + + + + + + +
    Parameters: +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +update(tier1_id, policy_dns_forwarder)
    +

    Update the DNS Forwarder

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters: +
    Return type:

    com.vmware.nsx_policy.model_client.PolicyDnsForwarder

    +
    Returns:

    com.vmware.nsx_policy.model.PolicyDnsForwarder

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.infra.tier_1s_client.IpfixSwitchCollectionInstances(config)
    +

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    +
    +
    +delete(tier1_id, ipfix_switch_collection_instance_id)
    +

    API deletes IPFIX Switch Collection Instance.Flow forwarding to +selected collector will be stopped.

    + +++ + + + + + + + + + + + + + +
    Parameters:
      +
    • tier1_id (str) – Tier-1 ID (required)
      • +
    • ipfix_switch_collection_instance_id (str) – IPFIX Switch Collection Instance ID (required)
      • +
    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +get(tier1_id, ipfix_switch_collection_instance_id)
    +

    API will return details of IPFIX switch collection. If instance does +not exist, it will return 404.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:
      +
    • tier1_id (str) – Tier-1 ID (required)
      • +
    • ipfix_switch_collection_instance_id (str) – IPFIX switch collection id (required)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.IPFIXSwitchCollectionInstance

    +
    Returns:

    com.vmware.nsx_policy.model.IPFIXSwitchCollectionInstance

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +list(tier1_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    +

    API provides list IPFIX Switch collection instances available on +selected logical switch.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:
      +
    • tier1_id (str) – Tier-1 ID (required)
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
      • +
    • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
      • +
    • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
      • +
    • sort_ascending (bool or None) – (optional)
      • +
    • sort_by (str or None) – Field by which records are sorted (optional)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.IPFIXSwitchCollectionInstanceListResult

    +
    Returns:

    com.vmware.nsx_policy.model.IPFIXSwitchCollectionInstanceListResult

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +patch(tier1_id, ipfix_switch_collection_instance_id, i_pfix_switch_collection_instance)
    +

    Create a new IPFIX switch collection instance if the IPFIX switch +collection instance with given id does not already exist. If the IPFIX +switch collection instance with the given id already exists, patch with +the existing IPFIX switch collection instance.

    + +++ + + + + + + + + + + + + + +
    Parameters: +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +update(tier1_id, ipfix_switch_collection_instance_id, i_pfix_switch_collection_instance)
    +

    Create or replace IPFIX switch collection instance. Instance will start +forwarding data to provided IPFIX collector.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters: +
    Return type:

    com.vmware.nsx_policy.model_client.IPFIXSwitchCollectionInstance

    +
    Returns:

    com.vmware.nsx_policy.model.IPFIXSwitchCollectionInstance

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.infra.tier_1s_client.Segments(config)
    +

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    +
    +
    +delete(tier1_id, segment_id)
    +

    Delete segment

    + +++ + + + + + + + + + + + + + +
    Parameters:
      +
    • tier1_id (str) – Tier-1 ID (required)
      • +
    • segment_id (str) – Segment ID (required)
      • +
    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +get(tier1_id, segment_id)
    +

    Read segment

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:
      +
    • tier1_id (str) – Tier-1 ID (required)
      • +
    • segment_id (str) – Segment ID (required)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.Segment

    +
    Returns:

    com.vmware.nsx_policy.model.Segment

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +list(tier1_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    +

    Paginated list of all segments under tier-1 instance

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:
      +
    • tier1_id (str) – Tier-1 ID (required)
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
      • +
    • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
      • +
    • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
      • +
    • sort_ascending (bool or None) – (optional)
      • +
    • sort_by (str or None) – Field by which records are sorted (optional)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.SegmentListResult

    +
    Returns:

    com.vmware.nsx_policy.model.SegmentListResult

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +patch(tier1_id, segment_id, segment)
    +

    If segment with the segment-id is not already present, create a new +segment. If it already exists, update the segment with specified +attributes.

    + +++ + + + + + + + + + + + + + +
    Parameters: +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +update(tier1_id, segment_id, segment)
    +

    If segment with the segment-id is not already present, create a new +segment. If it already exists, replace the segment with this object.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters: +
    Return type:

    com.vmware.nsx_policy.model_client.Segment

    +
    Returns:

    com.vmware.nsx_policy.model.Segment

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.infra.tier_1s_client.StaticRoutes(config)
    +

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    +
    +
    +delete(tier1_id, route_id)
    +

    Delete tier-1 static routes

    + +++ + + + + + + + + + + + + + +
    Parameters:
      +
    • tier1_id (str) – Tier-1 ID (required)
      • +
    • route_id (str) – Route ID (required)
      • +
    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +get(tier1_id, route_id)
    +

    Read tier-1 static routes

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:
      +
    • tier1_id (str) – Tier-1 ID (required)
      • +
    • route_id (str) – Route ID (required)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.StaticRoutes

    +
    Returns:

    com.vmware.nsx_policy.model.StaticRoutes

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +list(tier1_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    +

    Paginated list of all Tier-1 Static Routes

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:
      +
    • tier1_id (str) – Tier-1 ID (required)
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
      • +
    • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
      • +
    • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
      • +
    • sort_ascending (bool or None) – (optional)
      • +
    • sort_by (str or None) – Field by which records are sorted (optional)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.StaticRoutesListResult

    +
    Returns:

    com.vmware.nsx_policy.model.StaticRoutesListResult

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +patch(tier1_id, route_id, static_routes)
    +

    If static routes for route-id are not already present, create static +routes. If it already exists, update static routes for route-id.

    + +++ + + + + + + + + + + + + + +
    Parameters: +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +update(tier1_id, route_id, static_routes)
    +

    If static routes for route-id are not already present, create static +routes. If it already exists, replace the static routes for route-id.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters: +
    Return type:

    com.vmware.nsx_policy.model_client.StaticRoutes

    +
    Returns:

    com.vmware.nsx_policy.model.StaticRoutes

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.infra.tier_1s_client.StubFactory(stub_config)
    +

    Bases: vmware.vapi.bindings.stub.StubFactoryBase

    +

    Initialize StubFactoryBase

    + +++ + + + +
    Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
    @@ -5422,7 +4509,7 @@ Not Found

    - © Copyright 2018, VMware, Inc.. + © Copyright 2018, VMware, Inc.

    @@ -5441,33 +4528,22 @@ Not Found

    - - - - + + + + + + + + - - - - + diff --git a/nsx/nsx_policy/com.vmware.nsx_policy.infra.realized_state.enforcement_points.html b/nsx/nsx_policy/com.vmware.nsx_policy.infra.realized_state.enforcement_points.html index 59c48756..b2249cec 100644 --- a/nsx/nsx_policy/com.vmware.nsx_policy.infra.realized_state.enforcement_points.html +++ b/nsx/nsx_policy/com.vmware.nsx_policy.infra.realized_state.enforcement_points.html @@ -8,7 +8,7 @@ - com.vmware.nsx_policy.infra.realized_state.enforcement_points package — NSX-T Policy SDK 2.2.0.0.0 documentation + com.vmware.nsx_policy.infra.realized_state.enforcement_points package — NSX-T Policy SDK 2.3.0.0.1 documentation @@ -24,8 +24,7 @@ - - + @@ -59,7 +58,7 @@
    - 2.2.0.0.0 + 2.3.0.0.1
    @@ -91,6 +90,7 @@
  • Subpackages
  • Submodules
  • com.vmware.nsx_policy_client module
    • +
  • com.vmware.nsx_policy_client_for_vmc module
    • @@ -194,6 +194,14 @@
    class com.vmware.nsx_policy.infra.realized_state.enforcement_points.firewalls_client.FirewallSections(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    get(enforcement_point_name, firewall_section_id)
    @@ -296,6 +304,15 @@ Not Found

    class com.vmware.nsx_policy.infra.realized_state.enforcement_points.firewalls_client.StubFactory(stub_config)

    Bases: vmware.vapi.bindings.stub.StubFactoryBase

    +

    Initialize StubFactoryBase

    + +++ + + + +
    Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
    @@ -305,6 +322,14 @@ Not Found

    class com.vmware.nsx_policy.infra.realized_state.enforcement_points.groups_client.Nsgroups(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    get(enforcement_point_name, nsgroup_name)
    @@ -407,6 +432,14 @@ Not Found

    class com.vmware.nsx_policy.infra.realized_state.enforcement_points.groups_client.Securitygroups(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    get(enforcement_point_name, securitygroup_name)
    @@ -510,6 +543,15 @@ Not Found

    class com.vmware.nsx_policy.infra.realized_state.enforcement_points.groups_client.StubFactory(stub_config)

    Bases: vmware.vapi.bindings.stub.StubFactoryBase

    +

    Initialize StubFactoryBase

    + +++ + + + +
    Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
    @@ -519,6 +561,14 @@ Not Found

    class com.vmware.nsx_policy.infra.realized_state.enforcement_points.ip_sets_client.IpSetsNsxt(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    get(enforcement_point_name, ip_set_name)
    @@ -620,6 +670,15 @@ Not Found

    class com.vmware.nsx_policy.infra.realized_state.enforcement_points.ip_sets_client.StubFactory(stub_config)

    Bases: vmware.vapi.bindings.stub.StubFactoryBase

    +

    Initialize StubFactoryBase

    + +++ + + + +
    Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
    @@ -629,6 +688,14 @@ Not Found

    class com.vmware.nsx_policy.infra.realized_state.enforcement_points.mac_sets_client.MacSetsNsxt(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    get(enforcement_point_name, mac_set_name)
    @@ -730,6 +797,15 @@ Not Found

    class com.vmware.nsx_policy.infra.realized_state.enforcement_points.mac_sets_client.StubFactory(stub_config)

    Bases: vmware.vapi.bindings.stub.StubFactoryBase

    +

    Initialize StubFactoryBase

    + +++ + + + +
    Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
    @@ -739,6 +815,14 @@ Not Found

    class com.vmware.nsx_policy.infra.realized_state.enforcement_points.services_client.Nsservices(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    get(enforcement_point_name, nsservice_name)
    @@ -840,6 +924,15 @@ Not Found

    class com.vmware.nsx_policy.infra.realized_state.enforcement_points.services_client.StubFactory(stub_config)

    Bases: vmware.vapi.bindings.stub.StubFactoryBase

    +

    Initialize StubFactoryBase

    + +++ + + + +
    Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
    @@ -865,7 +958,7 @@ Not Found

    - © Copyright 2018, VMware, Inc.. + © Copyright 2018, VMware, Inc.

    @@ -884,33 +977,22 @@ Not Found

    - - - - + + + + + + + + - - - - + diff --git a/nsx/nsx_policy/com.vmware.nsx_policy.infra.realized_state.enforcement_points.ops.html b/nsx/nsx_policy/com.vmware.nsx_policy.infra.realized_state.enforcement_points.ops.html index cec75e20..49c6bae5 100644 --- a/nsx/nsx_policy/com.vmware.nsx_policy.infra.realized_state.enforcement_points.ops.html +++ b/nsx/nsx_policy/com.vmware.nsx_policy.infra.realized_state.enforcement_points.ops.html @@ -8,7 +8,7 @@ - com.vmware.nsx_policy.infra.realized_state.enforcement_points.ops package — NSX-T Policy SDK 2.2.0.0.0 documentation + com.vmware.nsx_policy.infra.realized_state.enforcement_points.ops package — NSX-T Policy SDK 2.3.0.0.1 documentation @@ -24,11 +24,11 @@ - - + + @@ -58,7 +58,7 @@
    - 2.2.0.0.0 + 2.3.0.0.1
    @@ -90,6 +90,7 @@
  • Subpackages
  • Submodules
  • com.vmware.nsx_policy_client module
    • +
  • com.vmware.nsx_policy_client_for_vmc module
    • @@ -183,6 +184,14 @@
    class com.vmware.nsx_policy.infra.realized_state.enforcement_points.ops.domains_client.DiscoverySessions(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    GET_VIEW_GROUP_CONNECTION = 'GROUP_CONNECTION'
    @@ -209,7 +218,7 @@
    -get(enforcement_point_id, domain_id, discovery_session_id, view=None)
    +get(enforcement_point_id, domain_id, discovery_session_id, destination_id=None, source_id=None, view=None)

    Read discovered information for a selected domain/application on selected enforcement point. Response contains topology information based on the view option specified in the query parameter. An error is @@ -225,6 +234,8 @@ status is in STARTED, IN-PROGRESS or FAILED state.

  • domain_id (str) – Domain ID (required)
  • discovery_session_id (str) – Discovery session ID is Domain ID of the domain where discovery session was started (required)
    • +
  • destination_id (str or None) – Destination element ID (optional)
    • +
  • source_id (str or None) – Source element ID (optional)
  • view (str or None) – Option to specify specific view (optional)
    		•
    +++ + + + +
    Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
    @@ -278,6 +298,8 @@ Not Found

    @@ -336,7 +419,7 @@ Not Found

    - © Copyright 2018, VMware, Inc.. + © Copyright 2018, VMware, Inc.

    @@ -355,33 +438,22 @@ Not Found

    - - - - + + + + + + + + - - - - + diff --git a/nsx/nsx_policy/com.vmware.nsx_policy.infra.tier_0s.html b/nsx/nsx_policy/com.vmware.nsx_policy.infra.tier_0s.html new file mode 100644 index 00000000..439c7aaa --- /dev/null +++ b/nsx/nsx_policy/com.vmware.nsx_policy.infra.tier_0s.html @@ -0,0 +1,2168 @@ + + + + + + + + + + + com.vmware.nsx_policy.infra.tier_0s package — NSX-T Policy SDK 2.3.0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + +
    + + + + + +
    + +
    + + + + + + + + + + + + + + + + + +
    + + + + +
    +
    +
    +
    + +
    +

    com.vmware.nsx_policy.infra.tier_0s package

    + +
    +

    Submodules

    +
    +
    +

    com.vmware.nsx_policy.infra.tier_0s.locale_services_client module

    +
    +
    +class com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Bgp(config)
    +

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    +
    +
    +get(tier0_id, locale_service_id)
    +

    Read BGP routing config

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:
      +
    • tier0_id (str) – (required)
      • +
    • locale_service_id (str) – (required)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.BgpRoutingConfig

    +
    Returns:

    com.vmware.nsx_policy.model.BgpRoutingConfig

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +patch(tier0_id, locale_service_id, bgp_routing_config)
    +

    If an BGP routing config not present, create BGP routing config. If it +already exists, update the routing config.

    + +++ + + + + + + + + + + + + + +
    Parameters: +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +update(tier0_id, locale_service_id, bgp_routing_config)
    +

    If BGP routing config is not already present, create BGP routing +config. If it already exists, replace the BGP routing config with this +object.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters: +
    Return type:

    com.vmware.nsx_policy.model_client.BgpRoutingConfig

    +
    Returns:

    com.vmware.nsx_policy.model.BgpRoutingConfig

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.infra.tier_0s.locale_services_client.ByodServiceInstances(config)
    +

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    +
    +
    +delete(tier0_id, locale_service_id, service_instance_id)
    +

    Delete BYOD policy service instance

    + +++ + + + + + + + + + + + + + +
    Parameters:
      +
    • tier0_id (str) – Tier-0 id (required)
      • +
    • locale_service_id (str) – Locale service id (required)
      • +
    • service_instance_id (str) – Service instance id (required)
      • +
    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +get(tier0_id, locale_service_id, service_instance_id)
    +

    Read byod service instance

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:
      +
    • tier0_id (str) – Tier-0 id (required)
      • +
    • locale_service_id (str) – Locale service id (required)
      • +
    • service_instance_id (str) – Service instance id (required)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.ByodPolicyServiceInstance

    +
    Returns:

    com.vmware.nsx_policy.model.ByodPolicyServiceInstance

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +list(tier0_id, locale_service_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    +

    Read all BYOD service instance objects under a tier-0

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:
      +
    • tier0_id (str) – Tier-0 id (required)
      • +
    • locale_service_id (str) – Locale service id (required)
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
      • +
    • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
      • +
    • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
      • +
    • sort_ascending (bool or None) – (optional)
      • +
    • sort_by (str or None) – Field by which records are sorted (optional)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.ByodPolicyServiceInstanceListResult

    +
    Returns:

    com.vmware.nsx_policy.model.ByodPolicyServiceInstanceListResult

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +patch(tier0_id, locale_service_id, service_instance_id, byod_policy_service_instance)
    +

    Create BYOD Service Instance which represent instance of service +definition created on manager.

    + +++ + + + + + + + + + + + + + +
    Parameters: +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +update(tier0_id, locale_service_id, service_instance_id, byod_policy_service_instance)
    +

    Create BYOD Service Instance which represent instance of service +definition created on manager.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters: +
    Return type:

    com.vmware.nsx_policy.model_client.ByodPolicyServiceInstance

    +
    Returns:

    com.vmware.nsx_policy.model.ByodPolicyServiceInstance

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Interfaces(config)
    +

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    +
    +
    +delete(tier0_id, locale_service_id, interface_id)
    +

    Delete tier-0 interface

    + +++ + + + + + + + + + + + + + +
    Parameters:
      +
    • tier0_id (str) – (required)
      • +
    • locale_service_id (str) – (required)
      • +
    • interface_id (str) – (required)
      • +
    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +get(tier0_id, locale_service_id, interface_id)
    +

    Read tier-0 interface

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:
      +
    • tier0_id (str) – (required)
      • +
    • locale_service_id (str) – (required)
      • +
    • interface_id (str) – (required)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.Tier0Interface

    +
    Returns:

    com.vmware.nsx_policy.model.Tier0Interface

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +list(tier0_id, locale_service_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    +

    Paginated list of all Tier-0 Interfaces

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:
      +
    • tier0_id (str) – (required)
      • +
    • locale_service_id (str) – (required)
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
      • +
    • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
      • +
    • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
      • +
    • sort_ascending (bool or None) – (optional)
      • +
    • sort_by (str or None) – Field by which records are sorted (optional)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.Tier0InterfaceListResult

    +
    Returns:

    com.vmware.nsx_policy.model.Tier0InterfaceListResult

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +patch(tier0_id, locale_service_id, interface_id, tier0_interface)
    +

    If an interface with the interface-id is not already present, create a +new interface. If it already exists, update the interface for specified +attributes.

    + +++ + + + + + + + + + + + + + +
    Parameters: +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +update(tier0_id, locale_service_id, interface_id, tier0_interface)
    +

    If an interface with the interface-id is not already present, create a +new interface. If it already exists, replace the interface with this +object.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters: +
    Return type:

    com.vmware.nsx_policy.model_client.Tier0Interface

    +
    Returns:

    com.vmware.nsx_policy.model.Tier0Interface

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L2vpnContext(config)
    +

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    +
    +
    +get(tier0_id, locale_service_id)
    +

    Read L2Vpn Context.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:
      +
    • tier0_id (str) – (required)
      • +
    • locale_service_id (str) – (required)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.L2VpnContext

    +
    Returns:

    com.vmware.nsx_policy.model.L2VpnContext

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpnContext(config)
    +

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    +
    +
    +get(tier0_id, locale_service_id)
    +

    Read the L3Vpn Context under tier-0.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:
      +
    • tier0_id (str) – (required)
      • +
    • locale_service_id (str) – (required)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.L3VpnContext

    +
    Returns:

    com.vmware.nsx_policy.model.L3VpnContext

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +patch(tier0_id, locale_service_id, l3_vpn_context)
    +

    Create the new L3Vpn Context under tier-0 if it does not exist. If the +L3Vpn Context already exists under tier-0, merge with the the existing +one. This is a patch. If the passed L3VpnContext has new L3VpnRules, +add them to the existing L3VpnContext. If the passed L3VpnContext also +has existing L3VpnRules, update the existing L3VpnRules.

    + +++ + + + + + + + + + + + + + +
    Parameters: +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +update(tier0_id, locale_service_id, l3_vpn_context)
    +

    Create the new L3Vpn Context under tier-0 if it does not exist. If the +L3Vpn Context already exists under tier-0, replace the the existing +one. This is a full replace.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters: +
    Return type:

    com.vmware.nsx_policy.model_client.L3VpnContext

    +
    Returns:

    com.vmware.nsx_policy.model.L3VpnContext

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns(config)
    +

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    +
    +
    +LIST_L3VPN_SESSION_POLICYBASEDL3VPNSESSION = 'PolicyBasedL3VpnSession'
    +

    Possible value for l3vpnSession of method L3vpns.list().

    +
    + +
    +
    +LIST_L3VPN_SESSION_ROUTEBASEDL3VPNSESSION = 'RouteBasedL3VpnSession'
    +

    Possible value for l3vpnSession of method L3vpns.list().

    +
    + +
    +
    +delete(tier0_id, locale_service_id, l3vpn_id)
    +

    Delete the L3Vpn with the given id.

    + +++ + + + + + + + + + + + + + +
    Parameters:
      +
    • tier0_id (str) – (required)
      • +
    • locale_service_id (str) – (required)
      • +
    • l3vpn_id (str) – (required)
      • +
    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +get(tier0_id, locale_service_id, l3vpn_id)
    +

    Read the L3Vpn with the given id. No sensitive data is returned as part +of the response.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:
      +
    • tier0_id (str) – (required)
      • +
    • locale_service_id (str) – (required)
      • +
    • l3vpn_id (str) – (required)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.L3Vpn

    +
    Returns:

    com.vmware.nsx_policy.model.L3Vpn

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +list(tier0_id, locale_service_id, cursor=None, included_fields=None, l3vpn_session=None, page_size=None, sort_ascending=None, sort_by=None)
    +

    Paginated list of L3Vpns.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:
      +
    • tier0_id (str) – (required)
      • +
    • locale_service_id (str) – (required)
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
      • +
    • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
      • +
    • l3vpn_session (str or None) – Resource type of L3Vpn Session (optional)
      • +
    • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
      • +
    • sort_ascending (bool or None) – (optional)
      • +
    • sort_by (str or None) – Field by which records are sorted (optional)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.L3VpnListResult

    +
    Returns:

    com.vmware.nsx_policy.model.L3VpnListResult

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +patch(tier0_id, locale_service_id, l3vpn_id, l3_vpn)
    +

    Create the new L3Vpn if it does not exist. If the L3Vpn already exists, +merge with the the existing one. This is a patch. - If the passed L3Vpn +is a policy-based one and has new L3VpnRules, add them to the existing +L3VpnRules. - If the passed L3Vpn is a policy-based one and also has +existing L3VpnRules, update the existing L3VpnRules.

    + +++ + + + + + + + + + + + + + +
    Parameters: +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +showsensitivedata(tier0_id, locale_service_id, l3vpn_id)
    +

    Read the L3Vpn with the given id. Sensitive data is returned as part of +the response.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:
      +
    • tier0_id (str) – (required)
      • +
    • locale_service_id (str) – (required)
      • +
    • l3vpn_id (str) – (required)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.L3Vpn

    +
    Returns:

    com.vmware.nsx_policy.model.L3Vpn

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +update(tier0_id, locale_service_id, l3vpn_id, l3_vpn)
    +

    Create a new L3Vpn if the L3Vpn with given id does not already exist. +If the L3Vpn with the given id already exists, replace the existing +L3Vpn. This a full replace.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters: +
    Return type:

    com.vmware.nsx_policy.model_client.L3Vpn

    +
    Returns:

    com.vmware.nsx_policy.model.L3Vpn

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.infra.tier_0s.locale_services_client.ServiceInstances(config)
    +

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    +
    +
    +delete(tier0_id, locale_service_id, service_instance_id)
    +

    Delete policy service instance

    + +++ + + + + + + + + + + + + + +
    Parameters:
      +
    • tier0_id (str) – Tier-0 id (required)
      • +
    • locale_service_id (str) – Locale service id (required)
      • +
    • service_instance_id (str) – Service instance id (required)
      • +
    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +get(tier0_id, locale_service_id, service_instance_id)
    +

    Read service instance

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:
      +
    • tier0_id (str) – Tier-0 id (required)
      • +
    • locale_service_id (str) – Locale service id (required)
      • +
    • service_instance_id (str) – Service instance id (required)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.PolicyServiceInstance

    +
    Returns:

    com.vmware.nsx_policy.model.PolicyServiceInstance

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +list(tier0_id, locale_service_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    +

    Read all service instance objects under a tier-0

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:
      +
    • tier0_id (str) – Tier-0 id (required)
      • +
    • locale_service_id (str) – Locale service id (required)
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
      • +
    • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
      • +
    • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
      • +
    • sort_ascending (bool or None) – (optional)
      • +
    • sort_by (str or None) – Field by which records are sorted (optional)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.PolicyServiceInstanceListResult

    +
    Returns:

    com.vmware.nsx_policy.model.PolicyServiceInstanceListResult

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +patch(tier0_id, locale_service_id, service_instance_id, policy_service_instance)
    +

    Create Service Instance.

    + +++ + + + + + + + + + + + + + +
    Parameters: +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +reauth(tier0_id, locale_service_id, service_instance_id)
    +
    +++ + + + + + + + + + + + + + +
    Parameters:
      +
    • tier0_id (str) – Tier-0 id (required)
      • +
    • locale_service_id (str) – Locale service id (required)
      • +
    • service_instance_id (str) – Service instance id (required)
      • +
    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +update(tier0_id, locale_service_id, service_instance_id, policy_service_instance)
    +

    Create service instance.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters: +
    Return type:

    com.vmware.nsx_policy.model_client.PolicyServiceInstance

    +
    Returns:

    com.vmware.nsx_policy.model.PolicyServiceInstance

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.infra.tier_0s.locale_services_client.ServiceInterfaces(config)
    +

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    +
    +
    +delete(tier0_id, locale_service_id, interface_id)
    +

    Delete service interface

    + +++ + + + + + + + + + + + + + +
    Parameters:
      +
    • tier0_id (str) – (required)
      • +
    • locale_service_id (str) – (required)
      • +
    • interface_id (str) – (required)
      • +
    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +get(tier0_id, locale_service_id, interface_id)
    +

    Read service interface

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:
      +
    • tier0_id (str) – (required)
      • +
    • locale_service_id (str) – (required)
      • +
    • interface_id (str) – (required)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.ServiceInterface

    +
    Returns:

    com.vmware.nsx_policy.model.ServiceInterface

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +list(tier0_id, locale_service_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    +

    Paginated list of all Service Interfaces

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:
      +
    • tier0_id (str) – (required)
      • +
    • locale_service_id (str) – (required)
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
      • +
    • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
      • +
    • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
      • +
    • sort_ascending (bool or None) – (optional)
      • +
    • sort_by (str or None) – Field by which records are sorted (optional)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.ServiceInterfaceListResult

    +
    Returns:

    com.vmware.nsx_policy.model.ServiceInterfaceListResult

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +patch(tier0_id, locale_service_id, interface_id, service_interface)
    +

    If an interface with the interface-id is not already present, create a +new interface. If it already exists, update the interface for specified +attributes.

    + +++ + + + + + + + + + + + + + +
    Parameters: +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +update(tier0_id, locale_service_id, interface_id, service_interface)
    +

    If an interface with the interface-id is not already present, create a +new interface. Modification of service interface is not allowed.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters: +
    Return type:

    com.vmware.nsx_policy.model_client.ServiceInterface

    +
    Returns:

    com.vmware.nsx_policy.model.ServiceInterface

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    + +
    +
    +class com.vmware.nsx_policy.infra.tier_0s.locale_services_client.StubFactory(stub_config)
    +

    Bases: vmware.vapi.bindings.stub.StubFactoryBase

    +

    Initialize StubFactoryBase

    + +++ + + + +
    Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
    +
    + +
    +
    +class com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Tier0DeploymentMaps(config)
    +

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    +
    +
    +delete(tier0_id, locale_service_id, tier0_deployment_map_id)
    +

    Delete Tier-0 Deployment Map

    + +++ + + + + + + + + + + + + + +
    Parameters:
      +
    • tier0_id (str) – (required)
      • +
    • locale_service_id (str) – (required)
      • +
    • tier0_deployment_map_id (str) – (required)
      • +
    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +get(tier0_id, locale_service_id, tier0_deployment_map_id)
    +

    Read a Tier-0 Deployment Map

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:
      +
    • tier0_id (str) – (required)
      • +
    • locale_service_id (str) – (required)
      • +
    • tier0_deployment_map_id (str) – (required)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.Tier0DeploymentMap

    +
    Returns:

    com.vmware.nsx_policy.model.Tier0DeploymentMap

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +list(tier0_id, locale_service_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    +

    Paginated list of all Tier-0 Deployment Entries.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters:
      +
    • tier0_id (str) – (required)
      • +
    • locale_service_id (str) – (required)
      • +
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
      • +
    • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
      • +
    • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
      • +
    • sort_ascending (bool or None) – (optional)
      • +
    • sort_by (str or None) – Field by which records are sorted (optional)
      • +
    +
    Return type:

    com.vmware.nsx_policy.model_client.Tier0DeploymentMapListResult

    +
    Returns:

    com.vmware.nsx_policy.model.Tier0DeploymentMapListResult

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +patch(tier0_id, locale_service_id, tier0_deployment_map_id, tier0_deployment_map)
    +

    If the passed Tier-0 Deployment Map does not already exist, create a +new Tier-0 Deployment Map. If it already exists, patch it.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters: +
    Return type:

    com.vmware.nsx_policy.model_client.Tier0DeploymentMap

    +
    Returns:

    com.vmware.nsx_policy.model.Tier0DeploymentMap

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    +
    +update(tier0_id, locale_service_id, tier0_deployment_map_id, tier0_deployment_map)
    +

    If the passed Tier-0 Deployment Map does not already exist, create a +new Tier-0 Deployment Map. If it already exists, replace it.

    + +++ + + + + + + + + + + + + + + + + + +
    Parameters: +
    Return type:

    com.vmware.nsx_policy.model_client.Tier0DeploymentMap

    +
    Returns:

    com.vmware.nsx_policy.model.Tier0DeploymentMap

    +
    Raise:

    com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

    +
    Raise:

    com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

    +
    Raise:

    com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

    +
    Raise:

    com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

    +
    Raise:

    com.vmware.vapi.std.errors_client.NotFound +Not Found

    +
    +
    + +
    + +
    +
    + + +
    + +
    + + +
    +
    + +
    + +
    + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/nsx/nsx_policy/com.vmware.nsx_policy.infra.providers.html b/nsx/nsx_policy/com.vmware.nsx_policy.infra.tier_0s.locale_services.html similarity index 50% rename from nsx/nsx_policy/com.vmware.nsx_policy.infra.providers.html rename to nsx/nsx_policy/com.vmware.nsx_policy.infra.tier_0s.locale_services.html index 851e9232..35cbbae8 100644 --- a/nsx/nsx_policy/com.vmware.nsx_policy.infra.providers.html +++ b/nsx/nsx_policy/com.vmware.nsx_policy.infra.tier_0s.locale_services.html @@ -8,7 +8,7 @@ - com.vmware.nsx_policy.infra.providers package — NSX-T Policy SDK 2.2.0.0.0 documentation + com.vmware.nsx_policy.infra.tier_0s.locale_services package — NSX-T Policy SDK 2.3.0.0.1 documentation @@ -24,13 +24,12 @@ - - + - - + + @@ -59,7 +58,7 @@
    - 2.2.0.0.0 + 2.3.0.0.1
    @@ -91,6 +90,7 @@
  • Subpackages
  • Submodules
  • com.vmware.nsx_policy_client module
    • +
  • com.vmware.nsx_policy_client_for_vmc module
    • @@ -150,13 +150,15 @@
  • com.vmware.nsx_policy.infra package »
    • -
  • com.vmware.nsx_policy.infra.providers package
    • +
  • com.vmware.nsx_policy.infra.tier_0s package »
    • + +
  • com.vmware.nsx_policy.infra.tier_0s.locale_services package
  • - View page source + View page source
    • @@ -169,15 +171,15 @@
    -
    -

    com.vmware.nsx_policy.infra.providers package

    +
    +

    com.vmware.nsx_policy.infra.tier_0s.locale_services package

    Subpackages

      -
    • com.vmware.nsx_policy.infra.providers.l2vpn_context package @@ -186,22 +188,31 @@

      Submodules

      -
      -

      com.vmware.nsx_policy.infra.providers.bgp_client module

      +
      +

      com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp_client module

      -
      -class com.vmware.nsx_policy.infra.providers.bgp_client.Neighbors(config)
      +
      +class com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp_client.Neighbors(config)

      Bases: vmware.vapi.bindings.stub.VapiInterface

      + +++ + + + +
      Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
      -
      -delete(provider_id, neighbor_id)
      +
      +delete(tier0_id, locale_service_id, neighbor_id)

      Delete BGP neighbor config

      @@ -231,15 +242,16 @@ Not Found

      -
      -get(provider_id, neighbor_id)
      +
      +get(tier0_id, locale_service_id, neighbor_id)

      Read BGP neighbor config

      Parameters:
        -
      • provider_id (str) – (required)
        • +
      • tier0_id (str) – (required)
        • +
      • locale_service_id (str) – (required)
      • neighbor_id (str) – (required)
      @@ -275,15 +287,16 @@ Not Found

      -
      -list(provider_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
      +
      +list(tier0_id, locale_service_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)

      Paginated list of all BGP neighbor configurations

      Parameters:
        -
      • provider_id (str) – (required)
        • +
      • tier0_id (str) – (required)
        • +
      • locale_service_id (str) – (required)
      • neighbor_id (str) – (required)
      - - - - @@ -373,8 +381,8 @@ Not Found

      -
      -update(provider_id, neighbor_id, bgp_neighbor_config)
      +
      +update(tier0_id, locale_service_id, neighbor_id, bgp_neighbor_config)

      If BGP neighbor config with the neighbor-id is not already present, create a new neighbor config. If it already exists, replace the BGP neighbor config with this object.

      @@ -383,7 +391,8 @@ neighbor config with this object.

      @@ -721,196 +1284,20 @@ Not Found

      -
      -class com.vmware.nsx_policy.infra.providers.l3vpns_client.StubFactory(stub_config)
      +
      +class com.vmware.nsx_policy.infra.tier_0s.locale_services.l3vpns_client.StubFactory(stub_config)

      Bases: vmware.vapi.bindings.stub.StubFactoryBase

      -
      - - -
      -

      com.vmware.nsx_policy.infra.providers.service_instances_client module

      -
      -
      -class com.vmware.nsx_policy.infra.providers.service_instances_client.ServiceInstanceEndpoints(config)
      -

      Bases: vmware.vapi.bindings.stub.VapiInterface

      -
      -
      -delete(provider_id, service_instance_id, service_instance_endpoint_id)
      -

      Delete policy service instance endpoint

      +

      Initialize StubFactoryBase

      Parameters:
        -
      • provider_id (str) – (required)
        • +
      • tier0_id (str) – (required)
        • +
      • locale_service_id (str) – (required)
      • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
      • included_fields (str or None) – Comma separated list of fields that should be included in query @@ -326,8 +339,8 @@ Not Found

        -
        -patch(provider_id, neighbor_id, bgp_neighbor_config)
        +
        +patch(tier0_id, locale_service_id, neighbor_id, bgp_neighbor_config)

        If BGP neighbor config with the neighbor-id is not already present, create a new neighbor config. If it already exists, replace the BGP neighbor config with this object.

        @@ -336,18 +349,13 @@ neighbor config with this object.
      Parameters:
      Return type:

      com.vmware.nsx_policy.model_client.BgpNeighborConfig

      -
      Returns:

      com.vmware.nsx_policy.model.BgpNeighborConfig

      -
      Raise:

      com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
      Parameters: @@ -422,29 +431,561 @@ Not Found

      -
      -class com.vmware.nsx_policy.infra.providers.bgp_client.StubFactory(stub_config)
      +
      +class com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp_client.StubFactory(stub_config)

      Bases: vmware.vapi.bindings.stub.StubFactoryBase

      +

      Initialize StubFactoryBase

      + +++ + + + +
      Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
      -
      -

      com.vmware.nsx_policy.infra.providers.l2vpn_context_client module

      +
      +

      com.vmware.nsx_policy.infra.tier_0s.locale_services.byod_service_instances_client module

      -
      -class com.vmware.nsx_policy.infra.providers.l2vpn_context_client.L2vpns(config)
      +
      +class com.vmware.nsx_policy.infra.tier_0s.locale_services.byod_service_instances_client.ServiceInstanceEndpoints(config)

      Bases: vmware.vapi.bindings.stub.VapiInterface

      + +++ + + + +
      Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
      -
      -delete(provider_id, l2vpn_id)
      +
      +delete(tier0_id, locale_service_id, service_instance_id, service_instance_endpoint_id)
      +

      Delete policy service instance endpoint

      + +++ + + + + + + + + + + + + + +
      Parameters:
        +
      • tier0_id (str) – Tier-0 id (required)
        • +
      • locale_service_id (str) – Locale service id (required)
        • +
      • service_instance_id (str) – Service instance id (required)
        • +
      • service_instance_endpoint_id (str) – Service instance endpoint id (required)
        • +
      +
      Raise:

      com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

      +
      Raise:

      com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

      +
      Raise:

      com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

      +
      Raise:

      com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

      +
      Raise:

      com.vmware.vapi.std.errors_client.NotFound +Not Found

      +
      +
      + +
      +
      +get(tier0_id, locale_service_id, service_instance_id, service_instance_endpoint_id)
      +

      Read service instance endpoint

      + +++ + + + + + + + + + + + + + + + + + +
      Parameters:
        +
      • tier0_id (str) – Tier-0 id (required)
        • +
      • locale_service_id (str) – Locale service id (required)
        • +
      • service_instance_id (str) – Service instance id (required)
        • +
      • service_instance_endpoint_id (str) – Service instance endpoint id (required)
        • +
      +
      Return type:

      com.vmware.nsx_policy.model_client.ServiceInstanceEndpoint

      +
      Returns:

      com.vmware.nsx_policy.model.ServiceInstanceEndpoint

      +
      Raise:

      com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

      +
      Raise:

      com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

      +
      Raise:

      com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

      +
      Raise:

      com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

      +
      Raise:

      com.vmware.vapi.std.errors_client.NotFound +Not Found

      +
      +
      + +
      +
      +list(tier0_id, locale_service_id, service_instance_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
      +

      List all service instance endpoint

      + +++ + + + + + + + + + + + + + + + + + +
      Parameters:
        +
      • tier0_id (str) – Tier-0 id (required)
        • +
      • locale_service_id (str) – Locale service id (required)
        • +
      • service_instance_id (str) – Service instance id (required)
        • +
      • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
        • +
      • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
        • +
      • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
        • +
      • sort_ascending (bool or None) – (optional)
        • +
      • sort_by (str or None) – Field by which records are sorted (optional)
        • +
      +
      Return type:

      com.vmware.nsx_policy.model_client.ServiceInstanceEndpointListResult

      +
      Returns:

      com.vmware.nsx_policy.model.ServiceInstanceEndpointListResult

      +
      Raise:

      com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

      +
      Raise:

      com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

      +
      Raise:

      com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

      +
      Raise:

      com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

      +
      Raise:

      com.vmware.vapi.std.errors_client.NotFound +Not Found

      +
      +
      + +
      +
      +patch(tier0_id, locale_service_id, service_instance_id, service_instance_endpoint_id, service_instance_endpoint)
      +

      Create Service instance endpoint.

      + +++ + + + + + + + + + + + + + +
      Parameters:
        +
      • tier0_id (str) – Tier-0 id (required)
        • +
      • locale_service_id (str) – Locale service id (required)
        • +
      • service_instance_id (str) – Service instance id (required)
        • +
      • service_instance_endpoint_id (str) – Service instance endpoint id (required)
        • +
      • service_instance_endpoint (com.vmware.nsx_policy.model_client.ServiceInstanceEndpoint) – (required)
        • +
      +
      Raise:

      com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

      +
      Raise:

      com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

      +
      Raise:

      com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

      +
      Raise:

      com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

      +
      Raise:

      com.vmware.vapi.std.errors_client.NotFound +Not Found

      +
      +
      + +
      +
      +update(tier0_id, locale_service_id, service_instance_id, service_instance_endpoint_id, service_instance_endpoint)
      +

      Create service instance endpoint with given request if not exist. +Modification of service instance endpoint is not allowed.

      + +++ + + + + + + + + + + + + + + + + + +
      Parameters:
        +
      • tier0_id (str) – Tier-0 id (required)
        • +
      • locale_service_id (str) – Locale service id (required)
        • +
      • service_instance_id (str) – Service instance id (required)
        • +
      • service_instance_endpoint_id (str) – Service instance endpoint id (required)
        • +
      • service_instance_endpoint (com.vmware.nsx_policy.model_client.ServiceInstanceEndpoint) – (required)
        • +
      +
      Return type:

      com.vmware.nsx_policy.model_client.ServiceInstanceEndpoint

      +
      Returns:

      com.vmware.nsx_policy.model.ServiceInstanceEndpoint

      +
      Raise:

      com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

      +
      Raise:

      com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

      +
      Raise:

      com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

      +
      Raise:

      com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

      +
      Raise:

      com.vmware.vapi.std.errors_client.NotFound +Not Found

      +
      +
      + +
      + +
      +
      +class com.vmware.nsx_policy.infra.tier_0s.locale_services.byod_service_instances_client.StubFactory(stub_config)
      +

      Bases: vmware.vapi.bindings.stub.StubFactoryBase

      +

      Initialize StubFactoryBase

      + +++ + + + +
      Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
      +
      + +
      +
      +

      com.vmware.nsx_policy.infra.tier_0s.locale_services.endpoints_client module

      +
      +
      +class com.vmware.nsx_policy.infra.tier_0s.locale_services.endpoints_client.StubFactory(stub_config)
      +

      Bases: vmware.vapi.bindings.stub.StubFactoryBase

      +

      Initialize StubFactoryBase

      + +++ + + + +
      Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
      +
      + +
      +
      +class com.vmware.nsx_policy.infra.tier_0s.locale_services.endpoints_client.VirtualEndpoints(config)
      +

      Bases: vmware.vapi.bindings.stub.VapiInterface

      + +++ + + + +
      Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
      +
      +
      +delete(tier0_id, locale_service_id, virtual_endpoint_id)
      +

      Delete virtual endpoint

      + +++ + + + + + + + + + + + + + +
      Parameters:
        +
      • tier0_id (str) – Tier-0 id (required)
        • +
      • locale_service_id (str) – Locale service id (required)
        • +
      • virtual_endpoint_id (str) – Virtual endpoint id (required)
        • +
      +
      Raise:

      com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

      +
      Raise:

      com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

      +
      Raise:

      com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

      +
      Raise:

      com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

      +
      Raise:

      com.vmware.vapi.std.errors_client.NotFound +Not Found

      +
      +
      + +
      +
      +get(tier0_id, locale_service_id, virtual_endpoint_id)
      +

      Read virtual endpoint with given id under given tier-0.

      + +++ + + + + + + + + + + + + + + + + + +
      Parameters:
        +
      • tier0_id (str) – Tier-0 id (required)
        • +
      • locale_service_id (str) – Locale service id (required)
        • +
      • virtual_endpoint_id (str) – Virtual endpoint id (required)
        • +
      +
      Return type:

      com.vmware.nsx_policy.model_client.VirtualEndpoint

      +
      Returns:

      com.vmware.nsx_policy.model.VirtualEndpoint

      +
      Raise:

      com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

      +
      Raise:

      com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

      +
      Raise:

      com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

      +
      Raise:

      com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

      +
      Raise:

      com.vmware.vapi.std.errors_client.NotFound +Not Found

      +
      +
      + +
      +
      +list(tier0_id, locale_service_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
      +

      List all virtual endpoints

      + +++ + + + + + + + + + + + + + + + + + +
      Parameters:
        +
      • tier0_id (str) – Tier-0 id (required)
        • +
      • locale_service_id (str) – Locale service id (required)
        • +
      • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) (optional)
        • +
      • included_fields (str or None) – Comma separated list of fields that should be included in query +result (optional)
        • +
      • page_size (long or None) – Maximum number of results to return in this page (server may return +fewer) (optional, default to 1000)
        • +
      • sort_ascending (bool or None) – (optional)
        • +
      • sort_by (str or None) – Field by which records are sorted (optional)
        • +
      +
      Return type:

      com.vmware.nsx_policy.model_client.VirtualEndpointListResult

      +
      Returns:

      com.vmware.nsx_policy.model.VirtualEndpointListResult

      +
      Raise:

      com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

      +
      Raise:

      com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

      +
      Raise:

      com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

      +
      Raise:

      com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

      +
      Raise:

      com.vmware.vapi.std.errors_client.NotFound +Not Found

      +
      +
      + +
      +
      +patch(tier0_id, locale_service_id, virtual_endpoint_id, virtual_endpoint)
      +

      Create or update virtual endpoint.

      + +++ + + + + + + + + + + + + + +
      Parameters: +
      Raise:

      com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

      +
      Raise:

      com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

      +
      Raise:

      com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

      +
      Raise:

      com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

      +
      Raise:

      com.vmware.vapi.std.errors_client.NotFound +Not Found

      +
      +
      + +
      +
      +update(tier0_id, locale_service_id, virtual_endpoint_id, virtual_endpoint)
      +

      Create or update virtual endpoint.

      + +++ + + + + + + + + + + + + + + + + + +
      Parameters: +
      Return type:

      com.vmware.nsx_policy.model_client.VirtualEndpoint

      +
      Returns:

      com.vmware.nsx_policy.model.VirtualEndpoint

      +
      Raise:

      com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable

      +
      Raise:

      com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

      +
      Raise:

      com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

      +
      Raise:

      com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

      +
      Raise:

      com.vmware.vapi.std.errors_client.NotFound +Not Found

      +
      +
      + +
      + +
      +
      +

      com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context_client module

      +
      +
      +class com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context_client.L2vpns(config)
      +

      Bases: vmware.vapi.bindings.stub.VapiInterface

      + +++ + + + +
      Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
      +
      +
      +delete(tier0_id, locale_service_id, l2vpn_id)

      Delete the L2Vpn with the given id.

      @@ -473,16 +1014,17 @@ Not Found

      -
      -get(provider_id, l2vpn_id)
      +
      +get(tier0_id, locale_service_id, l2vpn_id)

      Read the L2Vpn with the given id.

      Parameters:
        -
      • provider_id (str) – Provider id (required)
        • -
      • l2vpn_id (str) – L2Vpn id (required)
        • +
      • tier0_id (str) – (required)
        • +
      • locale_service_id (str) – (required)
        • +
      • l2vpn_id (str) – (required)
      @@ -517,15 +1059,16 @@ Not Found

      -
      -list(provider_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
      +
      +list(tier0_id, locale_service_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)

      Paginated list of L2Vpns.

      Parameters:
        -
      • provider_id (str) – Provider id (required)
        • -
      • l2vpn_id (str) – L2Vpn id (required)
        • +
      • tier0_id (str) – (required)
        • +
      • locale_service_id (str) – (required)
        • +
      • l2vpn_id (str) – (required)
      @@ -609,8 +1153,8 @@ Not Found

      -
      -update(provider_id, l2vpn_id, l2_vpn)
      +
      +update(tier0_id, locale_service_id, l2vpn_id, l2_vpn)

      Create a new L2Vpn if the L2Vpn with given id does not already exist. If the L2Vpn with the given id already exists, update the existing L2Vpn. This is a full replace.

      @@ -619,8 +1163,9 @@ L2Vpn. This is a full replace.

      @@ -658,21 +1203,38 @@ Not Found

      -
      -class com.vmware.nsx_policy.infra.providers.l2vpn_context_client.StubFactory(stub_config)
      +
      +class com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context_client.StubFactory(stub_config)

      Bases: vmware.vapi.bindings.stub.StubFactoryBase

      +

      Initialize StubFactoryBase

      +
      Parameters:
        -
      • provider_id (str) – Provider id (required)
        • +
      • tier0_id (str) – (required)
        • +
      • locale_service_id (str) – (required)
      • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
      • included_fields (str or None) – Comma separated list of fields that should be included in query @@ -568,8 +1111,8 @@ Not Found

        -
        -patch(provider_id, l2vpn_id, l2_vpn)
        +
        +patch(tier0_id, locale_service_id, l2vpn_id, l2_vpn)

        Create a new L2Vpn if the L2Vpn with given id does not already exist. If the L2Vpn with the given id already exists, merge with the existing L2Vpn. This is a patch.

        @@ -578,8 +1121,9 @@ L2Vpn. This is a patch.
      Parameters:
        -
      • provider_id (str) – Provider id (required)
        • -
      • l2vpn_id (str) – L2Vpn id (required)
        • +
      • tier0_id (str) – (required)
        • +
      • locale_service_id (str) – (required)
        • +
      • l2vpn_id (str) – (required)
      • l2_vpn (com.vmware.nsx_policy.model_client.L2Vpn) – (required)
      Parameters:
        -
      • provider_id (str) – Provider id (required)
        • -
      • l2vpn_id (str) – L2Vpn id (required)
        • +
      • tier0_id (str) – (required)
        • +
      • locale_service_id (str) – (required)
        • +
      • l2vpn_id (str) – (required)
      • l2_vpn (com.vmware.nsx_policy.model_client.L2Vpn) – (required)
      +++ + + + +
      Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
      -
      -

      com.vmware.nsx_policy.infra.providers.l3vpns_client module

      +
      +

      com.vmware.nsx_policy.infra.tier_0s.locale_services.l3vpns_client module

      -
      -class com.vmware.nsx_policy.infra.providers.l3vpns_client.Statistics(config)
      +
      +class com.vmware.nsx_policy.infra.tier_0s.locale_services.l3vpns_client.Statistics(config)

      Bases: vmware.vapi.bindings.stub.VapiInterface

      + +++ + + + +
      Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
      -
      -get(provider_id, l3vpn_id, enforcement_point_path=None)
      +
      +get(tier0_id, locale_service_id, l3vpn_id, enforcement_point_path=None)

      Get statistics of an L3Vpn. - no enforcement point path specified: Stats will be evaluated on each enforcement point. - {enforcement_point_path}: Stats are evaluated only on the given @@ -682,8 +1244,9 @@ enforcement point.
      Parameters:
        -
      • provider_id (str) – Provider id (required)
        • -
      • l3vpn_id (str) – L3Vpn id (required)
        • +
      • tier0_id (str) – (required)
        • +
      • locale_service_id (str) – (required)
        • +
      • l3vpn_id (str) – (required)
      • enforcement_point_path (str or None) – String Path of the enforcement point (optional)
      - - - - - - - - - - - +
      Parameters:
        -
      • provider_id (str) – Provider id (required)
        • -
      • service_instance_id (str) – Service instance id (required)
        • -
      • service_instance_endpoint_id (str) – Service instance endpoint id (required)
        • -
      -
      Raise:

      com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

      -
      Raise:

      com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

      -
      Raise:

      com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

      -
      Raise:

      com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

      -
      Raise:

      com.vmware.vapi.std.errors_client.NotFound -Not Found

      -
      Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
      -
      -
      -get(provider_id, service_instance_id, service_instance_endpoint_id)
      -

      Read service instance endpoint

      - --- - - - - - - - - - - - - - - - - - -
      Parameters:
        -
      • provider_id (str) – Provider id (required)
        • -
      • service_instance_id (str) – Service instance id (required)
        • -
      • service_instance_endpoint_id (str) – Service instance endpoint id (required)
        • -
      -
      Return type:

      com.vmware.nsx_policy.model_client.ServiceInstanceEndpoint

      -
      Returns:

      com.vmware.nsx_policy.model.ServiceInstanceEndpoint

      -
      Raise:

      com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

      -
      Raise:

      com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

      -
      Raise:

      com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

      -
      Raise:

      com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

      -
      Raise:

      com.vmware.vapi.std.errors_client.NotFound -Not Found

      -
      -
      - -
      -
      -patch(provider_id, service_instance_id, service_instance_endpoint_id, service_instance_endpoint)
      -

      Create Service instance endpoint.

      - --- - - - - - - - - - - - - - -
      Parameters:
        -
      • provider_id (str) – Provider id (required)
        • -
      • service_instance_id (str) – Service instance id (required)
        • -
      • service_instance_endpoint_id (str) – Service instance endpoint id (required)
        • -
      • service_instance_endpoint (com.vmware.nsx_policy.model_client.ServiceInstanceEndpoint) – (required)
        • -
      -
      Raise:

      com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

      -
      Raise:

      com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

      -
      Raise:

      com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

      -
      Raise:

      com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

      -
      Raise:

      com.vmware.vapi.std.errors_client.NotFound -Not Found

      -
      -
      - -
      -
      -update(provider_id, service_instance_id, service_instance_endpoint_id, service_instance_endpoint)
      -

      Create service instance endpoint.

      - --- - - - - - - - - - - - - - - - - - -
      Parameters:
        -
      • provider_id (str) – Provider id (required)
        • -
      • service_instance_id (str) – Service instance id (required)
        • -
      • service_instance_endpoint_id (str) – Service instance endpoint id (required)
        • -
      • service_instance_endpoint (com.vmware.nsx_policy.model_client.ServiceInstanceEndpoint) – (required)
        • -
      -
      Return type:

      com.vmware.nsx_policy.model_client.ServiceInstanceEndpoint

      -
      Returns:

      com.vmware.nsx_policy.model.ServiceInstanceEndpoint

      -
      Raise:

      com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

      -
      Raise:

      com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

      -
      Raise:

      com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

      -
      Raise:

      com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

      -
      Raise:

      com.vmware.vapi.std.errors_client.NotFound -Not Found

      -
      -
      - -
      - -
      -
      -class com.vmware.nsx_policy.infra.providers.service_instances_client.StubFactory(stub_config)
      -

      Bases: vmware.vapi.bindings.stub.StubFactoryBase

      -
      -
      @@ -922,10 +1309,10 @@ Not Found

      @@ -934,7 +1321,7 @@ Not Found

      - © Copyright 2018, VMware, Inc.. + © Copyright 2018, VMware, Inc.

      @@ -953,33 +1340,22 @@ Not Found

      - - - - + + + + + + + + - - - - + diff --git a/nsx/nsx_policy/com.vmware.nsx_policy.infra.providers.l2vpn_context.html b/nsx/nsx_policy/com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.html similarity index 60% rename from nsx/nsx_policy/com.vmware.nsx_policy.infra.providers.l2vpn_context.html rename to nsx/nsx_policy/com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.html index 4ced8628..c989ce7f 100644 --- a/nsx/nsx_policy/com.vmware.nsx_policy.infra.providers.l2vpn_context.html +++ b/nsx/nsx_policy/com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.html @@ -8,7 +8,7 @@ - com.vmware.nsx_policy.infra.providers.l2vpn_context package — NSX-T Policy SDK 2.2.0.0.0 documentation + com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context package — NSX-T Policy SDK 2.3.0.0.1 documentation @@ -24,13 +24,12 @@ - - + - - + + @@ -59,7 +58,7 @@
      - 2.2.0.0.0 + 2.3.0.0.1
      @@ -91,6 +90,7 @@
    • Subpackages
    • Submodules
    • com.vmware.nsx_policy_client module
      • +
    • com.vmware.nsx_policy_client_for_vmc module
    @@ -150,15 +150,17 @@
  • com.vmware.nsx_policy.infra package »
    • -
  • com.vmware.nsx_policy.infra.providers package »
    • +
  • com.vmware.nsx_policy.infra.tier_0s package »
    • -
  • com.vmware.nsx_policy.infra.providers.l2vpn_context package
    • +
  • com.vmware.nsx_policy.infra.tier_0s.locale_services package »
    • + +
  • com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context package
  • - View page source + View page source
    • @@ -171,20 +173,28 @@
    -
    -

    com.vmware.nsx_policy.infra.providers.l2vpn_context package

    +
    +

    com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context package

    Submodules

    -
    -

    com.vmware.nsx_policy.infra.providers.l2vpn_context.l2vpns_client module

    +
    +

    com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.l2vpns_client module

    -
    -class com.vmware.nsx_policy.infra.providers.l2vpn_context.l2vpns_client.PeerConfig(config)
    +
    +class com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.l2vpns_client.PeerConfig(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    -
    -get(provider_id, l2vpn_id, enforcement_point_path=None)
    +
    +get(tier0_id, locale_service_id, l2vpn_id, enforcement_point_path=None)

    Get peer config for the L2Vpn to configure the remote side of the tunnel. - no enforcement point path specified: L2Vpn Peer Codes will be evaluated on each enforcement point. - {enforcement_point_path}: L2Vpn @@ -194,8 +204,9 @@ Peer Codes are evaluated only on the given enforcement point.
    Parameters:
      -
    • provider_id (str) – Provider id (required)
      • -
    • l2vpn_id (str) – L2Vpn id (required)
      • +
    • tier0_id (str) – (required)
      • +
    • locale_service_id (str) – (required)
      • +
    • l2vpn_id (str) – (required)
    • enforcement_point_path (str or None) – String Path of the enforcement point (optional)
    +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    -
    -get(provider_id, l2vpn_id, enforcement_point_path=None)
    +
    +get(tier0_id, locale_service_id, l2vpn_id, enforcement_point_path=None)

    Get statistics of an L2Vpn. - no enforcement point path specified: Stats will be evaluated on each enforcement point. - {enforcement_point_path}: Stats are evaluated only on the given @@ -248,8 +267,9 @@ enforcement point.
    Parameters:
      -
    • provider_id (str) – Provider id (required)
      • -
    • l2vpn_id (str) – L2Vpn id (required)
      • +
    • tier0_id (str) – (required)
      • +
    • locale_service_id (str) – (required)
      • +
    • l2vpn_id (str) – (required)
    • enforcement_point_path (str or None) – String Path of the enforcement point (optional)
    +++ + + + +
    Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
    @@ -303,10 +332,10 @@ Not Found

    @@ -315,7 +344,7 @@ Not Found

    - © Copyright 2018, VMware, Inc.. + © Copyright 2018, VMware, Inc.

    @@ -334,33 +363,22 @@ Not Found

    - - - - + + + + + + + + - - - - + diff --git a/nsx/nsx_policy/com.vmware.nsx_policy.infra.networks.html b/nsx/nsx_policy/com.vmware.nsx_policy.infra.tier_1s.html similarity index 73% rename from nsx/nsx_policy/com.vmware.nsx_policy.infra.networks.html rename to nsx/nsx_policy/com.vmware.nsx_policy.infra.tier_1s.html index 65e76285..ab4791bd 100644 --- a/nsx/nsx_policy/com.vmware.nsx_policy.infra.networks.html +++ b/nsx/nsx_policy/com.vmware.nsx_policy.infra.tier_1s.html @@ -8,7 +8,7 @@ - com.vmware.nsx_policy.infra.networks package — NSX-T Policy SDK 2.2.0.0.0 documentation + com.vmware.nsx_policy.infra.tier_1s package — NSX-T Policy SDK 2.3.0.0.1 documentation @@ -24,13 +24,11 @@ - - + - - + @@ -59,7 +57,7 @@
    - 2.2.0.0.0 + 2.3.0.0.1
    @@ -91,6 +89,7 @@
  • Subpackages
  • Submodules
  • com.vmware.nsx_policy_client module
    • +
  • com.vmware.nsx_policy_client_for_vmc module
    • @@ -150,13 +149,13 @@
  • com.vmware.nsx_policy.infra package »
    • -
  • com.vmware.nsx_policy.infra.networks package
    • +
  • com.vmware.nsx_policy.infra.tier_1s package
  • - View page source + View page source
    • @@ -169,27 +168,35 @@
    -
    -

    com.vmware.nsx_policy.infra.networks package

    +
    +

    com.vmware.nsx_policy.infra.tier_1s package

    Submodules

    -
    -

    com.vmware.nsx_policy.infra.networks.nat_client module

    +
    +

    com.vmware.nsx_policy.infra.tier_1s.nat_client module

    -
    -class com.vmware.nsx_policy.infra.networks.nat_client.NatRules(config)
    +
    +class com.vmware.nsx_policy.infra.tier_1s.nat_client.NatRules(config)

    Bases: vmware.vapi.bindings.stub.VapiInterface

    + +++ + + + +
    Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
    -
    -delete(network_name, nat_id, nat_rule_id)
    +
    +delete(tier1_id, nat_id, nat_rule_id)

    Delete NAT Rule.

    Parameters:
      -
    • network_name (str) – Network ID (required)
      • +
    • tier1_id (str) – Tier-1 ID (required)
    • nat_id (str) – NAT id (required)
    • nat_rule_id (str) – Rule ID (required)
    @@ -220,15 +227,15 @@ Not Found

    -
    -get(network_name, nat_id, nat_rule_id)
    +
    +get(tier1_id, nat_id, nat_rule_id)

    Get NAT Rule.

    Parameters:
      -
    • network_name (str) – Network ID (required)
      • +
    • tier1_id (str) – Tier-1 ID (required)
    • nat_id (str) – NAT id (required)
    • nat_rule_id (str) – Rule ID (required)
    @@ -265,15 +272,15 @@ Not Found

    -
    -list(network_name, nat_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)
    +
    +list(tier1_id, nat_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)

    List NAT Rules.

    Parameters:
      -
    • network_name (str) – Network ID (required)
      • +
    • tier1_id (str) – Tier-1 ID (required)
    • nat_id (str) – NAT id (required)
    • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
      • @@ -317,16 +324,16 @@ Not Found

      -
      -patch(network_name, nat_id, nat_rule_id, policy_nat_rule)
      -

      If a NAT Rule is not already present on Network denoted by Network ID, +

      +patch(tier1_id, nat_id, nat_rule_id, policy_nat_rule)
      +

      If a NAT Rule is not already present on Tier-1 denoted by Tier-1 ID, create a new NAT Rule. If it already exists, update the NAT Rule.

      Parameters:
        -
      • network_name (str) – Network ID (required)
        • +
      • tier1_id (str) – Tier-1 ID (required)
      • nat_id (str) – NAT id (required)
      • nat_rule_id (str) – Rule ID (required)
      • policy_nat_rule (com.vmware.nsx_policy.model_client.PolicyNatRule) – (required)
        • @@ -358,15 +365,15 @@ Not Found

        -
        -update(network_name, nat_id, nat_rule_id, policy_nat_rule)
        +
        +update(tier1_id, nat_id, nat_rule_id, policy_nat_rule)

        Update NAT Rule.

        - + + -
        Parameters:
      • delete_0() (com.vmware.nsx_policy_client.Licenses method)
        • -
      • DeleteRequestParameters (class in com.vmware.nsx_policy.model_client) +
      • deletestalebindings() (com.vmware.nsx_policy.aaa_client.RoleBindings method)
      • deploy() (com.vmware.nsx_policy_client.Templates method)
      • DEPLOYMENT_MODE_ACTIVE_STANDBY (com.vmware.nsx_policy.model_client.BasePolicyServiceInstance attribute)
      • DEPLOYMENT_MODE_STAND_ALONE (com.vmware.nsx_policy.model_client.BasePolicyServiceInstance attribute)
      • DEPLOYMENT_STATUS_DEPLOYMENT_FAILED (com.vmware.nsx_policy.model_client.InstanceRuntime attribute) @@ -2035,6 +2248,22 @@
      • (com.vmware.nsx_policy.model_client.IPSecVPNTunnelProfile attribute)
      • (com.vmware.nsx_policy.model_client.L3Vpn attribute) +
        • + +
      • DH_GROUPS_GROUP2 (com.vmware.nsx_policy.model_client.IPSecVPNIKEProfile attribute) + +
        • +
      • DH_GROUPS_GROUP5 (com.vmware.nsx_policy.model_client.IPSecVPNIKEProfile attribute) + +
      • DhcpFilter (class in com.vmware.nsx_policy.model_client) @@ -2073,6 +2302,18 @@
        • +
      • DIGEST_ALGORITHMS_SHA2_384 (com.vmware.nsx_policy.model_client.IPSecVPNIKEProfile attribute) + +
        • +
      • DIGEST_ALGORITHMS_SHA2_512 (com.vmware.nsx_policy.model_client.IPSecVPNIKEProfile attribute) + +
      • DIRECTION_BIDIRECTIONAL (com.vmware.nsx_policy.model_client.PortMirroringInstance attribute) @@ -2099,6 +2340,8 @@
      • (com.vmware.nsx_policy.model_client.FirewallRule attribute)
      • (com.vmware.nsx_policy.model_client.RealizedFirewallRule attribute) +
        • +
      • (com.vmware.nsx_policy.model_client.RedirectionRule attribute)
      • (com.vmware.nsx_policy.model_client.ServiceInsertionRule attribute)
        • @@ -2109,6 +2352,8 @@
      • (com.vmware.nsx_policy.model_client.FirewallRule attribute)
      • (com.vmware.nsx_policy.model_client.RealizedFirewallRule attribute) +
        • +
      • (com.vmware.nsx_policy.model_client.RedirectionRule attribute)
      • (com.vmware.nsx_policy.model_client.ServiceInsertionRule attribute)
        • @@ -2129,6 +2374,8 @@
      • (com.vmware.nsx_policy.model_client.FirewallRule attribute)
      • (com.vmware.nsx_policy.model_client.RealizedFirewallRule attribute) +
        • +
      • (com.vmware.nsx_policy.model_client.RedirectionRule attribute)
      • (com.vmware.nsx_policy.model_client.ServiceInsertionRule attribute)
        • @@ -2166,8 +2413,12 @@
      • DirectoryLdapServerListResults (class in com.vmware.nsx_policy.model_client)
      • DiscoveredNode (class in com.vmware.nsx_policy.model_client) +
        • +
      • DiscoveredNodeInterfaceProperties (class in com.vmware.nsx_policy.model_client)
      • DiscoveredNodeListResult (class in com.vmware.nsx_policy.model_client) +
        • +
      • DiscoveredNodeNetworkInterfaces (class in com.vmware.nsx_policy.model_client)
      • DiscoveredResource (class in com.vmware.nsx_policy.model_client)
        • @@ -2181,7 +2432,7 @@
      • (class in com.vmware.nsx_policy.infra.realized_state.enforcement_points.ops.domains_client)
        • -
      • DnsForwarder (class in com.vmware.nsx_policy.infra.networks_client) +
      • DnsForwarder (class in com.vmware.nsx_policy.infra.tier_1s_client)
        		• -
      • ENTITY_TYPE_DUMMY (com.vmware.nsx_policy.model_client.GenericPolicyRealizedResource attribute) -
      • EntityInstanceCountConstraintExpression (class in com.vmware.nsx_policy.model_client)
      • ERROR_CODE_AUTHENTICATION_FAILURE (com.vmware.nsx_policy.model_client.BackupOperationStatus attribute) @@ -2367,20 +2610,48 @@
      • ERROR_CODE_TIMEOUT (com.vmware.nsx_policy.model_client.BackupOperationStatus attribute)
        • -
      • ERROR_LOG_LEVEL_ALERT (com.vmware.nsx_policy.model_client.LbService attribute) +
      • ERROR_LOG_LEVEL_ALERT (com.vmware.nsx_policy.model_client.LBService attribute) + +
        • +
      • ERROR_LOG_LEVEL_CRITICAL (com.vmware.nsx_policy.model_client.LBService attribute) + +
        • +
      • ERROR_LOG_LEVEL_DEBUG (com.vmware.nsx_policy.model_client.LBService attribute) + +
        • +
      • ERROR_LOG_LEVEL_EMERGENCY (com.vmware.nsx_policy.model_client.LBService attribute) + +
        • +
      • ERROR_LOG_LEVEL_ERROR (com.vmware.nsx_policy.model_client.LBService attribute) + +
        • +
      • ERROR_LOG_LEVEL_INFO (com.vmware.nsx_policy.model_client.LBService attribute) + +
        • +
      • ERROR_LOG_LEVEL_WARNING (com.vmware.nsx_policy.model_client.LBService attribute) + +
      • ErrorResolver (class in com.vmware.nsx_policy_client)
      • ErrorResolverInfo (class in com.vmware.nsx_policy.model_client) @@ -2456,6 +2727,12 @@
      • FAILURE_STATUS_OTHER_ERROR (com.vmware.nsx_policy.model_client.ControlConnStatus attribute)
      • FAILURE_STATUS_OTHER_SSL_ERROR (com.vmware.nsx_policy.model_client.ControlConnStatus attribute) +
        • +
      • FeatureAccess (class in com.vmware.nsx_policy.model_client) +
        • +
      • FeatureAccessListResult (class in com.vmware.nsx_policy.model_client) +
        • +
      • FeatureInfo (class in com.vmware.nsx_policy.model_client)
      • FeaturePermission (class in com.vmware.nsx_policy.model_client)
        • @@ -2472,15 +2749,17 @@
      • FeatureUsageList (class in com.vmware.nsx_policy.model_client)
      • FeatureUsageListInCsvFormat (class in com.vmware.nsx_policy.model_client) +
        • +
      • FieldSanityConstraintExpression (class in com.vmware.nsx_policy.model_client)
      • FileTransferAuthenticationScheme (class in com.vmware.nsx_policy.model_client)
        • +         		+
      • FORM_FACTOR_MEDIUM_LARGE (com.vmware.nsx_policy.model_client.ClusterNodeVMDeploymentRequest attribute) +
      • FORM_FACTOR_SMALL (com.vmware.nsx_policy.model_client.ClusterNodeVMDeploymentRequest attribute)
          @@ -2547,6 +2828,12 @@

          G

          @@ -2803,18 +3126,10 @@

          H

          - +
          +
        • HOST_TYPE_RHELCONTAINER (com.vmware.nsx_policy.model_client.VersionedDeploymentSpec attribute) +
        • HOST_TYPE_RHELKVM (com.vmware.nsx_policy.model_client.SVMDeploymentSpec attribute)
          • +
        • HOST_TYPE_RHELSERVER (com.vmware.nsx_policy.model_client.VersionedDeploymentSpec attribute) +
        • HOST_TYPE_UBUNTUKVM (com.vmware.nsx_policy.model_client.SVMDeploymentSpec attribute)
          • +
        • HOST_TYPE_UBUNTUSERVER (com.vmware.nsx_policy.model_client.VersionedDeploymentSpec attribute) +
        • HostAggregateInfo (class in com.vmware.nsx_policy.model_client)
        • HostAggregateInfoListResult (class in com.vmware.nsx_policy.model_client) @@ -2912,6 +3237,8 @@
        • HostInfraTrafficType (class in com.vmware.nsx_policy.model_client)
        • HostNode (class in com.vmware.nsx_policy.model_client) +
          • +
        • HostNodeElement (class in com.vmware.nsx_policy.model_client)
        • HostNodeLoginCredential (class in com.vmware.nsx_policy.model_client)
          • @@ -2926,14 +3253,6 @@
        • HostSwitchSpec (class in com.vmware.nsx_policy.model_client)
        • HostSwitchState (class in com.vmware.nsx_policy.model_client) -
          • -
        • HttpPolicyLbMonitorProfile (class in com.vmware.nsx_policy.model_client) -
          • -
        • HttpPolicyLbVirtualServer (class in com.vmware.nsx_policy.model_client) -
          • -
        • HttpsPolicyLbMonitorProfile (class in com.vmware.nsx_policy.model_client) -
          • -
        • HttpsPolicyLbVirtualServer (class in com.vmware.nsx_policy.model_client)
          • @@ -2941,8 +3260,6 @@

          I

          - + + - - + - + - + + - + -
          - -
        • L7PolicyLbPersistenceProfile (class in com.vmware.nsx_policy.model_client) -
        • L7ServiceEntry (class in com.vmware.nsx_policy.model_client)
        • Label (class in com.vmware.nsx_policy.model_client) @@ -3412,26 +3735,56 @@
        • LabelValueConfiguration (class in com.vmware.nsx_policy.model_client)
        • Lag (class in com.vmware.nsx_policy.model_client) +
          • +
        • LBActiveMonitor (class in com.vmware.nsx_policy.model_client)
        • LbActiveMonitor (class in com.vmware.nsx_policy.model_client) +
          • +
        • LBAppProfile (class in com.vmware.nsx_policy.model_client)
        • LbAppProfile (class in com.vmware.nsx_policy.model_client) +
          • +
        • LBAppProfileListResult (class in com.vmware.nsx_policy.model_client)
        • LbAppProfileListResult (class in com.vmware.nsx_policy.model_client) +
          • +
        • LbAppProfiles (class in com.vmware.nsx_policy.infra_client) +
          • +
        • LbClientCertificateIssuerDnCondition (class in com.vmware.nsx_policy.model_client) +
          • +
        • LbClientCertificateSubjectDnCondition (class in com.vmware.nsx_policy.model_client) +
          • +
        • LBClientSslProfile (class in com.vmware.nsx_policy.model_client)
        • LbClientSslProfile (class in com.vmware.nsx_policy.model_client) +
          • +
        • LBClientSslProfileBinding (class in com.vmware.nsx_policy.model_client) +
          • +
        • LBClientSslProfileListResult (class in com.vmware.nsx_policy.model_client)
        • LbClientSslProfileListResult (class in com.vmware.nsx_policy.model_client) +
          • +
        • LbClientSslProfiles (class in com.vmware.nsx_policy.infra_client) +
          • +
        • LBCookiePersistenceProfile (class in com.vmware.nsx_policy.model_client)
        • LbCookiePersistenceProfile (class in com.vmware.nsx_policy.model_client)
        • LbCookieTime (class in com.vmware.nsx_policy.model_client) +
          • +
        • LBFastTcpProfile (class in com.vmware.nsx_policy.model_client)
        • LbFastTcpProfile (class in com.vmware.nsx_policy.model_client) +
          • +
        • LBFastUdpProfile (class in com.vmware.nsx_policy.model_client)
        • LbFastUdpProfile (class in com.vmware.nsx_policy.model_client)
        • LbHttpMonitor (class in com.vmware.nsx_policy.model_client) +
          • +
        • LBHttpMonitorProfile (class in com.vmware.nsx_policy.model_client) +
          • +
        • LBHttpProfile (class in com.vmware.nsx_policy.model_client)
        • LbHttpProfile (class in com.vmware.nsx_policy.model_client)
          • @@ -3444,14 +3797,20 @@
        • LbHttpRequestCookieCondition (class in com.vmware.nsx_policy.model_client)
        • LbHttpRequestHeader (class in com.vmware.nsx_policy.model_client) +
          • +
        • LBHttpRequestHeaderCondition (class in com.vmware.nsx_policy.model_client)
        • LbHttpRequestHeaderCondition (class in com.vmware.nsx_policy.model_client) +
          • +
        • LbHttpRequestHeaderDeleteAction (class in com.vmware.nsx_policy.model_client)
        • LbHttpRequestHeaderRewriteAction (class in com.vmware.nsx_policy.model_client)
        • LbHttpRequestMethodCondition (class in com.vmware.nsx_policy.model_client)
        • LbHttpRequestUriArgumentsCondition (class in com.vmware.nsx_policy.model_client) +
          • +
        • LBHttpRequestUriCondition (class in com.vmware.nsx_policy.model_client)
        • LbHttpRequestUriCondition (class in com.vmware.nsx_policy.model_client)
          • @@ -3460,34 +3819,64 @@
        • LbHttpRequestVersionCondition (class in com.vmware.nsx_policy.model_client)
        • LbHttpResponseHeaderCondition (class in com.vmware.nsx_policy.model_client) +
          • +
        • LbHttpResponseHeaderDeleteAction (class in com.vmware.nsx_policy.model_client)
        • LbHttpResponseHeaderRewriteAction (class in com.vmware.nsx_policy.model_client)
        • LbHttpsMonitor (class in com.vmware.nsx_policy.model_client) +
          • +
        • LBHttpsMonitorProfile (class in com.vmware.nsx_policy.model_client) +
          • +
        • LbHttpSslCondition (class in com.vmware.nsx_policy.model_client)
        • LbIcmpMonitor (class in com.vmware.nsx_policy.model_client) +
          • +
        • LBIcmpMonitorProfile (class in com.vmware.nsx_policy.model_client)
        • LbIpHeaderCondition (class in com.vmware.nsx_policy.model_client)
        • LbMonitor (class in com.vmware.nsx_policy.model_client)
        • LbMonitorListResult (class in com.vmware.nsx_policy.model_client) +
          • +
        • LBMonitorProfile (class in com.vmware.nsx_policy.model_client) +
          • +
        • LBMonitorProfileListResult (class in com.vmware.nsx_policy.model_client) +
          • +
        • LbMonitorProfiles (class in com.vmware.nsx_policy.infra_client)
        • LbPassiveMonitor (class in com.vmware.nsx_policy.model_client)
        • LbPersistenceCookieTime (class in com.vmware.nsx_policy.model_client) +
          • +
        • LBPersistenceProfile (class in com.vmware.nsx_policy.model_client)
        • LbPersistenceProfile (class in com.vmware.nsx_policy.model_client) +
          • +
        • LBPersistenceProfileListResult (class in com.vmware.nsx_policy.model_client)
        • LbPersistenceProfileListResult (class in com.vmware.nsx_policy.model_client) +
          • +
        • LbPersistenceProfiles (class in com.vmware.nsx_policy.infra_client) +
          • +
        • LBPool (class in com.vmware.nsx_policy.model_client)
        • LbPool (class in com.vmware.nsx_policy.model_client) +
          • +
        • LBPoolListResult (class in com.vmware.nsx_policy.model_client)
        • LbPoolListResult (class in com.vmware.nsx_policy.model_client) +
          • +
        • LBPoolMember (class in com.vmware.nsx_policy.model_client) +
          • +
        • LBPoolMemberGroup (class in com.vmware.nsx_policy.model_client)
        • LbPoolMemberStatistics (class in com.vmware.nsx_policy.model_client)
        • LbPoolMemberStatus (class in com.vmware.nsx_policy.model_client) +
          • +
        • LbPools (class in com.vmware.nsx_policy.infra_client)
        • LbPoolStatistics (class in com.vmware.nsx_policy.model_client)
          • @@ -3496,42 +3885,76 @@
        • LbPoolStatus (class in com.vmware.nsx_policy.model_client)
        • LbPoolStatusListResult (class in com.vmware.nsx_policy.model_client) +
          • +
        • LBRule (class in com.vmware.nsx_policy.model_client)
        • LbRule (class in com.vmware.nsx_policy.model_client) +
          • +
        • LBRuleAction (class in com.vmware.nsx_policy.model_client)
        • LbRuleAction (class in com.vmware.nsx_policy.model_client) +
          • +
        • LBRuleCondition (class in com.vmware.nsx_policy.model_client)
        • LbRuleCondition (class in com.vmware.nsx_policy.model_client)
        • LbRuleListResult (class in com.vmware.nsx_policy.model_client) +
          • +
        • LBSelectPoolAction (class in com.vmware.nsx_policy.model_client)
        • LbSelectPoolAction (class in com.vmware.nsx_policy.model_client)
          • -
        • LbSelectServerAction (class in com.vmware.nsx_policy.model_client) +
        • LBServerSslProfile (class in com.vmware.nsx_policy.model_client)
        • LbServerSslProfile (class in com.vmware.nsx_policy.model_client) +
          • +
        • LBServerSslProfileBinding (class in com.vmware.nsx_policy.model_client) +
          • +
        • LBServerSslProfileListResult (class in com.vmware.nsx_policy.model_client)
        • LbServerSslProfileListResult (class in com.vmware.nsx_policy.model_client) +
          • +
        • LbServerSslProfiles (class in com.vmware.nsx_policy.infra_client) +
          • +
        • LBService (class in com.vmware.nsx_policy.model_client)
        • LbService (class in com.vmware.nsx_policy.model_client) +
          • +
        • LBServiceElement (class in com.vmware.nsx_policy.model_client) +
          • +
        • LBServiceListResult (class in com.vmware.nsx_policy.model_client)
        • LbServiceListResult (class in com.vmware.nsx_policy.model_client) +
          • +
        • LbServices (class in com.vmware.nsx_policy.infra_client)
        • LbSessionCookieTime (class in com.vmware.nsx_policy.model_client) +
          • +
        • LBSnatAutoMap (class in com.vmware.nsx_policy.model_client)
        • LbSnatAutoMap (class in com.vmware.nsx_policy.model_client) +
          • +
        • LBSnatDisabled (class in com.vmware.nsx_policy.model_client) +
          • +
        • LBSnatInfo (class in com.vmware.nsx_policy.model_client)
        • LbSnatIpElement (class in com.vmware.nsx_policy.model_client)
        • LbSnatIpPool (class in com.vmware.nsx_policy.model_client) +
          • +
        • LBSnatTranslation (class in com.vmware.nsx_policy.model_client)
        • LbSnatTranslation (class in com.vmware.nsx_policy.model_client) +
          • +
        • LBSourceIpPersistenceProfile (class in com.vmware.nsx_policy.model_client)
        • LbSourceIpPersistenceProfile (class in com.vmware.nsx_policy.model_client)
        • LbSslCipherAndProtocolListResult (class in com.vmware.nsx_policy.model_client)
        • LbSslCipherInfo (class in com.vmware.nsx_policy.model_client) +
          • +
        • LBSslProfile (class in com.vmware.nsx_policy.model_client)
        • LbSslProfile (class in com.vmware.nsx_policy.model_client)
          • @@ -3544,17 +3967,45 @@
        • LbTcpHeaderCondition (class in com.vmware.nsx_policy.model_client)
        • LbTcpMonitor (class in com.vmware.nsx_policy.model_client) +
          • +
        • LBTcpMonitorProfile (class in com.vmware.nsx_policy.model_client)
        • LbTcpProfile (class in com.vmware.nsx_policy.model_client)
        • LbTcpProfileListResult (class in com.vmware.nsx_policy.model_client)
        • LbUdpMonitor (class in com.vmware.nsx_policy.model_client) +
          • +
        • LBUdpMonitorProfile (class in com.vmware.nsx_policy.model_client) +
          • +
        • LbVariableAssignmentAction (class in com.vmware.nsx_policy.model_client) +
          • +
        • LbVariableCondition (class in com.vmware.nsx_policy.model_client) +
          • +
        • LBVirtualServer (class in com.vmware.nsx_policy.model_client)
        • LbVirtualServer (class in com.vmware.nsx_policy.model_client) +
          • +
        • LBVirtualServerElement (class in com.vmware.nsx_policy.model_client) +
          • +
        • LBVirtualServerIpSetNsGroupMembers (class in com.vmware.nsx_policy.model_client) +
          • +
        • LBVirtualServerListResult (class in com.vmware.nsx_policy.model_client)
        • LbVirtualServerListResult (class in com.vmware.nsx_policy.model_client)
          • +
        • LBVirtualServerPool (class in com.vmware.nsx_policy.model_client) +
          • +
        • LBVirtualServerPoolMember (class in com.vmware.nsx_policy.model_client) +
          • +
        • LBVirtualServerPoolMembersInfo (class in com.vmware.nsx_policy.model_client) +
          • +
        • LBVirtualServerPoolStaticMembers (class in com.vmware.nsx_policy.model_client) +
          • +
        • LbVirtualServers (class in com.vmware.nsx_policy.infra_client) +
          • +           		- +
        • OPERATOR_OR (com.vmware.nsx_policy.model_client.FieldSanityConstraintExpression attribute) +
        • OPERATOR_STARTSWITH (com.vmware.nsx_policy.model_client.Condition attribute) +
          • +
        • OS_TYPE_CENTOSKVM (com.vmware.nsx_policy.model_client.HostNode attribute) +
          • +
        • OS_TYPE_CENTOSSERVER (com.vmware.nsx_policy.model_client.HostNode attribute)
        • OS_TYPE_ESXI (com.vmware.nsx_policy.model_client.HostNode attribute)
        • OS_TYPE_HYPERV (com.vmware.nsx_policy.model_client.HostNode attribute) +
          • +
        • OS_TYPE_RHELCONTAINER (com.vmware.nsx_policy.model_client.HostNode attribute)
        • OS_TYPE_RHELKVM (com.vmware.nsx_policy.model_client.HostNode attribute) +
          • +
        • OS_TYPE_RHELSERVER (com.vmware.nsx_policy.model_client.HostNode attribute)
        • OS_TYPE_UBUNTUKVM (com.vmware.nsx_policy.model_client.HostNode attribute) +
          • +
        • OS_TYPE_UBUNTUSERVER (com.vmware.nsx_policy.model_client.HostNode attribute) +
          • +
        • OVERLAY_ENCAP_GENEVE (com.vmware.nsx_policy.model_client.UplinkHostSwitchProfile attribute) +
          • +
        • OVERLAY_ENCAP_VXLAN (com.vmware.nsx_policy.model_client.UplinkHostSwitchProfile attribute)
        • OwnerResourceLink (class in com.vmware.nsx_policy.model_client)
          • @@ -4404,11 +4977,11 @@
        • PolicyAlarmResource (class in com.vmware.nsx_policy.model_client) +
          • +
        • PolicyApiError (class in com.vmware.nsx_policy.model_client)
        • PolicyAssociationsListResult (class in com.vmware.nsx_policy.model_client)
          • +           		-
        • Provider (class in com.vmware.nsx_policy.model_client) -
          • -
        • ProviderDeploymentMap (class in com.vmware.nsx_policy.model_client) -
          • -
        • ProviderDeploymentMapListResult (class in com.vmware.nsx_policy.model_client) -
          • -
        • ProviderDeploymentMaps (class in com.vmware.nsx_policy.infra.providers_client) -
          • -
        • ProviderInterface (class in com.vmware.nsx_policy.model_client) -
          • -
        • ProviderInterfaceListResult (class in com.vmware.nsx_policy.model_client) -
          • -
        • ProviderListResult (class in com.vmware.nsx_policy.model_client) -
          • -
        • Providers (class in com.vmware.nsx_policy.infra_client) -
        • PUBLIC_KEY_ALGO_DSA (com.vmware.nsx_policy.model_client.X509Certificate attribute)
        • PUBLIC_KEY_ALGO_RSA (com.vmware.nsx_policy.model_client.X509Certificate attribute) @@ -4931,24 +5494,144 @@
          • +
        • REASON_BFD (com.vmware.nsx_policy.model_client.TraceflowObservationDropped attribute) + +
          • +
        • REASON_DHCP (com.vmware.nsx_policy.model_client.TraceflowObservationDropped attribute) + +
        • REASON_FW_RULE (com.vmware.nsx_policy.model_client.TraceflowObservationDropped attribute)
          • +
        • REASON_GENEVE (com.vmware.nsx_policy.model_client.TraceflowObservationDropped attribute) + +
          • +
        • REASON_GRE (com.vmware.nsx_policy.model_client.TraceflowObservationDropped attribute) + +
          • +
        • REASON_IFACE (com.vmware.nsx_policy.model_client.TraceflowObservationDropped attribute) + +
          • +
        • REASON_IP (com.vmware.nsx_policy.model_client.TraceflowObservationDropped attribute) + +
          • +
        • REASON_IP_REASS (com.vmware.nsx_policy.model_client.TraceflowObservationDropped attribute) + +
          • +
        • REASON_IPSEC (com.vmware.nsx_policy.model_client.TraceflowObservationDropped attribute) + +
          • +
        • REASON_IPSEC_VTI (com.vmware.nsx_policy.model_client.TraceflowObservationDropped attribute) + +
          • +
        • REASON_L2VPN (com.vmware.nsx_policy.model_client.TraceflowObservationDropped attribute) + +
          • +
        • REASON_L4PORT (com.vmware.nsx_policy.model_client.TraceflowObservationDropped attribute) + +
          • +
        • REASON_LB (com.vmware.nsx_policy.model_client.TraceflowObservationDropped attribute) + +
          • +
        • REASON_LROUTER (com.vmware.nsx_policy.model_client.TraceflowObservationDropped attribute) + +
          • +
        • REASON_LSERVICE (com.vmware.nsx_policy.model_client.TraceflowObservationDropped attribute) + +
          • +
        • REASON_LSWITCH (com.vmware.nsx_policy.model_client.TraceflowObservationDropped attribute) + +
          • +
        • REASON_MD_PROXY (com.vmware.nsx_policy.model_client.TraceflowObservationDropped attribute) + +
          • +
        • REASON_NAT (com.vmware.nsx_policy.model_client.TraceflowObservationDropped attribute) + +
          • +
        • REASON_NEIGH (com.vmware.nsx_policy.model_client.TraceflowObservationDropped attribute) + +
        • REASON_NO_ROUTE (com.vmware.nsx_policy.model_client.TraceflowObservationDropped attribute)
          • +
        • REASON_SERVICE_INSERT (com.vmware.nsx_policy.model_client.TraceflowObservationDropped attribute) + +
        • REASON_TTL_ZERO (com.vmware.nsx_policy.model_client.TraceflowObservationDropped attribute)
          • +
        • REASON_TUNNEL (com.vmware.nsx_policy.model_client.TraceflowObservationDropped attribute) + +
        • REASON_UNKNOWN (com.vmware.nsx_policy.model_client.TraceflowObservationDropped attribute) @@ -4957,15 +5640,29 @@
        • (com.vmware.nsx_policy.model_client.TraceflowObservationDroppedLogical attribute)
          • -
        • RedirectionCommunicationEntry (class in com.vmware.nsx_policy.model_client) +
        • REASON_VXLAN (com.vmware.nsx_policy.model_client.TraceflowObservationDropped attribute) + +
          • +
        • REASON_VXSTT (com.vmware.nsx_policy.model_client.TraceflowObservationDropped attribute) + +
          • +
        • reauth() (com.vmware.nsx_policy.infra.tier_0s.locale_services_client.ServiceInstances method)
          • -
        • RedirectionCommunicationMapListResult (class in com.vmware.nsx_policy.model_client) +
        • RedirectionPolicies (class in com.vmware.nsx_policy.infra.domains_client)
          • -
        • RedirectionCommunicationMaps (class in com.vmware.nsx_policy.infra.domains_client) +
        • RedirectionPolicy (class in com.vmware.nsx_policy.model_client) +
          • +
        • RedirectionPolicyListResult (class in com.vmware.nsx_policy.model_client) +
          • +
        • RedirectionRule (class in com.vmware.nsx_policy.model_client) +
          • +
        • RedirectionRuleListResult (class in com.vmware.nsx_policy.model_client)
        • RedistributionConfig (class in com.vmware.nsx_policy.model_client)
          • @@ -4981,6 +5678,8 @@
        • (class in com.vmware.nsx_policy.model_client)
          • +
        • RelatedApiError (class in com.vmware.nsx_policy.model_client) +
        • RelatedAttribute (class in com.vmware.nsx_policy.model_client)
        • RelatedAttributeConditionalExpression (class in com.vmware.nsx_policy.model_client) @@ -5041,6 +5740,16 @@
        • (com.vmware.nsx_policy.model_client.LbHttpsMonitor attribute)
          • +
        • REQUEST_STATUS_CONNECTION_ERROR (com.vmware.nsx_policy.model_client.Traceflow attribute) +
          • +
        • REQUEST_STATUS_DATA_PATH_NOT_READY (com.vmware.nsx_policy.model_client.Traceflow attribute) +
          • +
        • REQUEST_STATUS_SOURCE_PORT_NOT_FOUND (com.vmware.nsx_policy.model_client.Traceflow attribute) +
          • +
        • REQUEST_STATUS_SUCCESS (com.vmware.nsx_policy.model_client.Traceflow attribute) +
          • +
        • REQUEST_STATUS_TIMEOUT (com.vmware.nsx_policy.model_client.Traceflow attribute) +
        • REQUEST_VERSION_1_0 (com.vmware.nsx_policy.model_client.LbHttpMonitor attribute)
          		• -
        • RESOURCE_TYPE_UDPPOLICYLBMONITORPROFILE (com.vmware.nsx_policy.model_client.PolicyLbMonitorProfile attribute) -
          • -
        • RESOURCE_TYPE_UDPPOLICYLBVIRTUALSERVER (com.vmware.nsx_policy.model_client.PolicyLbVirtualServer attribute) -
        • RESOURCE_TYPE_UPLINKHOSTSWITCHPROFILE (com.vmware.nsx_policy.model_client.BaseHostSwitchProfile attribute)
        • RESOURCE_TYPE_VALUECONSTRAINTEXPRESSION (com.vmware.nsx_policy.model_client.ConstraintExpression attribute)
          • -
        • RESOURCE_TYPE_VLANMIRRORSOURCE (com.vmware.nsx_policy.model_client.MirrorSource attribute) +
        • RESOURCE_TYPE_VIRTUALENDPOINT (com.vmware.nsx_policy.model_client.BaseEndpoint attribute)
          • -
        • RESOURCE_TYPE_VMELEMENT (com.vmware.nsx_policy.model_client.Element attribute) +
        • RESOURCE_TYPE_VIRTUALNETWORKINTERFACEELEMENT (com.vmware.nsx_policy.model_client.EdgeNodeElement attribute)
          • +
        • RESOURCE_TYPE_VIRTUALSERVICEINSTANCE (com.vmware.nsx_policy.model_client.BaseServiceInstance attribute) +
          • +
        • RESOURCE_TYPE_VLANMIRRORSOURCE (com.vmware.nsx_policy.model_client.MirrorSource attribute) +
          • +
        • RESOURCE_TYPE_VMELEMENT (com.vmware.nsx_policy.model_client.EdgeNodeElement attribute) + +
        • RESOURCE_TYPE_WEEKLYBACKUPSCHEDULE (com.vmware.nsx_policy.model_client.BackupSchedule attribute) @@ -5582,10 +6649,6 @@
        • RevisionedResource (class in com.vmware.nsx_policy.model_client) -
          • -
        • revokemissingnodes() (com.vmware.nsx_policy.cluster_client.Nodes method) -
          • -
        • RevokeNodeRequest (class in com.vmware.nsx_policy.model_client)
        • Role (class in com.vmware.nsx_policy.model_client)
          • @@ -5632,8 +6695,12 @@
        • Roles (class in com.vmware.nsx_policy.aaa_client)
        • ROLES_CONTROLLER (com.vmware.nsx_policy.model_client.ClusterNodeVMDeploymentRequest attribute) +
          • +
        • ROLES_MANAGER (com.vmware.nsx_policy.model_client.ClusterNodeVMDeploymentRequest attribute)
        • RoleWithFeatures (class in com.vmware.nsx_policy.model_client) +
          • +
        • RouteAggregationEntry (class in com.vmware.nsx_policy.model_client)
        • RouteBasedIPSecVPNSession (class in com.vmware.nsx_policy.model_client)
          • @@ -5656,23 +6723,85 @@
        • RouterNexthop (class in com.vmware.nsx_policy.model_client)
        • RoutingConfig (class in com.vmware.nsx_policy.model_client) +
          • +
        • RoutingEntry (class in com.vmware.nsx_policy.model_client) +
          • +
        • RoutingTable (class in com.vmware.nsx_policy.infra.tier_0s_client) + +
          • +
        • RoutingTableListResult (class in com.vmware.nsx_policy.model_client)
        • RowListField (class in com.vmware.nsx_policy.model_client)
          • +
        • Rule (class in com.vmware.nsx_policy.model_client) +
          • +
        • RuleListResult (class in com.vmware.nsx_policy.model_client) +
          • +
        • Rules (class in com.vmware.nsx_policy.infra.domains.gateway_policies_client) + +
        • RuleState (class in com.vmware.nsx_policy.model_client) +
          • +
        • RUNTIME_STATUS_DETACHED (com.vmware.nsx_policy.model_client.LBServiceElement attribute) + +
          • +
        • RUNTIME_STATUS_DISABLED (com.vmware.nsx_policy.model_client.LBServiceElement attribute) + +
          • +
        • RUNTIME_STATUS_DOWN (com.vmware.nsx_policy.model_client.LBServiceElement attribute) + +
          • +
        • RUNTIME_STATUS_ERROR (com.vmware.nsx_policy.model_client.LBServiceElement attribute)
        • RUNTIME_STATUS_IN_SERVICE (com.vmware.nsx_policy.model_client.InstanceRuntime attribute)
        • RUNTIME_STATUS_NEEDS_ATTENTION (com.vmware.nsx_policy.model_client.InstanceRuntime attribute) +
          • +
        • RUNTIME_STATUS_NO_STANDBY (com.vmware.nsx_policy.model_client.LBServiceElement attribute) +
          • +
        • RUNTIME_STATUS_NOT_AVAILABLE (com.vmware.nsx_policy.model_client.InstanceRuntime attribute)
        • RUNTIME_STATUS_OUT_OF_SERVICE (com.vmware.nsx_policy.model_client.InstanceRuntime attribute)
          • +
        • RUNTIME_STATUS_PARTIALLY_DOWN (com.vmware.nsx_policy.model_client.LBVirtualServerElement attribute) +
          • +
        • RUNTIME_STATUS_PARTIALLY_UP (com.vmware.nsx_policy.model_client.LBVirtualServerElement attribute) +
          • +
        • RUNTIME_STATUS_UNKNOWN (com.vmware.nsx_policy.model_client.LBServiceElement attribute) +
          • +
        • RUNTIME_STATUS_UP (com.vmware.nsx_policy.model_client.LBServiceElement attribute) + +

          • S

          + -

          - © Copyright 2018, VMware, Inc.. + © Copyright 2018, VMware, Inc.

          @@ -758,33 +395,22 @@ Not Found - - - - + + + + + + + + - - - - + diff --git a/nsx/vmc_app/com.vmware.nsx_vmc_app.html b/nsx/vmc_app/com.vmware.nsx_vmc_app.html index 35ea763e..3be3fcf4 100644 --- a/nsx/vmc_app/com.vmware.nsx_vmc_app.html +++ b/nsx/vmc_app/com.vmware.nsx_vmc_app.html @@ -8,7 +8,7 @@ - com.vmware.nsx_vmc_app package — NSX-T Policy SDK 2.2.0.0.0 documentation + com.vmware.nsx_vmc_app package — NSX-T Policy SDK 2.3.0.0.1 documentation @@ -24,11 +24,11 @@ - - + + @@ -58,7 +58,7 @@
          - 2.2.0.0.0 + 2.3.0.0.1
          @@ -90,6 +90,7 @@
        • Subpackages
        • Submodules
        • com.vmware.nsx_vmc_app_client module
          • +
        • com.vmware.nsx_vmc_app_client_for_vmc module
          • @@ -166,29 +167,103 @@

          com.vmware.nsx_vmc_app package

          +

          Submodules

          -
          -

          com.vmware.nsx_vmc_app.linked_vpcs_client module

          +
          +

          com.vmware.nsx_vmc_app.infra_client module

          -
          -class com.vmware.nsx_vmc_app.linked_vpcs_client.ConnectedServices(config)
          +
          +class com.vmware.nsx_vmc_app.infra_client.Accounts(config)

          Bases: vmware.vapi.bindings.stub.VapiInterface

          -
          -
          -list(linked_vpc_id)
          -

          List services connected to this linked vpc, for example, S3. The -response consist of all available services along with their status.

        • Securitygroups (class in com.vmware.nsx_policy.infra.realized_state.enforcement_points.groups_client) +
          • +
        • SecurityPolicy (class in com.vmware.nsx_policy.model_client) +
          • +
        • SecurityPolicyListResult (class in com.vmware.nsx_policy.model_client)
        • Segment (class in com.vmware.nsx_policy.model_client) +
          • +
        • SegmentAdvancedConfig (class in com.vmware.nsx_policy.model_client)
        • SegmentListResult (class in com.vmware.nsx_policy.model_client)
          • -
        • Segments (class in com.vmware.nsx_policy.infra.networks_client) +
        • Segments (class in com.vmware.nsx_policy.infra.tier_1s_client)
        • SegmentSubnet (class in com.vmware.nsx_policy.model_client)
          • @@ -5757,13 +6892,15 @@
        • (com.vmware.nsx_policy.model_client.ServerSslProfileBinding attribute)
          • -
        • SERVER_SSL_SETTINGS_BASE_SECURE_111317 (com.vmware.nsx_policy.model_client.CustomPolicyLbVirtualServer attribute) +
        • SERVER_POOL_ALGORITHM_IP_HASH (com.vmware.nsx_policy.model_client.LBVirtualServerPool attribute)
          • -
        • SERVER_SSL_SETTINGS_DISABLED (com.vmware.nsx_policy.model_client.CustomPolicyLbVirtualServer attribute) +
        • SERVER_POOL_ALGORITHM_LEAST_CONNECTION (com.vmware.nsx_policy.model_client.LBVirtualServerPool attribute)
          • -
        • SERVER_SSL_SETTINGS_HIGH_SECURE_111317 (com.vmware.nsx_policy.model_client.CustomPolicyLbVirtualServer attribute) +
        • SERVER_POOL_ALGORITHM_ROUND_ROBIN (com.vmware.nsx_policy.model_client.LBVirtualServerPool attribute)
          • -
        • SERVER_SSL_SETTINGS_MODERATE_SECURE_111317 (com.vmware.nsx_policy.model_client.CustomPolicyLbVirtualServer attribute) +
        • SERVER_POOL_ALGORITHM_WEIGHTED_LEAST_CONNECTION (com.vmware.nsx_policy.model_client.LBVirtualServerPool attribute) +
          • +
        • SERVER_POOL_ALGORITHM_WEIGHTED_ROUND_ROBIN (com.vmware.nsx_policy.model_client.LBVirtualServerPool attribute)
        • ServerSslProfileBinding (class in com.vmware.nsx_policy.model_client)
          • @@ -5806,6 +6943,8 @@
        • ServiceDefinitions (class in com.vmware.nsx_policy.enforcement_points_client)
        • ServiceDeploymentSpec (class in com.vmware.nsx_policy.model_client) +
          • +
        • ServiceElement (class in com.vmware.nsx_policy.model_client)
        • ServiceEndpoint (class in com.vmware.nsx_policy.model_client)
          • @@ -5833,17 +6972,19 @@
        • ServiceInstanceEndpoint (class in com.vmware.nsx_policy.model_client)
          • -
        • ServiceInstanceEndpoints (class in com.vmware.nsx_policy.infra.providers.service_instances_client) +
        • ServiceInstanceEndpointListResult (class in com.vmware.nsx_policy.model_client) +
          • +
        • ServiceInstanceEndpoints (class in com.vmware.nsx_policy.infra.tier_0s.locale_services.byod_service_instances_client)
        • ServiceInstanceListResult (class in com.vmware.nsx_policy.model_client)
          • -
        • ServiceInstances (class in com.vmware.nsx_policy.infra.providers_client) +
        • ServiceInstances (class in com.vmware.nsx_policy.infra.tier_0s.locale_services_client)
        • ServiceInterface (class in com.vmware.nsx_policy.model_client)
        • ServiceInterfaceListResult (class in com.vmware.nsx_policy.model_client)
          • -
        • ServiceInterfaces (class in com.vmware.nsx_policy.infra.providers_client) +
        • ServiceInterfaces (class in com.vmware.nsx_policy.infra.tier_0s.locale_services_client)
        • ServiceIP (class in com.vmware.nsx_policy.model_client)
          • @@ -5856,6 +6997,12 @@
        • ServiceProfileListResult (class in com.vmware.nsx_policy.model_client)
        • Services (class in com.vmware.nsx_policy.infra_client) +
          • +
        • SESSION_REUSED_IGNORE (com.vmware.nsx_policy.model_client.LbHttpSslCondition attribute) +
          • +
        • SESSION_REUSED_NEW (com.vmware.nsx_policy.model_client.LbHttpSslCondition attribute) +
          • +
        • SESSION_REUSED_REUSED (com.vmware.nsx_policy.model_client.LbHttpSslCondition attribute)
        • SESSION_TYPE_L3PORTMIRRORSESSION (com.vmware.nsx_policy.model_client.PortMirroringSession attribute)
          • @@ -5881,13 +7028,39 @@
        • SESSIONSTATUS_STOPPED (com.vmware.nsx_policy.model_client.PacketCaptureSession attribute)
          • -
        • showsensitivedata() (com.vmware.nsx_policy.infra.providers_client.L3vpns method) +
        • should_retry() (com.vmware.nsx_policy_client_for_vmc.CSPSecurityContextFilter method)
          • -
        • SIZE_LARGE (com.vmware.nsx_policy.model_client.LbService attribute) +
        • showsensitivedata() (com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns method)
          • -
        • SIZE_MEDIUM (com.vmware.nsx_policy.model_client.LbService attribute) +
        • SIZE_LARGE (com.vmware.nsx_policy.model_client.LBService attribute) + +
          • +
        • SIZE_MEDIUM (com.vmware.nsx_policy.model_client.LBService attribute) + +
          • +
        • SIZE_SMALL (com.vmware.nsx_policy.model_client.LBService attribute) + +
          • +
        • SNAT_MODE_AUTO_MAP (com.vmware.nsx_policy.model_client.LBSnatInfo attribute) +
          • +
        • SNAT_MODE_IP_LIST (com.vmware.nsx_policy.model_client.LBSnatInfo attribute) +
          • +
        • SNAT_MODE_TRANSPARENT (com.vmware.nsx_policy.model_client.LBSnatInfo attribute)
        • SOURCE_AUTHENTICATION_MODE_BASIC_AUTHENTICATION (com.vmware.nsx_policy.model_client.FabricModule attribute)
          • @@ -5947,11 +7120,11 @@
        • SRC_COMPONENT_TYPE_UNKNOWN (com.vmware.nsx_policy.model_client.TraceflowObservationReceivedLogical attribute)
          • -
        • SslCertificate (class in com.vmware.nsx_policy.model_client) +
        • STALE_FALSE (com.vmware.nsx_policy.model_client.RoleBinding attribute)
          • -
        • SslCertificateList (class in com.vmware.nsx_policy.model_client) +
        • STALE_TRUE (com.vmware.nsx_policy.model_client.RoleBinding attribute)
          • -
        • SslTrustObjectData (class in com.vmware.nsx_policy.model_client) +
        • STALE_UNKNOWN (com.vmware.nsx_policy.model_client.RoleBinding attribute)
        • StandardHostSwitch (class in com.vmware.nsx_policy.model_client)
          • @@ -6101,6 +7274,8 @@
        • (com.vmware.nsx_policy.model_client.TransportNodeState attribute)
          • +
          • STATE_SUCCESS (com.vmware.nsx_policy.model_client.ConfigurationState attribute)
              @@ -6265,13 +7438,11 @@
          • STATE_UP (com.vmware.nsx_policy.model_client.BFDProperties attribute)
            • -
          • StaticArp (class in com.vmware.nsx_policy.infra.networks.segments_client) +
          • StaticArp (class in com.vmware.nsx_policy.infra.tier_1s.segments_client)
          • StaticARPConfig (class in com.vmware.nsx_policy.model_client)
          • StaticHopBfdPeer (class in com.vmware.nsx_policy.model_client) -
            • -
          • StaticHopBfdPeerDeleteRequestParameters (class in com.vmware.nsx_policy.model_client)
          • StaticHopBfdPeerListResult (class in com.vmware.nsx_policy.model_client)
            • @@ -6287,20 +7458,20 @@
          • StaticRouteNextHop (class in com.vmware.nsx_policy.model_client)
            • -
          • StaticRoutes (class in com.vmware.nsx_policy.infra.networks_client) +
          • StaticRoutes (class in com.vmware.nsx_policy.infra.tier_0s_client)
          • StaticRoutesListResult (class in com.vmware.nsx_policy.model_client)
            • -
          • Statistics (class in com.vmware.nsx_policy.infra.providers.l2vpn_context.l2vpns_client) +
          • Statistics (class in com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.l2vpns_client)
          • StatItem (class in com.vmware.nsx_policy.model_client) @@ -6408,6 +7579,10 @@
          • STATUS_UNKNOWN (com.vmware.nsx_policy.model_client.ControllerClusterStatus attribute)
            • +
          • STATUS_UNUSED (com.vmware.nsx_policy.model_client.LbPoolMemberStatus attribute) +
          • STATUS_UP (com.vmware.nsx_policy.model_client.ControlConnStatus attribute)
          • TYPE_DETAIL (com.vmware.nsx_policy.model_client.Icon attribute) +
            • +
          • TYPE_DISCONNECTED (com.vmware.nsx_policy.model_client.Segment attribute)
          • TYPE_EDGE (com.vmware.nsx_policy.model_client.VirtualMachine attribute)
          • TYPE_ERROR (com.vmware.nsx_policy.model_client.Icon attribute) +
            • +
          • TYPE_EXTENDED (com.vmware.nsx_policy.model_client.Segment attribute)
          • TYPE_GROUP (com.vmware.nsx_policy.model_client.VidmInfo attribute)
            • @@ -6939,7 +8150,13 @@
          • TYPE_LBHTTPREQUESTCOOKIECONDITION (com.vmware.nsx_policy.model_client.LbRuleCondition attribute)
            • -
          • TYPE_LBHTTPREQUESTHEADERCONDITION (com.vmware.nsx_policy.model_client.LbRuleCondition attribute) +
          • TYPE_LBHTTPREQUESTHEADERCONDITION (com.vmware.nsx_policy.model_client.LBRuleCondition attribute) + +
            • +
          • TYPE_LBHTTPREQUESTHEADERDELETEACTION (com.vmware.nsx_policy.model_client.LbRuleAction attribute)
          • TYPE_LBHTTPREQUESTHEADERREWRITEACTION (com.vmware.nsx_policy.model_client.LbRuleAction attribute)
            • @@ -6947,31 +8164,53 @@
          • TYPE_LBHTTPREQUESTURIARGUMENTSCONDITION (com.vmware.nsx_policy.model_client.LbRuleCondition attribute)
            • -
          • TYPE_LBHTTPREQUESTURICONDITION (com.vmware.nsx_policy.model_client.LbRuleCondition attribute) +
          • TYPE_LBHTTPREQUESTURICONDITION (com.vmware.nsx_policy.model_client.LBRuleCondition attribute) + +
          • TYPE_LBHTTPREQUESTURIREWRITEACTION (com.vmware.nsx_policy.model_client.LbRuleAction attribute)
          • TYPE_LBHTTPREQUESTVERSIONCONDITION (com.vmware.nsx_policy.model_client.LbRuleCondition attribute)
          • TYPE_LBHTTPRESPONSEHEADERCONDITION (com.vmware.nsx_policy.model_client.LbRuleCondition attribute) +
            • +
          • TYPE_LBHTTPRESPONSEHEADERDELETEACTION (com.vmware.nsx_policy.model_client.LbRuleAction attribute)
          • TYPE_LBHTTPRESPONSEHEADERREWRITEACTION (com.vmware.nsx_policy.model_client.LbRuleAction attribute) +
            • +
          • TYPE_LBHTTPSSLCONDITION (com.vmware.nsx_policy.model_client.LbRuleCondition attribute)
          • TYPE_LBIPHEADERCONDITION (com.vmware.nsx_policy.model_client.LbRuleCondition attribute)
          • TYPE_LBPERSISTENCECOOKIETIME (com.vmware.nsx_policy.model_client.LbCookieTime attribute)
            • -
          • TYPE_LBSELECTPOOLACTION (com.vmware.nsx_policy.model_client.LbRuleAction attribute) +
          • TYPE_LBSELECTPOOLACTION (com.vmware.nsx_policy.model_client.LBRuleAction attribute) + +
          • TYPE_LBSELECTSERVERACTION (com.vmware.nsx_policy.model_client.LbRuleAction attribute)
          • TYPE_LBSESSIONCOOKIETIME (com.vmware.nsx_policy.model_client.LbCookieTime attribute)
            • -
          • TYPE_LBSNATAUTOMAP (com.vmware.nsx_policy.model_client.LbSnatTranslation attribute) +
          • TYPE_LBSNATAUTOMAP (com.vmware.nsx_policy.model_client.LBSnatTranslation attribute) + +
            • +
          • TYPE_LBSNATDISABLED (com.vmware.nsx_policy.model_client.LBSnatTranslation attribute)
          • TYPE_LBSNATIPPOOL (com.vmware.nsx_policy.model_client.LbSnatTranslation attribute)
          • TYPE_LBTCPHEADERCONDITION (com.vmware.nsx_policy.model_client.LbRuleCondition attribute) +
            • +
          • TYPE_LBVARIABLEASSIGNMENTACTION (com.vmware.nsx_policy.model_client.LbRuleAction attribute) +
            • +
          • TYPE_LBVARIABLECONDITION (com.vmware.nsx_policy.model_client.LbRuleCondition attribute)
          • TYPE_LOCAL_USER (com.vmware.nsx_policy.model_client.RoleBinding attribute)
            • @@ -7000,6 +8239,8 @@
          • TYPE_REMOTE_GROUP (com.vmware.nsx_policy.model_client.RoleBinding attribute)
          • TYPE_REMOTE_USER (com.vmware.nsx_policy.model_client.RoleBinding attribute) +
            • +
          • TYPE_ROUTED (com.vmware.nsx_policy.model_client.Segment attribute)
          • TYPE_SERVICE (com.vmware.nsx_policy.model_client.VirtualMachine attribute)
            • @@ -7029,10 +8270,6 @@

            U

            - + - + @@ -7368,7 +8721,7 @@

            - © Copyright 2018, VMware, Inc.. + © Copyright 2018, VMware, Inc.

            @@ -7387,33 +8740,22 @@ - - - - + + + + + + + + - - - - + diff --git a/nsx/nsx_policy/index.html b/nsx/nsx_policy/index.html index 179fcf91..e20ee083 100644 --- a/nsx/nsx_policy/index.html +++ b/nsx/nsx_policy/index.html @@ -8,7 +8,7 @@ - Welcome to NSX-T Policy SDK’s documentation! — NSX-T Policy SDK 2.2.0.0.0 documentation + Welcome to NSX-T Policy SDK’s documentation! — NSX-T Policy SDK 2.3.0.0.1 documentation @@ -24,8 +24,7 @@ - - + @@ -58,7 +57,7 @@
            - 2.2.0.0.0 + 2.3.0.0.1
            @@ -178,24 +177,9 @@
          • Subpackages
          • Submodules
          • com.vmware.nsx_policy.infra.domains.communication_maps_client module
            • -
          • com.vmware.nsx_policy.infra.domains.edge_communication_maps_client module
            • +
          • com.vmware.nsx_policy.infra.domains.gateway_policies_client module
          • com.vmware.nsx_policy.infra.domains.groups_client module
            • -
          • com.vmware.nsx_policy.infra.domains.redirection_communication_maps_client module
            • - - -
          • com.vmware.nsx_policy.infra.networks package -
            • -
          • com.vmware.nsx_policy.infra.providers package
          • com.vmware.nsx_policy.infra.realized_state package
            • +
          • com.vmware.nsx_policy.infra.tier_0s package +
            • +
          • com.vmware.nsx_policy.infra.tier_1s package +
          • Submodules
          • com.vmware.nsx_policy.infra.deployment_zones_client module
          • com.vmware.nsx_policy.infra.domains_client module
            • -
          • com.vmware.nsx_policy.infra.networks_client module
          • com.vmware.nsx_policy.infra.partner_services_client module
            • -
          • com.vmware.nsx_policy.infra.providers_client module
          • com.vmware.nsx_policy.infra.realized_state_client module
          • com.vmware.nsx_policy.infra.services_client module
            • +
          • com.vmware.nsx_policy.infra.tier_0s_client module
            • +
          • com.vmware.nsx_policy.infra.tier_1s_client module
            • @@ -228,6 +224,7 @@
          • com.vmware.nsx_policy.licenses_client module
          • com.vmware.nsx_policy.model_client module
          • com.vmware.nsx_policy.tasks_client module
            • +
          • com.vmware.nsx_policy.telemetry_client module
          • com.vmware.nsx_policy.trust_management_client module
          • com.vmware.nsx_policy.upgrade_client module
            • @@ -236,6 +233,7 @@
          • Submodules
          • com.vmware.nsx_policy_client module
            • +
          • com.vmware.nsx_policy_client_for_vmc module
            • @@ -272,7 +270,7 @@

            - © Copyright 2018, VMware, Inc.. + © Copyright 2018, VMware, Inc.

            @@ -291,33 +289,22 @@ - - - - + + + + + + + + - - - - + diff --git a/nsx/nsx_policy/objects.inv b/nsx/nsx_policy/objects.inv index 5bbdde1f..e0aa3a87 100644 Binary files a/nsx/nsx_policy/objects.inv and b/nsx/nsx_policy/objects.inv differ diff --git a/nsx/nsx_policy/py-modindex.html b/nsx/nsx_policy/py-modindex.html index 981ffa29..a0ec3f5a 100644 --- a/nsx/nsx_policy/py-modindex.html +++ b/nsx/nsx_policy/py-modindex.html @@ -8,7 +8,7 @@ - Python Module Index — NSX-T Policy SDK 2.2.0.0.0 documentation + Python Module Index — NSX-T Policy SDK 2.3.0.0.1 documentation @@ -24,8 +24,7 @@ - - + @@ -60,7 +59,7 @@
            - 2.2.0.0.0 + 2.3.0.0.1
            @@ -252,13 +251,18 @@ + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +
          • USED_PROTOCOL_SSL_V2 (com.vmware.nsx_policy.model_client.LbHttpSslCondition attribute) +
            • +
          • USED_PROTOCOL_SSL_V3 (com.vmware.nsx_policy.model_client.LbHttpSslCondition attribute) +
            • +
          • USED_PROTOCOL_TLS_V1 (com.vmware.nsx_policy.model_client.LbHttpSslCondition attribute) +
            • +
          • USED_PROTOCOL_TLS_V1_1 (com.vmware.nsx_policy.model_client.LbHttpSslCondition attribute) +
            • +
          • USED_PROTOCOL_TLS_V1_2 (com.vmware.nsx_policy.model_client.LbHttpSslCondition attribute) +
            • +
          • USED_SSL_CIPHER_ECDH_ECDSA_WITH_AES_128_CBC_SHA (com.vmware.nsx_policy.model_client.LbHttpSslCondition attribute) +
            • +
          • USED_SSL_CIPHER_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 (com.vmware.nsx_policy.model_client.LbHttpSslCondition attribute) +
            • +
          • USED_SSL_CIPHER_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 (com.vmware.nsx_policy.model_client.LbHttpSslCondition attribute) +
            • +
          • USED_SSL_CIPHER_ECDH_ECDSA_WITH_AES_256_CBC_SHA (com.vmware.nsx_policy.model_client.LbHttpSslCondition attribute) +
            • +
          • USED_SSL_CIPHER_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 (com.vmware.nsx_policy.model_client.LbHttpSslCondition attribute) +
            • +
          • USED_SSL_CIPHER_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 (com.vmware.nsx_policy.model_client.LbHttpSslCondition attribute) +
            • +
          • USED_SSL_CIPHER_ECDH_RSA_WITH_AES_128_CBC_SHA (com.vmware.nsx_policy.model_client.LbHttpSslCondition attribute) +
            • +
          • USED_SSL_CIPHER_ECDH_RSA_WITH_AES_128_CBC_SHA256 (com.vmware.nsx_policy.model_client.LbHttpSslCondition attribute) +
            • +
          • USED_SSL_CIPHER_ECDH_RSA_WITH_AES_128_GCM_SHA256 (com.vmware.nsx_policy.model_client.LbHttpSslCondition attribute) +
            • +
          • USED_SSL_CIPHER_ECDH_RSA_WITH_AES_256_CBC_SHA (com.vmware.nsx_policy.model_client.LbHttpSslCondition attribute) +
            • +
          • USED_SSL_CIPHER_ECDH_RSA_WITH_AES_256_CBC_SHA384 (com.vmware.nsx_policy.model_client.LbHttpSslCondition attribute) +
            • +
          • USED_SSL_CIPHER_ECDH_RSA_WITH_AES_256_GCM_SHA384 (com.vmware.nsx_policy.model_client.LbHttpSslCondition attribute) +
            • +
          • USED_SSL_CIPHER_ECDHE_ECDSA_WITH_AES_128_CBC_SHA (com.vmware.nsx_policy.model_client.LbHttpSslCondition attribute) +
            • +
          • USED_SSL_CIPHER_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 (com.vmware.nsx_policy.model_client.LbHttpSslCondition attribute) +
            • +
          • USED_SSL_CIPHER_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 (com.vmware.nsx_policy.model_client.LbHttpSslCondition attribute) +
            • +
          • USED_SSL_CIPHER_ECDHE_ECDSA_WITH_AES_256_CBC_SHA (com.vmware.nsx_policy.model_client.LbHttpSslCondition attribute) +
            • +
          • USED_SSL_CIPHER_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 (com.vmware.nsx_policy.model_client.LbHttpSslCondition attribute) +
            • +
          • USED_SSL_CIPHER_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 (com.vmware.nsx_policy.model_client.LbHttpSslCondition attribute) +
            • +
          • USED_SSL_CIPHER_ECDHE_RSA_WITH_AES_128_CBC_SHA (com.vmware.nsx_policy.model_client.LbHttpSslCondition attribute) +
            • +
          • USED_SSL_CIPHER_ECDHE_RSA_WITH_AES_128_CBC_SHA256 (com.vmware.nsx_policy.model_client.LbHttpSslCondition attribute) +
            • +
          • USED_SSL_CIPHER_ECDHE_RSA_WITH_AES_128_GCM_SHA256 (com.vmware.nsx_policy.model_client.LbHttpSslCondition attribute) +
            • +
          • USED_SSL_CIPHER_ECDHE_RSA_WITH_AES_256_CBC_SHA (com.vmware.nsx_policy.model_client.LbHttpSslCondition attribute) +
            • +
          • USED_SSL_CIPHER_ECDHE_RSA_WITH_AES_256_CBC_SHA384 (com.vmware.nsx_policy.model_client.LbHttpSslCondition attribute) +
            • +
          • USED_SSL_CIPHER_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (com.vmware.nsx_policy.model_client.LbHttpSslCondition attribute) +
            • +
          • USED_SSL_CIPHER_RSA_WITH_3DES_EDE_CBC_SHA (com.vmware.nsx_policy.model_client.LbHttpSslCondition attribute) +
            • +
          • USED_SSL_CIPHER_RSA_WITH_AES_128_CBC_SHA (com.vmware.nsx_policy.model_client.LbHttpSslCondition attribute) +
            • +
          • USED_SSL_CIPHER_RSA_WITH_AES_128_CBC_SHA256 (com.vmware.nsx_policy.model_client.LbHttpSslCondition attribute) +
            • +
          • USED_SSL_CIPHER_RSA_WITH_AES_128_GCM_SHA256 (com.vmware.nsx_policy.model_client.LbHttpSslCondition attribute) +
            • +
          • USED_SSL_CIPHER_RSA_WITH_AES_256_CBC_SHA (com.vmware.nsx_policy.model_client.LbHttpSslCondition attribute) +
            • +
          • USED_SSL_CIPHER_RSA_WITH_AES_256_CBC_SHA256 (com.vmware.nsx_policy.model_client.LbHttpSslCondition attribute) +
            • +
          • USED_SSL_CIPHER_RSA_WITH_AES_256_GCM_SHA384 (com.vmware.nsx_policy.model_client.LbHttpSslCondition attribute) +
          • UserInfo (class in com.vmware.nsx_policy.aaa_client)
            •     - com.vmware.nsx_policy.infra.domains.edge_communication_maps_client + com.vmware.nsx_policy.infra.domains.gateway_policies_client
                com.vmware.nsx_policy.infra.domains.groups
                + com.vmware.nsx_policy.infra.domains.groups.members_client +
                @@ -272,78 +276,18 @@
                - com.vmware.nsx_policy.infra.domains.redirection_communication_maps_client + com.vmware.nsx_policy.infra.domains.redirection_policies_client
                com.vmware.nsx_policy.infra.domains_client
                - com.vmware.nsx_policy.infra.networks -
                - com.vmware.nsx_policy.infra.networks.nat_client -
                - com.vmware.nsx_policy.infra.networks.segments_client -
                - com.vmware.nsx_policy.infra.networks_client -
                com.vmware.nsx_policy.infra.partner_services_client
                - com.vmware.nsx_policy.infra.providers -
                - com.vmware.nsx_policy.infra.providers.bgp_client -
                - com.vmware.nsx_policy.infra.providers.l2vpn_context -
                - com.vmware.nsx_policy.infra.providers.l2vpn_context.l2vpns_client -
                - com.vmware.nsx_policy.infra.providers.l2vpn_context_client -
                - com.vmware.nsx_policy.infra.providers.l3vpns_client -
                - com.vmware.nsx_policy.infra.providers.service_instances_client -
                - com.vmware.nsx_policy.infra.providers_client -
                @@ -404,6 +348,81 @@     com.vmware.nsx_policy.infra.services_client
                + com.vmware.nsx_policy.infra.tier_0s +
                + com.vmware.nsx_policy.infra.tier_0s.locale_services +
                + com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp_client +
                + com.vmware.nsx_policy.infra.tier_0s.locale_services.byod_service_instances_client +
                + com.vmware.nsx_policy.infra.tier_0s.locale_services.endpoints_client +
                + com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context +
                + com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.l2vpns_client +
                + com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context_client +
                + com.vmware.nsx_policy.infra.tier_0s.locale_services.l3vpns_client +
                + com.vmware.nsx_policy.infra.tier_0s.locale_services_client +
                + com.vmware.nsx_policy.infra.tier_0s_client +
                + com.vmware.nsx_policy.infra.tier_1s +
                + com.vmware.nsx_policy.infra.tier_1s.nat_client +
                + com.vmware.nsx_policy.infra.tier_1s.segments_client +
                + com.vmware.nsx_policy.infra.tier_1s_client +
                @@ -424,6 +443,11 @@     com.vmware.nsx_policy.tasks_client
                + com.vmware.nsx_policy.telemetry_client +
                @@ -439,6 +463,11 @@     com.vmware.nsx_policy_client
                + com.vmware.nsx_policy_client_for_vmc +
            @@ -452,7 +481,7 @@

            - © Copyright 2018, VMware, Inc.. + © Copyright 2018, VMware, Inc.

            @@ -471,33 +500,22 @@ - - - - + + + + + + + + - - - - + diff --git a/nsx/nsx_policy/search.html b/nsx/nsx_policy/search.html index 5b48ab39..25e87ccf 100644 --- a/nsx/nsx_policy/search.html +++ b/nsx/nsx_policy/search.html @@ -8,7 +8,7 @@ - Search — NSX-T Policy SDK 2.2.0.0.0 documentation + Search — NSX-T Policy SDK 2.3.0.0.1 documentation @@ -24,8 +24,7 @@ - - + @@ -57,7 +56,7 @@
            - 2.2.0.0.0 + 2.3.0.0.1
            @@ -170,7 +169,7 @@

            - © Copyright 2018, VMware, Inc.. + © Copyright 2018, VMware, Inc.

            @@ -189,34 +188,23 @@ - - - - - + + + + + + + + + - - - - + - - - + + + + + + + + - - - - + diff --git a/nsx/vmc_app/com.vmware.html b/nsx/vmc_app/com.vmware.html index 08f38448..27fbdb3d 100644 --- a/nsx/vmc_app/com.vmware.html +++ b/nsx/vmc_app/com.vmware.html @@ -8,7 +8,7 @@ - com.vmware package — NSX-T Policy SDK 2.2.0.0.0 documentation + com.vmware package — NSX-T Policy SDK 2.3.0.0.1 documentation @@ -24,8 +24,7 @@ - - + @@ -59,7 +58,7 @@
            - 2.2.0.0.0 + 2.3.0.0.1
            @@ -91,6 +90,7 @@
          • Subpackages
          • Submodules
          • com.vmware.nsx_vmc_app_client module
            • +
          • com.vmware.nsx_vmc_app_client_for_vmc module
          @@ -170,8 +170,25 @@

          com.vmware.nsx_vmc_app_client module

          -
          -
          -class com.vmware.nsx_vmc_app_client.Accounts(config)
          -

          Bases: vmware.vapi.bindings.stub.VapiInterface

          -
          -
          -get()
          -

          Retrieve the shadow account and linked VPC account information from VMC -provider. This API is a live query to VMC provider.

          - --- - - - - - - - - - - - - - - - -
          Return type:com.vmware.nsx_vmc_app.model_client.VMCAccounts
          Returns:com.vmware.nsx_vmc_app.model.VMCAccounts
          Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable
          Raise:com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed
          Raise:com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error
          Raise:com.vmware.vapi.std.errors_client.Unauthorized -Forbidden
          Raise:com.vmware.vapi.std.errors_client.NotFound -Not Found
          -
          - -
          - -
          -
          -class com.vmware.nsx_vmc_app_client.LinkedVpcs(config)
          -

          Bases: vmware.vapi.bindings.stub.VapiInterface

          -
          -
          -get(linked_vpc_id)
          -

          Get linked VPC information.

          - --- - - - - - - - - - - - - - - - - - -
          Parameters:linked_vpc_id (str) – (required)
          Return type:com.vmware.nsx_vmc_app.model_client.LinkedVpcInfo
          Returns:com.vmware.nsx_vmc_app.model.LinkedVpcInfo
          Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable
          Raise:com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed
          Raise:com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error
          Raise:com.vmware.vapi.std.errors_client.Unauthorized -Forbidden
          Raise:com.vmware.vapi.std.errors_client.NotFound -Not Found
          -
          - -
          -
          -list()
          -

          List linked VPC information.

          - --- - - - - - - - - - - - - - - - -
          Return type:com.vmware.nsx_vmc_app.model_client.LinkedVpcsListResult
          Returns:com.vmware.nsx_vmc_app.model.LinkedVpcsListResult
          Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable
          Raise:com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed
          Raise:com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error
          Raise:com.vmware.vapi.std.errors_client.Unauthorized -Forbidden
          Raise:com.vmware.vapi.std.errors_client.NotFound -Not Found
          -
          - -
          - -
          -
          -class com.vmware.nsx_vmc_app_client.MgmtVms(config)
          -

          Bases: vmware.vapi.bindings.stub.VapiInterface

          -
          -
          -get(vm_id)
          -

          Get management VM access information.

          - --- - - - - - - - - - - - - - - - - - - - -
          Parameters:vm_id (str) – (required)
          Return type:com.vmware.nsx_vmc_app.model_client.MgmtVmInfo
          Returns:com.vmware.nsx_vmc_app.model.MgmtVmInfo
          Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable
          Raise:com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed
          Raise:com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error
          Raise:com.vmware.vapi.std.errors_client.Unauthorized -Forbidden
          Raise:com.vmware.vapi.std.errors_client.NotFound -Not Found
          Raise:com.vmware.vapi.std.errors_client.Error -Error description not available, Error description not available, -Error description not available
          -
          - -
          -
          -list()
          -

          List Management VM information.

          - --- - - - - - - - - - - - - - - - -
          Return type:com.vmware.nsx_vmc_app.model_client.MgmtVmsListResult
          Returns:com.vmware.nsx_vmc_app.model.MgmtVmsListResult
          Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable
          Raise:com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed
          Raise:com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error
          Raise:com.vmware.vapi.std.errors_client.Unauthorized -Forbidden
          Raise:com.vmware.vapi.std.errors_client.NotFound -Not Found
          -
          - -
          - -
          -
          -class com.vmware.nsx_vmc_app_client.PublicIps(config)
          -

          Bases: vmware.vapi.bindings.stub.VapiInterface

          -
          -
          -delete(public_ip_id, force=None)
          -

          Delete a public IP. The IP will be released in VMC provider.

          - --- - - - - - - - - - - - - - -
          Parameters:
            -
          • public_ip_id (str) – (required)
            • -
          • force (bool or None) – Force delete the resource even if it is being used somewhere -(optional, default to false)
            • -
          -
          Raise:

          com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

          -
          Raise:

          com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

          -
          Raise:

          com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

          -
          Raise:

          com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

          -
          Raise:

          com.vmware.vapi.std.errors_client.NotFound -Not Found

          -
          -
          - -
          -
          -get(public_ip_id)
          -

          Get the public IP information.

          - --- - - - - - - - - - - - - - - - - - -
          Parameters:public_ip_id (str) – (required)
          Return type:com.vmware.nsx_vmc_app.model_client.PublicIp
          Returns:com.vmware.nsx_vmc_app.model.PublicIp
          Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable
          Raise:com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed
          Raise:com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error
          Raise:com.vmware.vapi.std.errors_client.Unauthorized -Forbidden
          Raise:com.vmware.vapi.std.errors_client.NotFound -Not Found
          -
          - -
          -
          -list()
          -

          List all public IPs obtained in the SDDC.

          - --- - - - - - - - - - - - - - - - -
          Return type:com.vmware.nsx_vmc_app.model_client.PublicIpsListResult
          Returns:com.vmware.nsx_vmc_app.model.PublicIpsListResult
          Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable
          Raise:com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed
          Raise:com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error
          Raise:com.vmware.vapi.std.errors_client.Unauthorized -Forbidden
          Raise:com.vmware.vapi.std.errors_client.NotFound -Not Found
          -
          - -
          -
          -update(public_ip_id, public_ip)
          -

          This API is used to create or update a public IP. In creating, the API -allocates a new public IP from VMC provider. In updating, only the -display name can be modified, the IP is read-only.

          - --- - - - - - - - - - - - - - - - - - -
          Parameters: -
          Return type:

          com.vmware.nsx_vmc_app.model_client.PublicIp

          -
          Returns:

          com.vmware.nsx_vmc_app.model.PublicIp

          -
          Raise:

          com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

          -
          Raise:

          com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

          -
          Raise:

          com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

          -
          Raise:

          com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

          -
          Raise:

          com.vmware.vapi.std.errors_client.NotFound -Not Found

          -
          -
          - -
          - -
          -
          -class com.vmware.nsx_vmc_app_client.Routes(config)
          -

          Bases: vmware.vapi.bindings.stub.VapiInterface

          -
          -
          -get()
          -

          Retrieve BGP routes that are populated by Direct Connect from VMC -provider. This API is a live query to VMC provider.

          - --- - - - - - - - - - - - - - - - -
          Return type:com.vmware.nsx_vmc_app.model_client.BGPRoutes
          Returns:com.vmware.nsx_vmc_app.model.BGPRoutes
          Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable
          Raise:com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed
          Raise:com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error
          Raise:com.vmware.vapi.std.errors_client.Unauthorized -Forbidden
          Raise:com.vmware.vapi.std.errors_client.NotFound -Not Found
          -
          - -
          - -
          -
          -class com.vmware.nsx_vmc_app_client.SddcUserConfig(config)
          -

          Bases: vmware.vapi.bindings.stub.VapiInterface

          -
          -
          -get()
          -

          Get the user-level SDDC configuration parameters

          - --- - - - - - - - - - - - - - - - -
          Return type:com.vmware.nsx_vmc_app.model_client.SddcUserConfiguration
          Returns:com.vmware.nsx_vmc_app.model.SddcUserConfiguration
          Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable
          Raise:com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed
          Raise:com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error
          Raise:com.vmware.vapi.std.errors_client.Unauthorized -Forbidden
          Raise:com.vmware.vapi.std.errors_client.NotFound -Not Found
          -
          - -
          -
          class com.vmware.nsx_vmc_app_client.StubFactory(stub_config)

          Bases: vmware.vapi.bindings.stub.StubFactoryBase

          +

          Initialize StubFactoryBase

          + +++ + + + +
          Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
          +
          +
          +

          com.vmware.nsx_vmc_app_client_for_vmc module

          +

          Convenience methods to get API clients for NSX APIs in VMC

          -
          -class com.vmware.nsx_vmc_app_client.Vifs(config)
          -

          Bases: vmware.vapi.bindings.stub.VapiInterface

          -
          -
          -CREATE_ACTION_ATTACH = 'ATTACH'
          -

          Possible value for action of method Vifs.create().

          +
          +class com.vmware.nsx_vmc_app_client_for_vmc.CSPSecurityContextFilter(session, refresh_token, refresh_url)
          +

          Bases: vmware.vapi.security.client.security_context_filter.SecurityContextFilter

          +

          CSP Security Context filter in API Provider chain adds the security +context based on a refresh token to the execution context passed in.

          +

          Initialize SecurityContextFilter

          + +++ + + + +
          Parameters:
            +
          • session (requests.Session) – Requests Session object to use for making HTTP calls
            • +
          • refresh_token (str) – Refresh token to use for obtaining an access +token
            • +
          • refresh_url (str) – URL that allows exchanging a refresh token for an +access token
            • +
          +
          +
          +
          +get_max_retries()
          +

          Get the max number of retries

          + +++ + + + + + +
          Return type:int
          Returns:Number of retries
          -
          -create(vif_id, action)
          -

          Perform the attach operation in VMC provider to attach the specified -VIF (Virtual Interface) to the SDDC.

          +
          +get_security_context(on_error)
          +

          Retrieve security context. If this method is called after an error +occured, then a new access token is obtained using the refresh +token and a new security context is created.

          + +++ + + + + + + + +
          Parameters:on_error (bool) – Whether this method is called after getting an error
          Return type:vmware.vapi.core.SecurityContext
          Returns:Security context
          +
          + +
          +
          +should_retry(error_value)
          +

          Returns whether the request should be retried or not based on the error +specified.

          + +++ + + + + + + + +
          Parameters:error_value (vmware.vapi.data.value.ErrorValue) – Method error
          Return type:bool
          Returns:Returns True if request should be retried in case the error is +either Unauthenticated or Unauthorized else False
          +
          + +
          + +
          +
          +class com.vmware.nsx_vmc_app_client_for_vmc.VmcNsxClient(stub_factory_class, session, refresh_token, vmc_url, csp_url, org_id, sddc_id)
          +

          Bases: vmware.vapi.bindings.stub.ApiClient

          +

          Client class that providess access to stubs for all the services in the +VMC NSX API

          +

          Initialize VmcClient by creating a stub factory instance using a CSP +Security context filter added to the filter chain of the connector

          + +++ + + + +
          Parameters:
            +
          • stub_factory_class (type) – Which stub factory class to use
            • +
          • session (requests.Session) – Requests HTTP session instance
            • +
          • refresh_token (str) – Refresh token obtained from CSP
            • +
          • vmc_url (str) – URL of the VMC service
            • +
          • csp_url (str) – URL of the CSP service
            • +
          • org_id (str) – ID of the VMC organization
            • +
          • sddc_id (str) – ID of the VMC Software-Defined Data Center (SDDC)
            • +
          +
          +
          + +
          +
          +com.vmware.nsx_vmc_app_client_for_vmc.create_nsx_vmc_app_client_for_vmc(refresh_token, org_id, sddc_id, session=None)
          +

          Helper method to create an instance of the VMC NSX VMC app API client

          - - - - - - - -
          Parameters:
            -
          • vif_id (str) – (required)
            • -
          • action (str) – Direct Connect VIF (Virtual Interface) action (required)
            • +
          • refresh_token (str) – Refresh token obtained from CSP
            • +
          • org_id (str) – ID of the VMC organization
            • +
          • sddc_id (str) – ID of the VMC Software-Defined Data Center (SDDC)
            • +
          • session (requests.Session or None) – Requests HTTP session instance. If not specified, then one +is automatically created and used
          Raise:

          com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable

          +
          Return type:

          vmware.vapi.vmc.client.VmcNsxClient
          Raise:

          com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed

          -
          Raise:

          com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error

          -
          Raise:

          com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

          -
          Raise:

          com.vmware.vapi.std.errors_client.NotFound -Not Found

          +
          Returns:

          VMC NSX Client instance
          -
          -
          -delete(vif_id)
          -

          Detach and delete a Direct Connect VIF (Virtual Interface) from the -SDDC. Detach and delete are one operation in VMC provider, a Direct -Connect VIF will be deleted after detached.

          - --- - - - - - - - - - - - - - -
          Parameters:vif_id (str) – (required)
          Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable
          Raise:com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed
          Raise:com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error
          Raise:com.vmware.vapi.std.errors_client.Unauthorized -Forbidden
          Raise:com.vmware.vapi.std.errors_client.NotFound -Not Found
          -
          - -
          -
          -list()
          -

          Return all non-connected VIFs (with states "avalible", -"down", "pending" and "confirming") and -connected VIFs that are available to the SDDC.

          - --- - - - - - - - - - - - - - - - -
          Return type:com.vmware.nsx_vmc_app.model_client.VifsListResult
          Returns:com.vmware.nsx_vmc_app.model.VifsListResult
          Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable -Service Unavailable
          Raise:com.vmware.vapi.std.errors_client.InvalidRequest -Bad Request, Precondition Failed
          Raise:com.vmware.vapi.std.errors_client.InternalServerError -Internal Server Error
          Raise:com.vmware.vapi.std.errors_client.Unauthorized -Forbidden
          Raise:com.vmware.vapi.std.errors_client.NotFound -Not Found
          -
          - -
          -
          @@ -739,7 +376,7 @@ Not Found
          - + - + +
          Parameters:linked_vpc_id (str) – linked vpc id (required)
          Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
          Return type:com.vmware.nsx_vmc_app.model_client.ConnectedServiceListResult
          +
          +
          +get()
          +

          Retrieve the shadow account and linked VPC account information from VMC +provider. This API is a live query to VMC provider.

          + +++ + - + + + + + + + + + + + + + +
          Return type:com.vmware.nsx_vmc_app.model_client.VMCAccounts
          Returns:com.vmware.nsx_vmc_app.model.ConnectedServiceListResult
          Returns:com.vmware.nsx_vmc_app.model.VMCAccounts
          Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
          Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
          Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
          Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
          Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
          +
          + + + +
          +
          +class com.vmware.nsx_vmc_app.infra_client.LinkedVpcs(config)
          +

          Bases: vmware.vapi.bindings.stub.VapiInterface

          + +++ + + + +
          Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
          +
          +
          +get(linked_vpc_id)
          +

          Get linked VPC information.

          + +++ + + + + + @@ -210,27 +285,251 @@ Not Found
          -
          -update(linked_vpc_id, service_name, connected_service_status)
          -

          Connect/Disconnect the service to the given linked vpc. For example, -connect S3. The user will know what services are available through the -GET call. If the user is trying to connect/disconnect an unknown -service, the POST call will throw a 400 Bad Request error.

          +
          +list()
          +

          List linked VPC information.

          +
          Parameters:linked_vpc_id (str) – (required)
          Return type:com.vmware.nsx_vmc_app.model_client.LinkedVpcInfo
          Returns:com.vmware.nsx_vmc_app.model.LinkedVpcInfo
          Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
          +++ + + + + + + + + + + + + + + + +
          Return type:com.vmware.nsx_vmc_app.model_client.LinkedVpcsListResult
          Returns:com.vmware.nsx_vmc_app.model.LinkedVpcsListResult
          Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
          Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
          Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
          Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
          Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
          +
          + +
          + +
          +
          +class com.vmware.nsx_vmc_app.infra_client.MgmtVms(config)
          +

          Bases: vmware.vapi.bindings.stub.VapiInterface

          + +++ + + + +
          Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
          +
          +
          +get(vm_id)
          +

          Get management VM access information.

          + +++ + + + + + + + + + + + + + + + + + +
          Parameters:vm_id (str) – (required)
          Return type:com.vmware.nsx_vmc_app.model_client.MgmtVmInfo
          Returns:com.vmware.nsx_vmc_app.model.MgmtVmInfo
          Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
          Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
          Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
          Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
          Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
          +
          + +
          +
          +list()
          +

          List Management VM information.

          + +++ + + + + + + + + + + + + + + + +
          Return type:com.vmware.nsx_vmc_app.model_client.MgmtVmsListResult
          Returns:com.vmware.nsx_vmc_app.model.MgmtVmsListResult
          Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
          Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
          Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
          Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
          Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
          +
          + +
          + +
          +
          +class com.vmware.nsx_vmc_app.infra_client.PublicIps(config)
          +

          Bases: vmware.vapi.bindings.stub.VapiInterface

          + +++ + + + +
          Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
          +
          +
          +delete(public_ip_id, force=None)
          +

          Delete a public IP. The IP will be released in VMC provider.

          - - + + + + + + + + +
          Parameters:
            -
          • linked_vpc_id (str) – linked vpc id (required)
            • -
          • service_name (str) – connected service name, e.g. s3 (required)
            • -
          • connected_service_status (com.vmware.nsx_vmc_app.model_client.ConnectedServiceStatus) – (required)
            • +
          • public_ip_id (str) – (required)
            • +
          • force (bool or None) – Force delete the resource even if it is being used somewhere +(optional, default to false)
          Return type:

          com.vmware.nsx_vmc_app.model_client.ConnectedServiceStatus

          +
          Raise:

          com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
          Returns:

          com.vmware.nsx_vmc_app.model.ConnectedServiceStatus

          +
          Raise:

          com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed

          +
          Raise:

          com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error

          +
          Raise:

          com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

          +
          Raise:

          com.vmware.vapi.std.errors_client.NotFound +Not Found

          +
          +
          + +
          +
          +get(public_ip_id)
          +

          Get the public IP information.

          + +++ + + + + + + + + + + + + + + + + + +
          Parameters:public_ip_id (str) – (required)
          Return type:com.vmware.nsx_vmc_app.model_client.PublicIp
          Returns:com.vmware.nsx_vmc_app.model.PublicIp
          Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
          Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
          Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
          Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
          Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
          +
          + +
          +
          +list()
          +

          List all public IPs obtained in the SDDC.

          + +++ + + + + + + + + + + + + + + + +
          Return type:com.vmware.nsx_vmc_app.model_client.PublicIpsListResult
          Returns:com.vmware.nsx_vmc_app.model.PublicIpsListResult
          Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
          Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
          Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
          Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
          Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
          +
          + +
          +
          +update(public_ip_id, public_ip)
          +

          This API is used to create or update a public IP. In creating, the API +allocates a new public IP from VMC provider. In updating, only the +display name can be modified, the IP is read-only.

          + +++ + + + + +
          Parameters: +
          Return type:

          com.vmware.nsx_vmc_app.model_client.PublicIp

          +
          Returns:

          com.vmware.nsx_vmc_app.model.PublicIp
          Raise:

          com.vmware.vapi.std.errors_client.ServiceUnavailable @@ -260,36 +559,181 @@ Not Found

          -
          -class com.vmware.nsx_vmc_app.linked_vpcs_client.StubFactory(stub_config)
          +
          +class com.vmware.nsx_vmc_app.infra_client.SddcUserConfig(config)
          +

          Bases: vmware.vapi.bindings.stub.VapiInterface

          + +++ + + + +
          Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
          +
          +
          +get()
          +

          Get the user-level SDDC configuration parameters

          + +++ + + + + + + + + + + + + + + + +
          Return type:com.vmware.nsx_vmc_app.model_client.SddcUserConfiguration
          Returns:com.vmware.nsx_vmc_app.model.SddcUserConfiguration
          Raise:com.vmware.vapi.std.errors_client.ServiceUnavailable +Service Unavailable
          Raise:com.vmware.vapi.std.errors_client.InvalidRequest +Bad Request, Precondition Failed
          Raise:com.vmware.vapi.std.errors_client.InternalServerError +Internal Server Error
          Raise:com.vmware.vapi.std.errors_client.Unauthorized +Forbidden
          Raise:com.vmware.vapi.std.errors_client.NotFound +Not Found
          +
          + +
          + +
          +
          +class com.vmware.nsx_vmc_app.infra_client.StubFactory(stub_config)

          Bases: vmware.vapi.bindings.stub.StubFactoryBase

          +

          Initialize StubFactoryBase

          + +++ + + + +
          Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

          com.vmware.nsx_vmc_app.model_client module

          -
          -class com.vmware.nsx_vmc_app.model_client.ApiError(details=None, error_code=None, error_data=None, error_message=None, module_name=None, related_errors=None)
          +
          +class com.vmware.nsx_vmc_app.model_client.AdvertisedRoute(advertisement_state=None, ipv4_cidr=None)

          Bases: vmware.vapi.bindings.struct.VapiStruct

          -

          Detailed information about an API error

          +

          Advertised BGP route

          Tip

          The arguments are used to initialize data attributes with the same names.

          + +++ + + + +
          Parameters: +
          +
          +
          +ADVERTISEMENT_STATE_FAILED = 'FAILED'
          +
          + +
          +
          +ADVERTISEMENT_STATE_SUCCESS = 'SUCCESS'
          +
          +
          -
          -class com.vmware.nsx_vmc_app.model_client.BGPRoutes(bgp_routes=None)
          +
          +class com.vmware.nsx_vmc_app.model_client.ApiError(details=None, error_code=None, error_data=None, error_message=None, module_name=None, related_errors=None)

          Bases: vmware.vapi.bindings.struct.VapiStruct

          -

          BGP routes

          +

          Detailed information about an API Error

          Tip

          The arguments are used to initialize data attributes with the same names.

          + +++ + + + +
          Parameters:
            +
          • details (str or None) – Further details about the error
            • +
          • error_code (long or None) – A numeric error code format: int64
            • +
          • error_data (vmware.vapi.struct.VapiStruct or None) – Additional data about the error
            • +
          • error_message (str or None) – A description of the error
            • +
          • module_name (str or None) – The module name where the error occurred
            • +
          • related_errors (list of RelatedApiError or None) – Other errors related to this error
            • +
          +
          +
          + +
          +
          +class com.vmware.nsx_vmc_app.model_client.BGPAdvertisedRoutes(advertised_routes=None, failed_advertised_routes=None)
          +

          Bases: vmware.vapi.bindings.struct.VapiStruct

          +

          Advertised bgp routes

          +
          +

          Tip

          +

          The arguments are used to initialize data attributes with the same +names.

          +
          + +++ + + + +
          Parameters:
            +
          • advertised_routes (list of AdvertisedRoute or None) – Routes advertised to on-premise datacenter via Direct Connect
            • +
          • failed_advertised_routes (long or None) – Number of routes failed to advertise format: int32
            • +
          +
          +
          + +
          +
          +class com.vmware.nsx_vmc_app.model_client.BGPLearnedRoutes(ipv4_cidr=None)
          +

          Bases: vmware.vapi.bindings.struct.VapiStruct

          +

          Learned bgp routes

          +
          +

          Tip

          +

          The arguments are used to initialize data attributes with the same +names.

          +
          + +++ + + + +
          Parameters:ipv4_cidr (list of str or None) – The route that is learned from BGP via Direct Connect format: +ipv4-cidr-block
          @@ -303,6 +747,39 @@ vpc

          The arguments are used to initialize data attributes with the same names.

          + +++ + + + +
          Parameters:
            +
          • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • self (SelfResourceLink or None) – Link to this resource
            • +
          • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • results (list of ConnectedServiceStatus) – Connected service status list
            • +
          +
          @@ -315,6 +792,43 @@ names.

          The arguments are used to initialize data attributes with the same names.

          + +++ + + + +
          Parameters:
            +
          • enabled (bool or None) – status of service +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • name (str or None) – service name +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          +
          +
          + +
          +
          +class com.vmware.nsx_vmc_app.model_client.DirectConnectBgpInfo(local_as_num=None)
          +

          Bases: vmware.vapi.bindings.struct.VapiStruct

          +

          Direct Connect BGP related information

          +
          +

          Tip

          +

          The arguments are used to initialize data attributes with the same +names.

          +
          + +++ + + + +
          Parameters:local_as_num (str) – The ASN paired with the VGW attached to the VPC. AWS allowed +private BGP ASN range - [64512, 65534] and [4200000000, 4294967294]
          @@ -327,6 +841,31 @@ names.

          The arguments are used to initialize data attributes with the same names.

          + +++ + + + +
          Parameters:
            +
          • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • self (SelfResourceLink or None) – Link to this resource
            • +
          • last_sync_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • description (str or None) – Description of this resource
            • +
          • display_name (str or None) – Defaults to ID if not set
            • +
          • resource_type (str or None) – The type of this resource.
            • +
          • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
            • +
          +
          @@ -339,6 +878,37 @@ names.

          The arguments are used to initialize data attributes with the same names.

          + +++ + + + +
          Parameters:
            +
          • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • self (SelfResourceLink or None) – Link to this resource
            • +
          • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
            • +
          • owner (OwnerResourceLink or None) – Owner of this resource
            • +
          • description (str or None) – Description of this resource
            • +
          • display_name (str or None) – Defaults to ID if not set
            • +
          • id (str or None) – Identifier of the resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • resource_type (str or None) – The type of this resource.
            • +
          +
          @@ -351,6 +921,42 @@ names.

          The arguments are used to initialize data attributes with the same names.

          + +++ + + + +
          Parameters:
            +
          • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • self (SelfResourceLink or None) – Link to this resource
            • +
          • rx_bytes (long or None) – Count of bytes received on this port format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • rx_errors (long or None) – Count of receive errors occurring on this port format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • rx_packets (long or None) – Count of packets received on this port format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • tx_bytes (long or None) – Count of bytes transmitted on this port format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • tx_errors (long or None) – Count of transmit errors occurring on this port format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • tx_packets (long or None) – Count of packets transmitted on this port format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          +
          @@ -362,11 +968,48 @@ names.

          The arguments are used to initialize data attributes with the same names.

          + +++ + + + +
          Parameters:
            +
          • attachment_id (str) – Attachment id which maps to management VM IP
            • +
          • ip (str) – Management VM IP Address format: ipv4
            • +
          +
          +
          + +
          +
          +class com.vmware.nsx_vmc_app.model_client.LinkedSubnetInfo(availability_zone=None, cidr=None, id=None)
          +

          Bases: vmware.vapi.bindings.struct.VapiStruct

          +

          Infromation related to a subnet where linked ENIs were created.

          +
          +

          Tip

          +

          The arguments are used to initialize data attributes with the same +names.

          +
          + +++ + + + +
          Parameters:
            +
          • availability_zone (str) – Linked subnet availability zone
            • +
          • cidr (str) – Linked subnet CIDR format: ipv4-cidr-block
            • +
          • id (str) – Linked subnet identifier
            • +
          +
          -class com.vmware.nsx_vmc_app.model_client.LinkedVpcInfo(arn_role=None, external_id=None, linked_account=None, linked_vpc_addresses=None, linked_vpc_id=None, linked_vpc_nat_ips=None, linked_vpc_subnet_addresses=None, route_table_ids=None, service_arn_role=None)
          +class com.vmware.nsx_vmc_app.model_client.LinkedVpcInfo(active_eni=None, arn_role=None, external_id=None, linked_account=None, linked_vpc_addresses=None, linked_vpc_id=None, linked_vpc_nat_ips=None, linked_vpc_subnets=None, route_table_ids=None, service_arn_role=None)

          Bases: vmware.vapi.bindings.struct.VapiStruct

          Linked VPC info

          @@ -374,6 +1017,27 @@ names.

          The arguments are used to initialize data attributes with the same names.

          + +++ + + + +
          Parameters:
            +
          • active_eni (str or None) – Active network interface used for linked vpc traffic
            • +
          • arn_role (str) – ARN role for linked VPC operations
            • +
          • external_id (str) – External identifier for ARN role
            • +
          • linked_account (str) – Linked VPC account number
            • +
          • linked_vpc_addresses (list of str) – Linked VPC CIDRs format: ipv4-cidr-block
            • +
          • linked_vpc_id (str or None) – Linked VPC identifier
            • +
          • linked_vpc_nat_ips (list of str) – The IPs of linked VPC NAT rule for service access. format: ipv4
            • +
          • linked_vpc_subnets (list of LinkedSubnetInfo) – Infromation related to the subnets where linked ENIs were created.
            • +
          • route_table_ids (list of str) – The identifiers of route tables to be dynamically updated with SDDC +networks
            • +
          • service_arn_role (str or None) – service ARN role
            • +
          +
          @@ -386,6 +1050,39 @@ names.

          The arguments are used to initialize data attributes with the same names.

          + +++ + + + +
          Parameters:
            +
          • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • self (SelfResourceLink or None) – Link to this resource
            • +
          • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • results (list of LinkedVpcInfo or None) – Linked VPCs list
            • +
          +
          @@ -398,6 +1095,38 @@ names.

          The arguments are used to initialize data attributes with the same names.

          + +++ + + + +
          Parameters:
            +
          • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • self (SelfResourceLink or None) – Link to this resource
            • +
          • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          +
          @@ -410,34 +1139,86 @@ names.

          The arguments are used to initialize data attributes with the same names.

          + +++ + + + +
          Parameters:
            +
          • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • self (SelfResourceLink or None) – Link to this resource
            • +
          • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
            • +
          • create_time (long or None) – Timestamp of resource creation format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • create_user (str or None) – ID of the user who created this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • last_modified_time (long or None) – Timestamp of last modification format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • last_modified_user (str or None) – ID of the user who last modified this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • protection (str or None) – Protection status is one of the following: PROTECTED - the client +who retrieved the entity is not allowed to modify it. NOT_PROTECTED +- the client who retrieved the entity is allowed to modify it +REQUIRE_OVERRIDE - the client who retrieved the entity is a super +user and can modify it, but only when providing the request header +X-Allow-Overwrite=true. UNKNOWN - the _protection field could not +be determined for this entity. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • system_owned (bool or None) – Indicates system owned resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • description (str or None) – Description of this resource
            • +
          • display_name (str or None) – Defaults to ID if not set
            • +
          • id (str or None) – Unique identifier of this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • resource_type (str or None) – The type of this resource.
            • +
          • tags (list of Tag or None) – Opaque identifiers meaningful to the API user
            • +
          +
          -class com.vmware.nsx_vmc_app.model_client.MgmtServiceEntry(display_name=None, name=None, path=None, ports=None, resource_type=None)
          +class com.vmware.nsx_vmc_app.model_client.MgmtServiceEntry(display_name=None, path=None)

          Bases: vmware.vapi.bindings.struct.VapiStruct

          -

          Service entry describes the detail of a network service. Either a existing -service path or TCP/UDP/ICMP protocol/ports details could be specified.

          +

          A service entry describes the detail of a network service.

          Tip

          The arguments are used to initialize data attributes with the same names.

          -
          -
          -RESOURCE_TYPE_ICMPENTRY = 'ICMPEntry'
          -
          - -
          -
          -RESOURCE_TYPE_TCPENTRY = 'TCPEntry'
          -
          - -
          -
          -RESOURCE_TYPE_UDPENTRY = 'UDPEntry'
          -
          - + +++ + + + +
          Parameters:
            +
          • display_name (str or None) – Display name for this service
            • +
          • path (str or None) – Service path should refer to a valid service in the system. Service +can be system defined or user defined.
            • +
          +
          @@ -450,6 +1231,27 @@ names.

          The arguments are used to initialize data attributes with the same names.

          + +++ + + + +
          Parameters:
            +
          • display_name (str or None) – Management VM name
            • +
          • group_path (str or None) – For each management VM, a dedicated policy group will be created. +This property will reflect its group path. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • id (str or None) – Management VM identifier +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • ip_attachment_pairs (list of IpAttachmentPair or None) – IP address and attachment id pairs for tagging managment VM
            • +
          • ips (list of str or None) – Local IPs of a management VM format: address-or-block-or-range
            • +
          • services (list of MgmtServiceEntry or None) – Details services path and display name.
            • +
          +
          @@ -462,6 +1264,39 @@ names.

          The arguments are used to initialize data attributes with the same names.

          + +++ + + + +
          Parameters:
            +
          • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • self (SelfResourceLink or None) – Link to this resource
            • +
          • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • results (list of MgmtVmInfo or None) – Management VMs list
            • +
          +
          @@ -475,6 +1310,26 @@ PUT and POST.

          The arguments are used to initialize data attributes with the same names.

          + +++ + + + +
          Parameters:
            +
          • action (str or None) – Optional action +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • href (str or None) – Link to resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • rel (str or None) – Custom relation type (follows RFC 5988 where appropriate +definitions exist) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          +
          @@ -487,6 +1342,20 @@ names.

          The arguments are used to initialize data attributes with the same names.

          + +++ + + + +
          Parameters:
            +
          • display_name (str or None) – Display name +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • prefixes (list of str) – Service IP prefixes format: ipv4-cidr-block
            • +
          +
          @@ -499,6 +1368,39 @@ names.

          The arguments are used to initialize data attributes with the same names.

          + +++ + + + +
          Parameters:
            +
          • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • self (SelfResourceLink or None) – Link to this resource
            • +
          • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • results (list of PrefixInfo or None) – Service Prefixes list
            • +
          +
          @@ -510,6 +1412,23 @@ names.

          The arguments are used to initialize data attributes with the same names.

          + +++ + + + +
          Parameters:
            +
          • display_name (str or None) –
            • +
          • id (str or None) – Public IP identifier +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • ip (str or None) – IPv4 address format: ipv4 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          +
          @@ -522,6 +1441,66 @@ names.

          The arguments are used to initialize data attributes with the same names.

          + +++ + + + +
          Parameters:
            +
          • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • self (SelfResourceLink or None) – Link to this resource
            • +
          • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • results (list of PublicIp or None) – Public IP list
            • +
          +
          +
          + +
          +
          +class com.vmware.nsx_vmc_app.model_client.RelatedApiError(details=None, error_code=None, error_data=None, error_message=None, module_name=None)
          +

          Bases: vmware.vapi.bindings.struct.VapiStruct

          +

          Detailed information about a related API error

          +
          +

          Tip

          +

          The arguments are used to initialize data attributes with the same +names.

          +
          + +++ + + + +
          Parameters:
            +
          • details (str or None) – Further details about the error
            • +
          • error_code (long or None) – A numeric error code format: int64
            • +
          • error_data (vmware.vapi.struct.VapiStruct or None) – Additional data about the error
            • +
          • error_message (str or None) – A description of the error
            • +
          • module_name (str or None) – The module name where the error occurred
            • +
          +
          @@ -534,6 +1513,24 @@ names.

          The arguments are used to initialize data attributes with the same names.

          + +++ + + + +
          Parameters:
            +
          • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • self (SelfResourceLink or None) – Link to this resource
            • +
          +
          @@ -546,6 +1543,26 @@ names.

          The arguments are used to initialize data attributes with the same names.

          + +++ + + + +
          Parameters:
            +
          • action (str or None) – Optional action +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • href (str or None) – Link to resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • rel (str or None) – Custom relation type (follows RFC 5988 where appropriate +definitions exist) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          +
          @@ -558,11 +1575,35 @@ names.

          The arguments are used to initialize data attributes with the same names.

          + +++ + + + +
          Parameters:
            +
          • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • self (SelfResourceLink or None) – Link to this resource
            • +
          • revision (long or None) – The _revision property describes the current revision of the +resource. To prevent clients from overwriting each other’s changes, +PUT operations must include the current _revision of the resource, +which clients should obtain by issuing a GET operation. If the +_revision provided in a PUT request is missing or stale, the +operation will be rejected. format: int32
            • +
          +
          -class com.vmware.nsx_vmc_app.model_client.SddcUserConfiguration(compute_gateway=None, dx_interface_label=None, linked_vpc_interface_label=None, management_gateway=None, mgmt_addresses=None, provider_name=None, public_interface_label=None, sddc_infra_addresses=None, vpn_dx_ips=None, vpn_internet_ips=None)
          +class com.vmware.nsx_vmc_app.model_client.SddcUserConfiguration(all_uplink_interface_label=None, all_vpn_interface_label=None, compute_gateway=None, dx_interface_label=None, linked_vpc_interface_label=None, management_gateway=None, management_gateway_label=None, mgmt_subnet=None, provider_name=None, public_interface_label=None, sddc_infra_subnet=None, vpn_dx_ips=None, vpn_internet_ips=None)

          Bases: vmware.vapi.bindings.struct.VapiStruct

          SDDC configuration parameters for users. User-level addresses/CIDRs are provided.

          @@ -571,6 +1612,29 @@ provided.

          The arguments are used to initialize data attributes with the same names.

          + +++ + + + +
          Parameters:
            +
          • all_uplink_interface_label (str) – All uplink interfaces label name
            • +
          • all_vpn_interface_label (str) – All VPN interfaces label name
            • +
          • compute_gateway (str) – Compute gateway name
            • +
          • dx_interface_label (str) – DirectConnect interface label name
            • +
          • linked_vpc_interface_label (str) – Linked VPC interface label name
            • +
          • management_gateway (str) – Management gateway name
            • +
          • management_gateway_label (str) – Management gateway label name
            • +
          • mgmt_subnet (list of str) – Management VMs CIDRs format: ipv4-cidr-block
            • +
          • provider_name (str) – Provider Name
            • +
          • public_interface_label (str) – Public interface label name
            • +
          • sddc_infra_subnet (list of str) – SDDC Infra CIDRs format: ipv4-cidr-block
            • +
          • vpn_dx_ips (list of str or None) – Local IPs for VPN tunnel over Direct Connect format: ipv4
            • +
          • vpn_internet_ips (list of str or None) – Public IPs for VPN tunnel over internet format: ipv4
            • +
          +
          @@ -584,12 +1648,41 @@ PUT and POST.

          The arguments are used to initialize data attributes with the same names.

          + +++ + + + +
          Parameters:
            +
          • action (str or None) – Optional action +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • href (str or None) – Link to resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • rel (str or None) – Custom relation type (follows RFC 5988 where appropriate +definitions exist) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          +
          class com.vmware.nsx_vmc_app.model_client.StubFactory(stub_config)

          Bases: vmware.vapi.bindings.stub.StubFactoryBase

          +

          Initialize StubFactoryBase

          + +++ + + + +
          Parameters:stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
          @@ -602,6 +1695,18 @@ names.

          The arguments are used to initialize data attributes with the same names.

          + +++ + + + +
          Parameters:
            +
          • scope (str or None) – Tag searches may optionally be restricted by scope
            • +
          • tag (str or None) – Identifier meaningful to user
            • +
          +
          @@ -614,6 +1719,71 @@ names.

          The arguments are used to initialize data attributes with the same names.

          + +++ + + + +
          Parameters:
            +
          • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • self (SelfResourceLink or None) – Link to this resource
            • +
          • async_response_available (bool or None) – True if response for asynchronous request is available +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • cancelable (bool or None) – True if this task can be canceled +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • description (str or None) – Description of the task +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • end_time (long or None) – The end time of the task in epoch milliseconds format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • id (str or None) – Identifier for this task +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • message (str or None) – A message describing the disposition of the task +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • progress (long or None) – Task progress if known, from 0 to 100 format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • request_method (str or None) – HTTP request method +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • request_uri (str or None) – URI of the method invocation that spawned this task +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • start_time (long or None) – The start time of the task in epoch milliseconds format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • status (str or None) –

            Possible values are:

            + +
            +
            Current status of the task
            +

            This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.

            +
            • +
          • user (str or None) – Name of the user who created this task +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          +
          STATUS_CANCELED = 'canceled'
          @@ -656,6 +1826,18 @@ names.

          The arguments are used to initialize data attributes with the same names.

          + +++ + + + +
          Parameters:
            +
          • linked_vpc_account (str or None) – linked VPC account number
            • +
          • shadow_account (str) – Shadow VPC account number
            • +
          +
          @@ -668,6 +1850,39 @@ names.

          The arguments are used to initialize data attributes with the same names.

          + +++ + + + +
          Parameters:
            +
          • links (list of ResourceLink or None) – The server will populate this field when returing the resource. +Ignored on PUT and POST. +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • schema (str or None) – Schema for this resource +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • self (SelfResourceLink or None) – Link to this resource
            • +
          • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied +by current result page) +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • result_count (long or None) – Count of results found (across all pages), set only on first page +format: int64 +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • sort_ascending (bool or None) – If true, results are sorted in ascending order +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • sort_by (str or None) – Field by which records are sorted +This attribute may be present in responses from the server, but if +it is present in a request to server it will be ignored.
            • +
          • results (list of VirtualInterface or None) – VIFs list
            • +
          +
          @@ -679,6 +1894,44 @@ names.

          The arguments are used to initialize data attributes with the same names.

          + +++ + + + +
          Parameters: +
          BGP_STATUS_DOWN = 'DOWN'
          @@ -757,6 +2010,8 @@ names.
          @@ -228,14 +255,16 @@

          D

          @@ -252,21 +281,31 @@

          G

          +

          I

          @@ -284,26 +323,30 @@

          L

          @@ -320,7 +363,7 @@
          • PublicIp (class in com.vmware.nsx_vmc_app.model_client)
            • -
          • PublicIps (class in com.vmware.nsx_vmc_app_client) +
          • PublicIps (class in com.vmware.nsx_vmc_app.infra_client)
          • PublicIpsListResult (class in com.vmware.nsx_vmc_app.model_client)
            • @@ -356,21 +399,15 @@

            R

            @@ -378,11 +415,13 @@

            S

            - + + + + + + + + + + + + + + + + @@ -189,6 +213,11 @@ + + +
                - com.vmware.nsx_vmc_app.linked_vpcs_client + com.vmware.nsx_vmc_app.infra +
                + com.vmware.nsx_vmc_app.infra.direct_connect +
                + com.vmware.nsx_vmc_app.infra.direct_connect.routes_client +
                + com.vmware.nsx_vmc_app.infra.direct_connect_client +
                + com.vmware.nsx_vmc_app.infra.linked_vpcs_client +
                + com.vmware.nsx_vmc_app.infra_client
                com.vmware.nsx_vmc_app_client
                + com.vmware.nsx_vmc_app_client_for_vmc +
            @@ -202,7 +231,7 @@

            - © Copyright 2018, VMware, Inc.. + © Copyright 2018, VMware, Inc.

            @@ -221,33 +250,22 @@ - - - - + + + + + + + + - - - - + diff --git a/nsx/vmc_app/search.html b/nsx/vmc_app/search.html index 5b48ab39..25e87ccf 100644 --- a/nsx/vmc_app/search.html +++ b/nsx/vmc_app/search.html @@ -8,7 +8,7 @@ - Search — NSX-T Policy SDK 2.2.0.0.0 documentation + Search — NSX-T Policy SDK 2.3.0.0.1 documentation @@ -24,8 +24,7 @@ - - + @@ -57,7 +56,7 @@
            - 2.2.0.0.0 + 2.3.0.0.1
            @@ -170,7 +169,7 @@

            - © Copyright 2018, VMware, Inc.. + © Copyright 2018, VMware, Inc.

            @@ -189,34 +188,23 @@ - - - - - + + + + + + + + + - - - - +