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

Subpackages

• com.vmware.vmc.orgs.sddcs.networks.cgws package
  • Submodules
  • com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client module
• 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
  • com.vmware.vmc.orgs.sddcs.networks.edges.dns_client module
  • com.vmware.vmc.orgs.sddcs.networks.edges.firewall_client module
  • com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_client module
  • com.vmware.vmc.orgs.sddcs.networks.edges.nat_client module
  • com.vmware.vmc.orgs.sddcs.networks.edges.statistics_client module

Submodules

com.vmware.vmc.orgs.sddcs.networks.edges_client module

class com.vmware.vmc.orgs.sddcs.networks.edges_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(org, sddc, edge_id, objecttype, objectid, templateid=None)

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.

class com.vmware.vmc.orgs.sddcs.networks.edges_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(org, sddc, edge_id, getlatest=None, detailed=None)

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)

Return type

com.vmware.vmc.model_client.EdgeStatus

Returns

com.vmware.vmc.model.EdgeStatus

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_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.vmc.orgs.sddcs.networks.edges_client.Vnics(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 all interfaces 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)

Return type

com.vmware.vmc.model_client.Vnics

Returns

com.vmware.vmc.model.Vnics

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.