com.vmware.nsx_policy.infra.tier_1s.locale_services.l2vpn_services package¶
Submodules¶
com.vmware.nsx_policy.infra.tier_1s.locale_services.l2vpn_services.sessions_client module¶
-
class
com.vmware.nsx_policy.infra.tier_1s.locale_services.l2vpn_services.sessions_client.
DetailedStatus
(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterface
- Parameters
config (
vmware.vapi.bindings.stub.StubConfiguration
) – Configuration to be used for creating the stub.
-
GET_SOURCE_CACHED
= 'cached'¶ Possible value for
source
of methodDetailedStatus.get()
.
-
GET_SOURCE_REALTIME
= 'realtime'¶ Possible value for
source
of methodDetailedStatus.get()
.
-
get
(tier1_id, locale_service_id, service_id, session_id, enforcement_point_path=None, source=None)¶ no enforcement point path specified: detailed tatus is evaluated on
each enforcement point. - an enforcement point path is specified: detailed status is evaluated only on the given enforcement point. - source=realtime: detailed tatus is fetched realtime from the enforcement point. - source=cached: cached detailed status is returned.
- Parameters
tier1_id (
str
) – (required)locale_service_id (
str
) – (required)service_id (
str
) – (required)session_id (
str
) – (required)enforcement_point_path (
str
orNone
) – String Path of the enforcement point (optional)source (
str
orNone
) – Data source type. (optional)
- Return type
com.vmware.nsx_policy.model_client.AggregateL2VPNSessionStatus
- Returns
com.vmware.nsx_policy.model.AggregateL2VPNSessionStatus
- 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_1s.locale_services.l2vpn_services.sessions_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
(tier1_id, locale_service_id, service_id, session_id, enforcement_point_path=None)¶ Get peer config for the Tier-1 L2VPN session to configure the remote side of the tunnel. - no enforcement point path specified: L2VPN Session Peer Codes will be evaluated on each enforcement point. - enforcement point paths specified: L2VPN Session Peer Codes are evaluated only on the given enforcement points. API supported only when L2VPN Service is in Server Mode.
- Parameters
tier1_id (
str
) – (required)locale_service_id (
str
) – (required)service_id (
str
) – (required)session_id (
str
) – (required)enforcement_point_path (
str
orNone
) – String Path of the enforcement point (optional)
- Return type
com.vmware.nsx_policy.model_client.AggregateL2VPNSessionPeerConfig
- Returns
com.vmware.nsx_policy.model.AggregateL2VPNSessionPeerConfig
- 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_1s.locale_services.l2vpn_services.sessions_client.
RemoteMac
(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterface
- Parameters
config (
vmware.vapi.bindings.stub.StubConfiguration
) – Configuration to be used for creating the stub.
-
get
(tier1_id, locale_service_id, service_id, session_id, enforcement_point_path=None, segment_path=None)¶ Returns L2Vpn session remote macs for a logical switch. Data is fetched from enforcement point.
- Parameters
tier1_id (
str
) – (required)locale_service_id (
str
) – (required)service_id (
str
) – (required)session_id (
str
) – (required)enforcement_point_path (
str
orNone
) – String Path of the enforcement point (optional)segment_path (
str
orNone
) – Segment Path (optional)
- Return type
com.vmware.nsx_policy.model_client.AggregateL2VpnSessionRemoteMac
- Returns
com.vmware.nsx_policy.model.AggregateL2VpnSessionRemoteMac
- 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_1s.locale_services.l2vpn_services.sessions_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_SOURCE_CACHED
= 'cached'¶ Possible value for
source
of methodStatistics.get()
.
-
GET_SOURCE_REALTIME
= 'realtime'¶ Possible value for
source
of methodStatistics.get()
.
-
get
(tier1_id, locale_service_id, service_id, session_id, enforcement_point_path=None, source=None)¶ no enforcement point path specified: statistics are evaluated on each
enforcement point. - an enforcement point path is specified: statistics are evaluated only on the given enforcement point. - source=realtime: statistics are fetched realtime from the enforcement point. - source=cached: cached statistics from the enforcement point are returned.
- Parameters
tier1_id (
str
) – (required)locale_service_id (
str
) – (required)service_id (
str
) – (required)session_id (
str
) – (required)enforcement_point_path (
str
orNone
) – String Path of the enforcement point (optional)source (
str
orNone
) – Data source type. (optional)
- Return type
com.vmware.nsx_policy.model_client.AggregateL2VPNSessionStatistics
- Returns
com.vmware.nsx_policy.model.AggregateL2VPNSessionStatistics
- 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_1s.locale_services.l2vpn_services.sessions_client.
StubFactory
(stub_config)¶ Bases:
vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
- Parameters
stub_config (
vmware.vapi.bindings.stub.StubConfiguration
) – Stub config instance