com.vmware.vmc.orgs.sddcs package¶
Subpackages¶
- com.vmware.vmc.orgs.sddcs.networks package
- Subpackages
- com.vmware.vmc.orgs.sddcs.networks.cgws package
- com.vmware.vmc.orgs.sddcs.networks.edges package
- Subpackages
- 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
- Subpackages
Submodules¶
com.vmware.vmc.orgs.sddcs.dns_client module¶
-
class
com.vmware.vmc.orgs.sddcs.dns_client.
Private
(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterface
Parameters: config ( vmware.vapi.bindings.stub.StubConfiguration
) – Configuration to be used for creating the stub.-
update
(org, sddc)¶ Update the DNS records of management VMs to use private IP addresses
Parameters: - org (
str
) – Organization identifier. (required) - sddc (
str
) – Sddc Identifier. (required)
Return type: Returns: com.vmware.vmc.model.Task
Raise: com.vmware.vapi.std.errors_client.Unauthenticated
UnauthorizedRaise: com.vmware.vapi.std.errors_client.InvalidRequest
The sddc is not in a state that’s valid for updates or invalid bodyRaise: com.vmware.vapi.std.errors_client.Unauthorized
Forbidden- org (
-
-
class
com.vmware.vmc.orgs.sddcs.dns_client.
Public
(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterface
Parameters: config ( vmware.vapi.bindings.stub.StubConfiguration
) – Configuration to be used for creating the stub.-
update
(org, sddc)¶ Update the DNS records of management VMs to use public IP addresses
Parameters: - org (
str
) – Organization identifier. (required) - sddc (
str
) – Sddc Identifier. (required)
Return type: Returns: com.vmware.vmc.model.Task
Raise: com.vmware.vapi.std.errors_client.Unauthenticated
UnauthorizedRaise: com.vmware.vapi.std.errors_client.InvalidRequest
The sddc is not in a state that’s valid for updates or invalid bodyRaise: com.vmware.vapi.std.errors_client.Unauthorized
Forbidden- org (
-
-
class
com.vmware.vmc.orgs.sddcs.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.networking_client module¶
-
class
com.vmware.vmc.orgs.sddcs.networking_client.
ConnectivityTests
(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)¶ Retrieve metadata for connectivity tests.
Parameters: - org (
str
) – Organization identifier. (required) - sddc (
str
) – Sddc Identifier. (required)
Return type: Returns: com.vmware.vmc.model.ConnectivityValidationGroups
Raise: com.vmware.vapi.std.errors_client.Unauthenticated
UnauthorizedRaise: com.vmware.vapi.std.errors_client.Unauthorized
Forbidden- org (
-
post
(org, sddc, request_info, action)¶ ConnectivityValidationGroupResultWrapper will be available at task.params[‘test_result’].
Parameters: - org (
str
) – Organization identifier. (required) - sddc (
str
) – Sddc Identifier. (required) - request_info (
com.vmware.vmc.model_client.ConnectivityValidationGroup
) – request information (required) - action (
str
) – If = ‘start’, start connectivity tests. (required)
Return type: Returns: com.vmware.vmc.model.Task
Raise: com.vmware.vapi.std.errors_client.Unauthenticated
UnauthorizedRaise: com.vmware.vapi.std.errors_client.InvalidRequest
Bad RequestRaise: com.vmware.vapi.std.errors_client.Unauthorized
Forbidden- org (
-
-
class
com.vmware.vmc.orgs.sddcs.networking_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_client module¶
-
class
com.vmware.vmc.orgs.sddcs.networks_client.
Edges
(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_type, prev_edge_id=None, start_index=None, page_size=None, sort_order_ascending=None, sort_by=None, filter=None, ld_rname=None)¶ 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
orNone
) – Provide Edge ID as prevEdgeId to serve as reference for startIndex. (optional) - start_index (
long
orNone
) – Start index for the current page. Default is 0. (optional) - page_size (
long
orNone
) – Number of records per page. Default is 256. (optional) - sort_order_ascending (
bool
orNone
) – Set to true to fetch records in ascending sorted order. (optional) - sort_by (
str
orNone
) – Sort records using one of the column names (id, name, description, tenantId, size, enableFips). (optional) - filter (
str
orNone
) – Filter records matching the NSX Edge ID, name or description. (optional) - ld_rname (
str
orNone
) – (optional)
Return type: Returns: com.vmware.vmc.model.PagedEdgeList
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 providedRaise: com.vmware.vapi.std.errors_client.NotFound
Not found. Requested object not found.- org (
-
-
class
com.vmware.vmc.orgs.sddcs.networks_client.
Logical
(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, sddc_network)¶ Create a network in an SDDC.
Parameters: - org (
str
) – Organization identifier. (required) - sddc (
str
) – Sddc Identifier. (required) - sddc_network (
com.vmware.vmc.model_client.SddcNetwork
) – (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.- org (
-
delete
(org, sddc, network_id)¶ Delete a network in an SDDC.
Parameters: - org (
str
) – Organization identifier. (required) - sddc (
str
) – Sddc Identifier. (required) - network_id (
str
) – Logical Network 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.- org (
-
get
(org, sddc, network_id)¶ Retrieve information about a network in an SDDC.
Parameters: - org (
str
) – Organization identifier. (required) - sddc (
str
) – Sddc Identifier. (required) - network_id (
str
) – Logical Network Identifier (required)
Return type: Returns: com.vmware.vmc.model.SddcNetwork
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 providedRaise: com.vmware.vapi.std.errors_client.NotFound
Not found. Requested object not found.- org (
-
get_0
(org, sddc, page_size=None, start_index=None, prev_sddc_network_id=None, sort_order_ascending=None)¶ Retrieve all networks in an SDDC.
Parameters: - org (
str
) – Organization identifier. (required) - sddc (
str
) – Sddc Identifier. (required) - page_size (
long
orNone
) – Page size for pagination. (optional) - start_index (
long
orNone
) – Start index of page. (optional) - prev_sddc_network_id (
str
orNone
) – Previous logical network id. (optional) - sort_order_ascending (
bool
orNone
) – Sort order ascending. (optional)
Return type: Returns: com.vmware.vmc.model.DataPageSddcNetwork
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 providedRaise: com.vmware.vapi.std.errors_client.NotFound
Not found. Requested object not found.- org (
-
update
(org, sddc, network_id, sddc_network)¶ Modify a network in an SDDC.
Parameters: - org (
str
) – Organization identifier. (required) - sddc (
str
) – Sddc Identifier. (required) - network_id (
str
) – Logical Network Identifier (required) - sddc_network (
com.vmware.vmc.model_client.SddcNetwork
) – (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.- org (
-
-
class
com.vmware.vmc.orgs.sddcs.networks_client.
StubFactory
(stub_config)¶ Bases:
vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
Parameters: stub_config ( vmware.vapi.bindings.stub.StubConfiguration
) – Stub config instance