com.vmware.nsx.vpn.ipsec package¶

Submodules¶

com.vmware.nsx.vpn.ipsec.sessions_client module¶

class com.vmware.nsx.vpn.ipsec.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 method Statistics.get().

GET_SOURCE_REALTIME = 'realtime'¶: Possible value for source of method Statistics.get().

get(session_id, source=None)¶

Get statistics of a vpn session across all tunnels and IKE session. Query parameter “source=realtime” is the only supported source.

Parameters

session_id (str) – (required)
source (str or None) – Data source type. (optional)

Return type

com.vmware.nsx.model_client.IPSecVPNSessionStatistics

Returns

com.vmware.nsx.model.IPSecVPNSessionStatistics

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

reset(session_id)¶

Reset the statistics of the given VPN session.

Parameters: session_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

class com.vmware.nsx.vpn.ipsec.sessions_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_SOURCE_CACHED = 'cached'¶: Possible value for source of method Status.get().

GET_SOURCE_REALTIME = 'realtime'¶: Possible value for source of method Status.get().

get(session_id, source=None)¶

List status of IPSec session. Query parameter source supports both realtime and cached mode.

Parameters

session_id (str) – (required)
source (str or None) – Data source type. (optional)

Return type

com.vmware.nsx.model_client.IPSecVPNSessionStatus

Returns

com.vmware.nsx.model.IPSecVPNSessionStatus

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.vpn.ipsec.sessions_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.vpn.ipsec.sessions_client.Summary(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 method Summary.get().

GET_SOURCE_REALTIME = 'realtime'¶: Possible value for source of method Summary.get().

get(site_id=None, source=None)¶

VPN session summary gets summary per vpn sessions and IKE session. Query parameter source supports only cached mode.

Parameters

site_id (str or None) – Peer site id (optional)
source (str or None) – Data source type. (optional)

Return type

com.vmware.nsx.model_client.IPSecVPNSessionSummary

Returns

com.vmware.nsx.model.IPSecVPNSessionSummary

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