com.vmware.nsx_policy.infra.tier_0s package¶
Subpackages¶
- com.vmware.nsx_policy.infra.tier_0s.locale_services package
- Subpackages
- Submodules
- com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp_client module
- com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context_client module
- com.vmware.nsx_policy.infra.tier_0s.locale_services.l3vpns_client module
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
- 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
tier0_id (
str
) – (required)locale_service_id (
str
) – (required)bgp_routing_config (
com.vmware.nsx_policy.model_client.BgpRoutingConfig
) – (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, 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
tier0_id (
str
) – (required)locale_service_id (
str
) – (required)bgp_routing_config (
com.vmware.nsx_policy.model_client.BgpRoutingConfig
) – (required)
- Return type
- 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.
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
- 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
orNone
) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)included_fields (
str
orNone
) – Comma separated list of fields that should be included in query result (optional)page_size (
long
orNone
) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)sort_ascending (
bool
orNone
) – (optional)sort_by (
str
orNone
) – Field by which records are sorted (optional)
- Return type
- 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
tier0_id (
str
) – (required)locale_service_id (
str
) – (required)interface_id (
str
) – (required)tier0_interface (
com.vmware.nsx_policy.model_client.Tier0Interface
) – (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, 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
tier0_id (
str
) – (required)locale_service_id (
str
) – (required)interface_id (
str
) – (required)tier0_interface (
com.vmware.nsx_policy.model_client.Tier0Interface
) – (required)
- Return type
- 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
- 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
- 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
tier0_id (
str
) – (required)locale_service_id (
str
) – (required)l3_vpn_context (
com.vmware.nsx_policy.model_client.L3VpnContext
) – (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, 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
tier0_id (
str
) – (required)locale_service_id (
str
) – (required)l3_vpn_context (
com.vmware.nsx_policy.model_client.L3VpnContext
) – (required)
- Return type
- 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 methodL3vpns.list()
.
-
LIST_L3VPN_SESSION_ROUTEBASEDL3VPNSESSION
= 'RouteBasedL3VpnSession'¶ Possible value for
l3vpnSession
of methodL3vpns.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
- 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
orNone
) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)included_fields (
str
orNone
) – Comma separated list of fields that should be included in query result (optional)l3vpn_session (
str
orNone
) – Resource type of L3Vpn Session (optional)page_size (
long
orNone
) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)sort_ascending (
bool
orNone
) – (optional)sort_by (
str
orNone
) – Field by which records are sorted (optional)
- Return type
- 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
tier0_id (
str
) – (required)locale_service_id (
str
) – (required)l3vpn_id (
str
) – (required)l3_vpn (
com.vmware.nsx_policy.model_client.L3Vpn
) – (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
-
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
- 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
tier0_id (
str
) – (required)locale_service_id (
str
) – (required)l3vpn_id (
str
) – (required)l3_vpn (
com.vmware.nsx_policy.model_client.L3Vpn
) – (required)
- Return type
- 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.
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
- 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
orNone
) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)included_fields (
str
orNone
) – Comma separated list of fields that should be included in query result (optional)page_size (
long
orNone
) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)sort_ascending (
bool
orNone
) – (optional)sort_by (
str
orNone
) – 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
tier0_id (
str
) – (required)locale_service_id (
str
) – (required)interface_id (
str
) – (required)service_interface (
com.vmware.nsx_policy.model_client.ServiceInterface
) – (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, 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
tier0_id (
str
) – (required)locale_service_id (
str
) – (required)interface_id (
str
) – (required)service_interface (
com.vmware.nsx_policy.model_client.ServiceInterface
) – (required)
- Return type
- 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
- 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
orNone
) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)included_fields (
str
orNone
) – Comma separated list of fields that should be included in query result (optional)page_size (
long
orNone
) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)sort_ascending (
bool
orNone
) – (optional)sort_by (
str
orNone
) – 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
tier0_id (
str
) – (required)locale_service_id (
str
) – (required)tier0_deployment_map_id (
str
) – (required)tier0_deployment_map (
com.vmware.nsx_policy.model_client.Tier0DeploymentMap
) – (required)
- Return type
- 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
tier0_id (
str
) – (required)locale_service_id (
str
) – (required)tier0_deployment_map_id (
str
) – (required)tier0_deployment_map (
com.vmware.nsx_policy.model_client.Tier0DeploymentMap
) – (required)
- Return type
- 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