com.vmware.vmc.orgs.sddcs.networks.edges package

Subpackages

• com.vmware.vmc.orgs.sddcs.networks.edges.firewall package
  • Submodules
  • com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client module
• com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn package
  • Submodules
  • com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.config_client module
• com.vmware.vmc.orgs.sddcs.networks.edges.nat package
  • Submodules
  • com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client module
• com.vmware.vmc.orgs.sddcs.networks.edges.statistics package
  • Submodules
  • com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client module
  • com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client module

Submodules

com.vmware.vmc.orgs.sddcs.networks.edges.dhcp_client module

class com.vmware.vmc.orgs.sddcs.networks.edges.dhcp_client.Leaseinfo(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

get(org, sddc, edge_id)

Retrieve DHCP leaseinfo of a management or compute gateway (NSX Edge).

Parameters

• org (str) – Organization identifier. (required)

• sddc (str) – Sddc Identifier. (required)

• edge_id (str) – Edge Identifier. (required)

Return type

com.vmware.vmc.model_client.DhcpLeases

Returns

com.vmware.vmc.model.DhcpLeases

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.

class com.vmware.vmc.orgs.sddcs.networks.edges.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.vmc.orgs.sddcs.networks.edges.dns_client module

class com.vmware.vmc.orgs.sddcs.networks.edges.dns_client.Config(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

create(org, sddc, edge_id, enable)

Enable or disable DNS configuration for a management or compute gateway (NSX Edge).

Parameters

• org (str) – Organization identifier. (required)

• sddc (str) – Sddc Identifier. (required)

• edge_id (str) – Edge Identifier. (required)

• enable (bool) – Set to true to enable, set to false to disable. (required)

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.

delete(org, sddc, edge_id)

Delete DNS server configuration for a management or compute gateway (NSX Edge).

Parameters

• org (str) – Organization identifier. (required)

• sddc (str) – Sddc Identifier. (required)

• edge_id (str) – Edge Identifier. (required)

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.

get(org, sddc, edge_id)

Retrieve DNS server configuration for a management or compute gateway (NSX Edge).

Parameters

• org (str) – Organization identifier. (required)

• sddc (str) – Sddc Identifier. (required)

• edge_id (str) – Edge Identifier. (required)

Return type

com.vmware.vmc.model_client.DnsConfig

Returns

com.vmware.vmc.model.DnsConfig

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.

update(org, sddc, edge_id, dns_config)

Configure DNS server configuration for a management or compute gateway (NSX Edge).

Parameters

• org (str) – Organization identifier. (required)

• sddc (str) – Sddc Identifier. (required)

• edge_id (str) – Edge Identifier. (required)

• dns_config (com.vmware.vmc.model_client.DnsConfig) – (required)

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.

class com.vmware.vmc.orgs.sddcs.networks.edges.dns_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(org, sddc, edge_id)

Retrieve DNS server statistics for a management or compute gateway (NSX Edge).

Parameters

• org (str) – Organization identifier. (required)

• sddc (str) – Sddc Identifier. (required)

• edge_id (str) – Edge Identifier. (required)

Return type

com.vmware.vmc.model_client.DnsStatusAndStats

Returns

com.vmware.vmc.model.DnsStatusAndStats

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.

class com.vmware.vmc.orgs.sddcs.networks.edges.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.vmc.orgs.sddcs.networks.edges.firewall_client module

class com.vmware.vmc.orgs.sddcs.networks.edges.firewall_client.Config(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

delete(org, sddc, edge_id)

Delete firewall configuration for a management or compute gateway (NSX Edge).

Parameters

• org (str) – Organization identifier. (required)

• sddc (str) – Sddc Identifier. (required)

• edge_id (str) – Edge Identifier. (required)

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.

get(org, sddc, edge_id)

Retrieve the firewall configuration for a management or compute gateway (NSX Edge).

Parameters

• org (str) – Organization identifier. (required)

• sddc (str) – Sddc Identifier. (required)

• edge_id (str) – Edge Identifier. (required)

Return type

com.vmware.vmc.model_client.FirewallConfig

Returns

com.vmware.vmc.model.FirewallConfig

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.

update(org, sddc, edge_id, firewall_config)

Configure firewall for a management or compute gateway (NSX Edge).

Parameters

• org (str) – Organization identifier. (required)

• sddc (str) – Sddc Identifier. (required)

• edge_id (str) – Edge Identifier. (required)

• firewall_config (com.vmware.vmc.model_client.FirewallConfig) – (required)

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.

class com.vmware.vmc.orgs.sddcs.networks.edges.firewall_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(org, sddc, edge_id, rule_id)

Retrieve statistics for a specific firewall rule for a management or compute gateway (NSX Edge).

Parameters

• org (str) – Organization identifier. (required)

• sddc (str) – Sddc Identifier. (required)

• edge_id (str) – Edge Identifier. (required)

• rule_id (long) – Rule Identifier. (required)

Return type

com.vmware.vmc.model_client.FirewallRuleStats

Returns

com.vmware.vmc.model.FirewallRuleStats

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.

class com.vmware.vmc.orgs.sddcs.networks.edges.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.vmc.orgs.sddcs.networks.edges.ipsec_client module

class com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_client.Config(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

delete(org, sddc, edge_id)

Delete IPsec VPN configuration for a management or compute gateway (NSX Edge).

Parameters

• org (str) – Organization identifier. (required)

• sddc (str) – Sddc Identifier. (required)

• edge_id (str) – Edge Identifier. (required)

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.

get(org, sddc, edge_id, show_sensitive_data=None)

Retrieve IPsec VPN configuration for a management or compute gateway (NSX Edge).

Parameters

• org (str) – Organization identifier. (required)

• sddc (str) – Sddc Identifier. (required)

• edge_id (str) – Edge Identifier. (required)

• show_sensitive_data (bool or None) – Set to true to show sensitive data. Default value is false. (optional)

Return type

com.vmware.vmc.model_client.Ipsec

Returns

com.vmware.vmc.model.Ipsec

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.

update(org, sddc, edge_id, ipsec)

Modify IPsec VPN configuration for a management or compute gateway (NSX Edge).

Parameters

• org (str) – Organization identifier. (required)

• sddc (str) – Sddc Identifier. (required)

• edge_id (str) – Edge Identifier. (required)

• ipsec (com.vmware.vmc.model_client.Ipsec) – IPsec Configuration dto object. (required)

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.

class com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_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(org, sddc, edge_id)

Retrieve IPsec VPN statistics for a management or compute gateway (NSX Edge).

Parameters

• org (str) – Organization identifier. (required)

• sddc (str) – Sddc Identifier. (required)

• edge_id (str) – Edge Identifier. (required)

Return type

com.vmware.vmc.model_client.IpsecStatusAndStats

Returns

com.vmware.vmc.model.IpsecStatusAndStats

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.

class com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_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.vmc.orgs.sddcs.networks.edges.nat_client module

class com.vmware.vmc.orgs.sddcs.networks.edges.nat_client.Config(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

delete(org, sddc, edge_id)

Delete all NAT configuration for 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)

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.

get(org, sddc, edge_id)

Retrieve NAT configuration for a management or compute gateway (NSX Edge).

Parameters

• org (str) – Organization identifier. (required)

• sddc (str) – Sddc Identifier. (required)

• edge_id (str) – Edge Identifier. (required)

Return type

com.vmware.vmc.model_client.Nat

Returns

com.vmware.vmc.model.Nat

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.

update(org, sddc, edge_id, nat)

Modify NAT configuration for a management or compute gateway (NSX Edge).

Parameters

• org (str) – Organization identifier. (required)

• sddc (str) – Sddc Identifier. (required)

• edge_id (str) – Edge Identifier. (required)

• nat (com.vmware.vmc.model_client.Nat) – (required)

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.

class com.vmware.vmc.orgs.sddcs.networks.edges.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.vmc.orgs.sddcs.networks.edges.statistics_client module

class com.vmware.vmc.orgs.sddcs.networks.edges.statistics_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(org, sddc, edge_id, start_time=None, end_time=None)

Retrieve interface statistics for a management or compute gateway (NSX Edge).

Parameters

• org (str) – Organization identifier. (required)

• sddc (str) – Sddc Identifier. (required)

• edge_id (str) – Edge Identifier. (required)

• start_time (long or None) – Show statistics from this start time (in milliseconds since epoch). (optional)

• end_time (long or None) – Show statistics until this end time (in milliseconds since epoch). (optional)

Return type

com.vmware.vmc.model_client.CbmStatistics

Returns

com.vmware.vmc.model.CbmStatistics

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.

class com.vmware.vmc.orgs.sddcs.networks.edges.statistics_client.StubFactory(stub_config)

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters

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