Source or Destination for firewall rule. Default is ‘any’.
-
-
Tip
-
The arguments are used to initialize data attributes with the same
-names.
-
-
-
Parameters
-
-
exclude (bool or None) – Exclude the specified source or destination.
-
ip_address (list of str or None) – List of string. Can specify single IP address, range of IP address,
-or in CIDR format. Can define multiple.
-
grouping_object_id (list of str or None) – List of string. Id of cluster, datacenter, distributedPortGroup,
-legacyPortGroup, VirtualMachine, vApp, resourcePool, logicalSwitch,
-IPSet, securityGroup. Can define multiple.
-
vnic_group_id (list of str or None) – List of string. Possible values are vnic-index-[1-9], vse, external
-or internal. Can define multiple.
The arguments are used to initialize data attributes with the same
-names.
-
-
-
Parameters
-
-
data_store_moid_of_active_vse (str or None) – vCenter MOID of the active NSX Edge appliance’s data store.
-
enable_fips (bool or None) – Value is true if FIPS is enabled on NSX Edge appliance.
-
host_name_of_active_vse (str or None) – Host name of the active NSX Edge appliance.
-
vm_build_info (str or None) – NSX Edge appliance build version.
-
deploy_appliances (bool or None) – Value is true if NSX Edge appliances are to be deployed.
-
communication_channel (str or None) – Communication channel used to communicate with NSX Edge appliance.
-
vm_name_of_active_vse (str or None) – Name of the active NSX Edge appliance.
-
number_of_deployed_vms (long or None) – Number of deployed appliances of the NSX Edge. format: int32
-
resource_pool_moid_of_active_vse (str or None) – vCenter MOID of the active NSX Edge appliance’s resource
-pool/cluster. Can be resource pool ID, e.g. resgroup-15 or cluster
-ID, e.g. domain-c41.
-
data_store_name_of_active_vse (str or None) – Datastore name of the active NSX Edge appliance.
-
vm_moid_of_active_vse (str or None) – vCenter MOID of the active NSX Edge appliance.
-
status_from_vse_updated_on (long or None) – Time stamp value when healthcheck status was last updated for the
-NSX Edge appliance. format: int64
-
fqdn (str or None) – FQDN of the NSX Edge.
-
appliance_size (str or None) – NSX Edge appliance size.
-
resource_pool_name_of_active_vse (str or None) – Resource Pool/Cluster name of the active NSX Edge appliance.
-
active_vse_ha_index (long or None) – HA index of the active NSX Edge appliance. format: int32
-
vm_version (str or None) – NSX Edge appliance version.
-
host_moid_of_active_vse (str or None) – vCenter MOID of the active NSX Edge appliance’s host.
listeners (DnsListeners or None) – List of DNS listeners.
-
version (long or None) – Version number tracking each configuration change. To avoid
-problems with overwriting changes, always retrieve and modify the
-latest configuration to include the current version number in your
-request. If you provide a version number which is not current, the
-request is rejected. If you omit the version number, the request is
-accepted but may overwrite any current changes if your change is
-not in sync with the latest change. format: int64
-
template (str or None) –
-
cache_size (long or None) – The cache size of the DNS service. format: int64
The arguments are used to initialize data attributes with the same
-names.
-
-
-
Parameters
-
-
name (str) – Name of the DNS view.
-
view_match (DnsViewMatch or None) – Rules that match the DNS query to this view. The rule can be
-ipAddress, or ipSet. Defaults to ipAddress ‘any’ and ‘any’ vnic.
-
recursion (bool or None) – Recursion enabled on DNS view.
-
view_id (str or None) – Identifier for the DNS view.
-
forwarders (DnsForwarders or None) – DNS forwarders.
The arguments are used to initialize data attributes with the same
-names.
-
-
-
Parameters
-
-
pre_rules_exists (bool or None) – Value is true if pre rules publish is enabled.
-
feature_statuses (list of FeatureStatus or None) – Individual feature status.
-
timestamp (long or None) – Timestamp value at which the NSX Edge healthcheck was done. format:
-int64
-
publish_status (str or None) – Status of the latest configuration change for the NSX Edge. Values
-are APPLIED or PERSISTED (not published to NSX Edge Appliance yet).
-
last_published_pre_rules_generation_number (long or None) – Value of the last published pre rules generation number. format:
-int64
-
version (long or None) – Version number of the current configuration. format: int64
-
edge_vm_status (list of EdgeVmStatus or None) – Detailed status of each of the deployed NSX Edge appliances.
-
active_vse_ha_index (long or None) – Index of the active NSX Edge appliance. Values are 0 and 1. format:
-int32
-
system_status (str or None) – System status of the active NSX Edge appliance.
-
ha_vnic_in_use (long or None) – Index of the vnic consumed for NSX Edge HA. format: int32
-
edge_status (str or None) – NSX Edge appliance health status identified by GREY (unknown
-status), GREEN (health checks are successful), YELLOW (intermittent
-health check failure), RED (none of the appliances are in serving
-state). If health check fails for 5 consecutive times for all
-appliance (2 for HA else 1) then status will turn from YELLOW to
-RED.
The arguments are used to initialize data attributes with the same
-names.
-
-
-
Parameters
-
-
feature_capabilities (FeatureCapabilities or None) – List of Features and their capability details based on Edge
-appliance form factor.
-
edge_type (str or None) – NSX Edge type, whether ‘gatewayServices’ or ‘distributedRouter’.
-
logical_router_scopes (LogicalRouterScopes or None) – Backing type scope (DistributedVirtualSwitch - VLAN, TransportZone
--VXLAN) and its ID for the Distributed Logical Router.
-
recent_job_info (EdgeJob or None) – Job information for the most recent configuration change carried
-out on the NSX Edge.
-
hypervisor_assist (bool or None) –
-
edge_assist_id (long or None) – ID generated by NSX Manager for Distributed Logical Router only.
-format: int64
-
edge_status (str or None) – NSX Edge appliance health status identified by GREY (unknown
-status), GREEN (health checks are successful), YELLOW (intermittent
-health check failure), RED (none of the appliances are in serving
-state). If health check fails for 5 consecutive times for all
-appliance (2 for HA else 1) then status will turn from YELLOW to
-RED.
-
edge_assist_instance_name (str or None) – Name derived by NSX Manager only for Distributed Logical Router.
-
object_id (str or None) –
-
node_id (str or None) –
-
id (str or None) – NSX Edge ID.
-
datacenter_name (str or None) – Datacenter name where the NSX Edge is deployed.
-
state (str or None) – Deployment state of the NSX Edge appliance. Values are ‘deployed’
-when VMs have been deployed, ‘undeployed’ when no VMs are deployed
-and ‘active’ when Edge type is Distributed Logical Router and has
-no appliance deployed but is serving data path.
local_egress_enabled (bool or None) – Value is true if local egress is enabled for UDLR traffic.
-Applicable only for Universal Distributed Logical Router.
-
universal_revision (long or None) –
-
allowed_actions (list of str or None) –
-
object_type_name (str or None) –
-
is_upgrade_available (bool or None) – Value is true if NSX Edge upgrade is available.
-
is_universal (bool or None) –
-
name (str or None) –
-
lrouter_uuid (str or None) – Distributed Logical Router UUID provided by the NSX Controller.
-
appliances_summary (AppliancesSummary or None) – NSX Edge appliance summary.
-
api_version (str or None) – REST API version applicable for the NSX Edge.
-
tenant_id (str or None) – Tenant ID for the NSX Edge.
-
datacenter_moid (str or None) – vCenter MOID of the datacenter where the NSX Edge is deployed.
-
number_of_connected_vnics (long or None) – Number of connected vnics that are configured on the NSX Edge.
-format: int32
Status of each of the deployed NSX Edge appliances.
-
-
Tip
-
The arguments are used to initialize data attributes with the same
-names.
-
-
-
Parameters
-
-
index (long or None) – High Availability index of the appliance. Values are 0 and 1.
-format: int32
-
ha_state (str or None) – High Availability state of the appliance. Values are active and
-standby.
-
name (str or None) – Name of the NSX Edge appliance.
-
id (str or None) – vCenter MOID of the NSX Edge appliance.
-
edge_vm_status (str or None) – NSX Edge appliance health status identified by GREY (unknown
-status), GREEN (health checks are successful), YELLOW (intermittent
-health check failure), RED (appliance not in serving state).
-
pre_rules_generation_number (long or None) – Value of the last published pre rules generation number. format:
-int64
NSX Edge vnic address group configuration details.
-
-
Tip
-
The arguments are used to initialize data attributes with the same
-names.
-
-
-
Parameters
-
address_groups (list of EdgeVnicAddressGroup or None) – Address group configuration of the NSX Edge vnic. Vnic can be
-configured to have more than one address group/subnets.
-
-
-
-
class com.vmware.vmc.model_client.EniInfo(subnet_id=None, id=None, security_group_id=None, private_ip=None, mac_address=None)¶
@@ -2182,12 +1425,12 @@ names.
Parameters
-
storage_capacity_gib (long or None) –
-
memory_capacity_gib (long or None) –
-
total_number_of_cores (long or None) –
-
number_of_ssds (long or None) –
-
cpu_capacity_ghz (float or None) –
-
number_of_sockets (long or None) –
+
storage_capacity_gib (long or None) – The storage capacity for the given entity in GiB.
+
memory_capacity_gib (long or None) – The memory capacity for the given entity in GiB.
+
total_number_of_cores (long or None) – The number of CPU cores for the given entity.
+
number_of_ssds (long or None) – The number of SSDs for the given entity.
+
cpu_capacity_ghz (float or None) – The CPU capacity for the given entity in Ghz.
+
number_of_sockets (long or None) – The number of sockets for the given entity.
The arguments are used to initialize data attributes with the same
-names.
-
-
-
Parameters
-
-
firewall_rules (FirewallRules or None) – Ordered list of firewall rules.
-
feature_type (str or None) –
-
version (long or None) – Version number tracking each configuration change. To avoid
-problems with overwriting changes, always retrieve and modify the
-latest configuration to include the current version number in your
-request. If you provide a version number which is not current, the
-request is rejected. If you omit the version number, the request is
-accepted but may overwrite any current changes if your change is
-not in sync with the latest change. format: int64
-
template (str or None) –
-
global_config (FirewallGlobalConfig or None) – Global configuration applicable to all rules.
-
enabled (bool or None) – Value is true if feature is enabled. Default value is true.
-Optional.
The arguments are used to initialize data attributes with the same
-names.
-
-
-
Parameters
-
-
tcp_allow_out_of_window_packets (bool or None) – Allow TCP out of window packets.
-
udp_timeout (long or None) – UDP timeout close. format: int32
-
ip_generic_timeout (long or None) – IP generic timeout. format: int32
-
tcp_pick_ongoing_connections (bool or None) – Pick TCP ongoing connections.
-
tcp_timeout_open (long or None) – TCP timeout open. format: int32
-
tcp_timeout_close (long or None) – TCP timeout close. format: int32
-
icmp6_timeout (long or None) – ICMP6 timeout. format: int32
-
drop_icmp_replays (bool or None) – Drop icmp replays.
-
log_icmp_errors (bool or None) – Log icmp errors.
-
tcp_send_reset_for_closed_vse_ports (bool or None) – Send TCP reset for closed NSX Edge ports.
-
drop_invalid_traffic (bool or None) – Drop invalid traffic.
-
enable_syn_flood_protection (bool or None) – Protect against SYN flood attacks by detecting bogus TCP
-connections and terminating them without consuming firewall state
-tracking resources. Default : false
-
icmp_timeout (long or None) – ICMP timeout. format: int32
-
tcp_timeout_established (long or None) – TCP timeout established. format: int32
-
log_invalid_traffic (bool or None) – Log invalid traffic.
The arguments are used to initialize data attributes with the same
-names.
-
-
-
Parameters
-
-
feature_type (str or None) –
-
logging (Logging or None) – Configure logging for the feature on NSX Edge appliance. Logging is
-disabled by default. Optional.
-
global (IpsecGlobalConfig or None) – IPsec Global configuration details.
-
enabled (bool or None) – Value is true if feature is enabled. Default value is true.
-Optional.
-
sites (IpsecSites or None) – IPsec Site configuration details.
-
disable_event (bool or None) – Enable/disable event generation on NSX Edge appliance for IPsec.
-
version (long or None) – Version number tracking each configuration change. To avoid
-problems with overwriting changes, always retrieve and modify the
-latest configuration to include the current version number in your
-request. If you provide a version number which is not current, the
-request is rejected. If you omit the version number, the request is
-accepted but may overwrite any current changes if your change is
-not in sync with the latest change. format: int64
The arguments are used to initialize data attributes with the same
-names.
-
-
-
Parameters
-
-
psk (str or None) – IPsec Global Pre Shared Key. Maximum characters is 128. Required
-when peerIp is configured as ‘any’ in NSX Edge IPsec Site
-configuration.
-
ca_certificates (CaCertificates or None) – CA certificate list. Optional.
-
service_certificate (str or None) – Certificate name or identifier. Required when x.509 is selected as
-the authentication mode.
-
crl_certificates (CrlCertificates or None) – CRL certificate list. Optional.
The arguments are used to initialize data attributes with the same
-names.
-
-
-
Parameters
-
-
psk (str or None) – Pre Shared Key for the IPsec Site. Required if Site peerIp is not
-‘any’. Global PSK is used when Authentication mode is PSK and Site
-peerIp is ‘any’.
-
local_id (str or None) – Local ID of the IPsec Site. Defaults to the local IP.
-
enable_pfs (bool or None) – Enable/disable Perfect Forward Secrecy. Default is true.
-
authentication_mode (str or None) – Authentication mode for the IPsec Site. Valid values are psk and
-x.509, with psk as default.
-
peer_subnets (Subnets or None) – Peer subnets for which IPsec VPN is configured.
-
dh_group (str or None) – Diffie-Hellman algorithm group. Defaults to DH14 for FIPS enabled
-NSX Edge. DH2 and DH5 are not supported when FIPS is enabled on NSX
-Edge. Valid values are DH2, DH5, DH14, DH15, DH16.
-
site_id (str or None) – ID of the IPsec Site configuration provided by NSX Manager.
-
description (str or None) – Description of the IPsec Site.
-
peer_ip (str or None) – IP (IPv4) address or FQDN of the Peer. Can also be specified as
-‘any’. Required.
-
name (str or None) – Name of the IPsec Site.
-
certificate (str or None) –
-
local_ip (str or None) – Local IP of the IPsec Site. Should be one of the IP addresses
-configured on the uplink interfaces of the NSX Edge. Required.
-
encryption_algorithm (str or None) – IPsec encryption algorithm with default as aes256. Valid values are
-‘aes’, ‘aes256’, ‘3des’, ‘aes-gcm’.
-
enabled (bool or None) – Enable/disable IPsec Site.
-
mtu (long or None) – MTU for the IPsec site. Defaults to the mtu of the NSX Edge vnic
-specified by the localIp. Optional. format: int32
-
extension (str or None) –
-
peer_id (str or None) – Peer ID. Should be unique for all IPsec Site’s configured for an
-NSX Edge.
-
local_subnets (Subnets or None) – Local subnets for which IPsec VPN is configured.
The arguments are used to initialize data attributes with the same
@@ -3777,21 +2197,58 @@ names.
Parameters
-
rules (NatRules or None) – Ordered list of NAT rules.
-
feature_type (str or None) –
-
version (long or None) – Version number tracking each configuration change. To avoid
-problems with overwriting changes, always retrieve and modify the
-latest configuration to include the current version number in your
-request. If you provide a version number which is not current, the
-request is rejected. If you omit the version number, the request is
-accepted but may overwrite any current changes if your change is
-not in sync with the latest change. format: int64
-
enabled (bool or None) – Value is true if feature is enabled. Default value is true.
-Optional.
The arguments are used to initialize data attributes with the same
-names.
-
-
-
Parameters
-
-
vnic (str or None) – Interface on which the NAT rule is applied.
-
rule_type (str or None) – Identifies the type of the rule. internal_high or user.
-
protocol (str or None) – Protocol. Default is ‘any’
-
description (str or None) – Description for the rule.
-
rule_id (long or None) – Identifier for the rule. format: int64
-
snat_match_destination_port (str or None) – Apply SNAT rule only if traffic has this destination port. Default
-is ‘any’.
-
original_address (str or None) – Original address or address range. This is the original source
-address for SNAT rules and the original destination address for
-DNAT rules.
-
dnat_match_source_address (str or None) – Apply DNAT rule only if traffic has this source address. Default is
-‘any’.
-
dnat_match_source_port (str or None) – Apply DNAT rule only if traffic has this source port. Default is
-‘any’.
-
snat_match_destination_address (str or None) – Apply SNAT rule only if traffic has this destination address.
-Default is ‘any’.
-
original_port (str or None) – Original port. This is the original source port for SNAT rules, and
-the original destination port for DNAT rules.
-
logging_enabled (bool or None) – Enable logging for the rule.
-
translated_address (str or None) – Translated address or address range.
-
enabled (bool or None) – Enable rule.
-
icmp_type (str or None) – ICMP type. Only supported when protocol is icmp. Default is ‘any’.
-
translated_port (str or None) – Translated port. Supported in DNAT rules only.
-
action (str or None) – Action for the rule. SNAT or DNAT.
-
rule_tag (long or None) – Rule tag. Used to specify user-defined ruleId. If not specified NSX
-Manager will generate ruleId. format: int64
The arguments are used to initialize data attributes with the same
-names.
-
-
-
Parameters
-
-
secure_traffic (bool or None) – Secure L2VPN traffic.
-
site_id (str or None) – Identifier for L2 VPN site.
-
name (str or None) – Name of L2 VPN site. Length: 1-255 characters.
-
password (str or None) – Password for L2 VPN user. Passwords must contain the following:
-12-63 characters, a mix of upper case letters, lower case letters,
-numbers, and at least one special character. Password must not
-contain the username as a substring. Do not repeat a character 3 or
-more times.
-
user_id (str or None) – L2 VPN user ID. Valid user names: 1-63 characters, letters and
-numbers only. No white space or special characters.
-
description (str or None) – Description of L2 VPN site.
-
-
-
-
-
class com.vmware.vmc.model_client.NsxtAddons(enable_nsx_advanced_addon=None)¶
NSX Edge sub interface configuration details. Sub interfaces are created on
-a trunk interface.
-
-
Tip
-
The arguments are used to initialize data attributes with the same
-names.
-
-
-
Parameters
-
-
index (long or None) – Index of the sub interface assigned by NSX Manager. Min value is 10
-and max value is 4103. format: int32
-
tunnel_id (long) – Valid values for tunnel ID are min 1 to max 4093. Required. format:
-int32
-
name (str or None) – Name of the sub interface. Required.
-
address_groups (EdgeVnicAddressGroups or None) – Address group configuration of the sub interface.
-
vlan_id (long or None) – VLAN ID of the virtual LAN used by this sub interface. VLAN IDs can
-range from 0 to 4094. format: int32
-
label (str or None) – Sub interface label of format vNic_{index} provided by NSX Manager.
-Read only.
-
logical_switch_name (str or None) – Name of the logical switch connected to this sub interface.
-
is_connected (bool or None) – Value is true if the sub interface is connected to a logical
-switch, standard portgroup or distributed portgroup.
-
mtu (long or None) – MTU value of the sub interface. This value would be the least mtu
-for all the trunk interfaces of the NSX Edge. Default is 1500.
-format: int32
-
logical_switch_id (str or None) – ID of the logical switch connected to this sub interface.
-
enable_send_redirects (bool or None) – Value is true if send redirects is enabled. Enable ICMP redirect to
-convey routing information to hosts.
The arguments are used to initialize data attributes with the same
-names.
-
-
-
Parameters
-
subnets (list of str or None) – List of subnets for which IPsec VPN is configured. Subnets should
-be network address specified in CIDR format and can accept
-‘0.0.0.0/0’ (any)
label (str or None) – Interface label of format vNic_{vnicIndex} provided by NSX Manager.
-Read only.
-
enable_proxy_arp (bool or None) – Value is true if proxy arp is enabled. Enable proxy ARP if you want
-to allow the NSX Edge of type ‘gatewayServices’ to answer ARP
-requests intended for other machines.
-
index (long) – Index of the vnic. Min value is 0 and max value is 9. format: int32
-
name (str or None) – Name of the interface. Optional.
-
mtu (long or None) – MTU of the interface, with default as 1500. Min is 68, Max is 9000.
-Optional. format: int32
portgroup_name (str or None) – Name of the port group or logical switch.
-
enable_bridge_mode (bool or None) – Value is true if bridge mode is enabled.
-
type (str or None) – Type of the vnic. Values are uplink, internal, trunk. At least one
-internal interface must be configured for NSX Edge HA to work.
-
portgroup_id (str or None) – Value are port group ID (standard portgroup or distributed
-portgroup) or virtual wire ID (logical switch). Logical switch
-cannot be used for a TRUNK vnic. Portgroup cannot be shared among
-vnics/LIFs. Required when isConnected is specified as true. Example
-‘network-17’ (standard portgroup), ‘dvportgroup-34’ (distributed
-portgroup) or ‘virtualwire-2’ (logical switch).
validate_only (bool or None) – When true, only validates the given sddc configuration without
provisioning. (optional)
@@ -7152,8 +5157,8 @@ Forbidden
Parameters
-
org (str) – Organization identifier. (required)
-
sddc (str) – Sddc Identifier. (required)
+
org (str) – Organization identifier (required)
+
sddc (str) – Sddc identifier (required)
retain_configuration (bool or None) – If = ‘true’, the SDDC’s configuration is retained as a template for
later use. This flag is applicable only to SDDCs in ACTIVE state.
(optional)
@@ -7197,8 +5202,8 @@ Cannot find the SDDC with given identifier
Parameters
-
org (str) – Organization identifier. (required)
-
sddc (str) – Sddc Identifier. (required)
+
org (str) – Organization identifier (required)
+
sddc (str) – Sddc identifier (required)
Return type
@@ -7229,7 +5234,7 @@ Cannot find the SDDC with given identifier
Parameters
-
org (str) – Organization identifier. (required)
+
org (str) – Organization identifier (required)
include_deleted (bool or None) – When true, forces the result to also include deleted SDDCs.
(optional)
subscription (str) – SubscriptionId for an sddc. (required)
@@ -7392,9 +5397,9 @@ Not Found
Parameters
-
org (str) – Organization identifier. (required)
-
offer_type (str or None) – Offer Type * `ON_DEMAND` - on-demand subscription *
-`TERM` - term subscription * All subscriptions if not
+
org (str) – Organization identifier (required)
+
offer_type (str or None) – Offer Type * \`ON_DEMAND\` - on-demand subscription *
+\`TERM\` - term subscription * All subscriptions if not
specified (optional)
@@ -7438,7 +5443,7 @@ Not Found
Parameters
-
org (str) – Organization identifier. (required)
+
org (str) – Organization identifier (required)
task (str) – Task identifier (required)
@@ -7470,7 +5475,7 @@ Cannot find the task with given identifier
- Built with Sphinx using a theme provided by Read the Docs.
+
+
+
+ Built with Sphinx using a
+
+ theme
+
+ provided by Read the Docs.
@@ -7583,7 +5631,6 @@ Cannot find the task with given identifier
- Built with Sphinx using a theme provided by Read the Docs.
+
+
+
+ Built with Sphinx using a
+
+ theme
+
+ provided by Read the Docs.
@@ -279,7 +306,6 @@ Not found. Requested object not found.
action (str or None) – If = ‘add’, will add the esx. If = ‘remove’, will delete the
esx/esxs bound to a single cluster (Cluster Id is mandatory for non
@@ -854,6 +821,55 @@ Cannot find the SDDC with the given identifier
Attach or detach a public IP to workload VM for a SDDC
-
-
Parameters
-
-
org (str) – Organization identifier. (required)
-
sddc (str) – Sddc Identifier. (required)
-
id (str) – ip allocation id (required)
-
action (str) – Type of action as ‘attach’, ‘detach’, ‘reattach’, or ‘rename’. For
-‘attch’, the public IP must not be attached and
-‘associated_private_ip’ in the payload needs to be set with a
-workload VM private IP. For ‘detach’, the public IP must be
-attached and ‘associated_private_ip’ in the payload should not be
-set with any value. For ‘reattach’, the public IP must be attached
-and ‘associated_private_ip’ in the payload needs to be set with a
-new workload VM private IP. For ‘rename’, the ‘name’ in the payload
-needs to have a new name string. (required)
com.vmware.vapi.std.errors_client.InvalidRequest
-The sddc is not in a state that’s valid for updates
-
-
Raise
-
com.vmware.vapi.std.errors_client.Unauthorized
-Access not allowed to the operation for the current user
-
-
Raise
-
com.vmware.vapi.std.errors_client.NotFound
-Cannot find the public IP with given IP address
-
-
-
-
-
-
class com.vmware.vmc.orgs.sddcs_client.SddcTemplate(config)¶
@@ -1111,8 +930,8 @@ Cannot find the public IP with given IP address
Parameters
-
org (str) – Organization identifier. (required)
-
sddc (str) – Sddc Identifier. (required)
+
org (str) – Organization identifier (required)
+
sddc (str) – Sddc identifier (required)
Return type
@@ -1174,7 +993,7 @@ Cannot find the SDDC with given identifier
Parameters
-
org (str) – Organization identifier. (required)
+
org (str) – Organization identifier (required)
provider (str) – Cloud storage provider ID (example AWS) (required)
num_hosts (long) – Number of hosts in cluster (required)
@@ -1234,14 +1053,14 @@ region
Parameters
-
org (str) – Organization identifier. (required)
+
org (str) – Organization identifier (required)
region (str) – Region for the offer (required)
product_type (str) – Type of the product in offers. *This has been deprecated*. Please
use product & type parameters (required)
product (str or None) – The product that you are trying to purchase, eg. host. This needs
to be accompanied by the type parameter (optional)
type (str or None) – The type/flavor of the product you are trying it purchase,eg. an
-`r5.metal` host. This needs to be accompanied by the
+\`r5.metal\` host. This needs to be accompanied by the
product parameter. (optional)
@@ -1283,7 +1102,7 @@ Forbidden
List of all the products that are available for purchase.
expected_num_hosts (long or None) – The expected number of hosts in the cluster. If not specified,
returned is based on current number of hosts in the cluster.
@@ -244,6 +247,58 @@ Forbidden
Retrieve information about all management and compute gateways and
-other routers (NSX Edges).
-
-
Parameters
-
-
org (str) – Organization identifier. (required)
-
sddc (str) – Sddc Identifier. (required)
-
edge_type (str) – Retrieve records matching NSX Edge type (‘gatewayServices’ or
-‘distributedRouter’). Specify gatewayServices to find management
-and compute gateways in your SDDC. (required)
-
prev_edge_id (str or None) – Provide Edge ID as prevEdgeId to serve as reference for startIndex.
-(optional)
-
start_index (long or None) – Start index for the current page. Default is 0. (optional)
-
page_size (long or None) – Number of records per page. Default is 256. (optional)
-
sort_order_ascending (bool or None) – Set to true to fetch records in ascending sorted order. (optional)
-
sort_by (str or None) – Sort records using one of the column names (id, name, description,
-tenantId, size, enableFips). (optional)
-
filter (str or None) – Filter records matching the NSX Edge ID, name or description.
-(optional)
- Built with Sphinx using a theme provided by Read the Docs.
+
+
+
+ Built with Sphinx using a
+
+ theme
+
+ provided by Read the Docs.
@@ -1001,7 +732,6 @@ Not found. Requested object not found.
Retrieve IPsec VPN peer configuration for a management or compute
-gateway (NSX Edge). The response output is free form text generated as
-per the template specified as request parameter input.
-
-
Parameters
-
-
org (str) – Organization identifier. (required)
-
sddc (str) – Sddc Identifier. (required)
-
edge_id (str) – Edge Identifier. (required)
-
objecttype (str) – Specify object type identifier. Valid value is ‘ipsecSiteConfig’.
-Required. (required)
-
objectid (str) – Specify object identifier, for example ‘ipsecsite-1’ for IPsec Site
-configuration. Required. (required)
-
templateid (str or None) – Specify template identifier and response format. Valid values are
-‘text’, ‘json’ and ‘xml’. Default is ‘text’. Optional. (optional)
-
-
-
Return type
-
vmware.vapi.struct.VapiStruct
-
-
Returns
-
DynamicStructure
-
-
Raise
-
com.vmware.vapi.std.errors_client.InvalidRequest
-Bad request. Request object passed is invalid.
-
-
Raise
-
com.vmware.vapi.std.errors_client.Unauthorized
-Forbidden. Authorization header not provided
-
-
Raise
-
com.vmware.vapi.std.errors_client.NotFound
-Not found. Requested object not found.
Retrieve the status of the specified management or compute gateway (NSX
-Edge).
-
-
Parameters
-
-
org (str) – Organization identifier. (required)
-
sddc (str) – Sddc Identifier. (required)
-
edge_id (str) – Edge Identifier. (required)
-
getlatest (bool or None) – If true, retrieve the status live from the gateway (NSX Edge). If
-false, retrieve the latest available status from database.
-(optional)
-
detailed (bool or None) – If true, retrieve detailed status per feature. If false, retrieve
-aggregated summary of status per feature. (optional)
- Built with Sphinx using a theme provided by Read the Docs.
+
+
+
+ Built with Sphinx using a
+
+ theme
+
+ provided by Read the Docs.
@@ -283,7 +294,6 @@ either Unauthenticated or Unauthorized else False
-