com.vmware.nsx_policy.infra.tier_0s.locale_services package¶
Subpackages¶
Submodules¶
com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp_client module¶
-
class
com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp_client.
Neighbors
(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, neighbor_id)¶ Delete BGP neighbor config
- Parameters
tier0_id (
str
) – (required)locale_service_id (
str
) – (required)neighbor_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, neighbor_id)¶ Read BGP neighbor config
- Parameters
tier0_id (
str
) – (required)locale_service_id (
str
) – (required)neighbor_id (
str
) – (required)
- Return type
- Returns
com.vmware.nsx_policy.model.BgpNeighborConfig
- 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 BGP neighbor configurations
- 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.BgpNeighborConfigListResult
- Returns
com.vmware.nsx_policy.model.BgpNeighborConfigListResult
- 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, neighbor_id, bgp_neighbor_config)¶ If BGP neighbor config with the neighbor-id is not already present, create a new neighbor config. If it already exists, replace the BGP neighbor config with this object.
- Parameters
tier0_id (
str
) – (required)locale_service_id (
str
) – (required)neighbor_id (
str
) – (required)bgp_neighbor_config (
com.vmware.nsx_policy.model_client.BgpNeighborConfig
) – (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, neighbor_id, bgp_neighbor_config)¶ If BGP neighbor config with the neighbor-id is not already present, create a new neighbor config. If it already exists, replace the BGP neighbor config with this object.
- Parameters
tier0_id (
str
) – (required)locale_service_id (
str
) – (required)neighbor_id (
str
) – (required)bgp_neighbor_config (
com.vmware.nsx_policy.model_client.BgpNeighborConfig
) – (required)
- Return type
- Returns
com.vmware.nsx_policy.model.BgpNeighborConfig
- 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.bgp_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.nsx_policy.infra.tier_0s.locale_services.l2vpn_context_client module¶
-
class
com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context_client.
L2vpns
(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, l2vpn_id)¶ Delete the L2Vpn with the given id.
- Parameters
tier0_id (
str
) – (required)locale_service_id (
str
) – (required)l2vpn_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, l2vpn_id)¶ Read the L2Vpn with the given id.
- Parameters
tier0_id (
str
) – (required)locale_service_id (
str
) – (required)l2vpn_id (
str
) – (required)
- Return type
- Returns
com.vmware.nsx_policy.model.L2Vpn
- 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 L2Vpns.
- 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.L2VpnListResult
- 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, l2vpn_id, l2_vpn)¶ Create a new L2Vpn if the L2Vpn with given id does not already exist. If the L2Vpn with the given id already exists, merge with the existing L2Vpn. This is a patch.
- Parameters
tier0_id (
str
) – (required)locale_service_id (
str
) – (required)l2vpn_id (
str
) – (required)l2_vpn (
com.vmware.nsx_policy.model_client.L2Vpn
) – (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, l2vpn_id, l2_vpn)¶ Create a new L2Vpn if the L2Vpn with given id does not already exist. If the L2Vpn with the given id already exists, update the existing L2Vpn. This is a full replace.
- Parameters
tier0_id (
str
) – (required)locale_service_id (
str
) – (required)l2vpn_id (
str
) – (required)l2_vpn (
com.vmware.nsx_policy.model_client.L2Vpn
) – (required)
- Return type
- Returns
com.vmware.nsx_policy.model.L2Vpn
- 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.l2vpn_context_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.nsx_policy.infra.tier_0s.locale_services.l3vpns_client module¶
-
class
com.vmware.nsx_policy.infra.tier_0s.locale_services.l3vpns_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
(tier0_id, locale_service_id, l3vpn_id, enforcement_point_path=None)¶ Get statistics of an L3Vpn. - no enforcement point path specified: Stats will be evaluated on each enforcement point. - {enforcement_point_path}: Stats are evaluated only on the given enforcement point.
- Parameters
tier0_id (
str
) – (required)locale_service_id (
str
) – (required)l3vpn_id (
str
) – (required)enforcement_point_path (
str
orNone
) – String Path of the enforcement point (optional)
- Return type
- Returns
com.vmware.nsx_policy.model.AggregateL3VpnStatistics
- 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.l3vpns_client.
StubFactory
(stub_config)¶ Bases:
vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
- Parameters
stub_config (
vmware.vapi.bindings.stub.StubConfiguration
) – Stub config instance