com.vmware.nsx_policy.infra.tier_0s package

Subpackages

• com.vmware.nsx_policy.infra.tier_0s.locale_services package
  • Subpackages
    • com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp package
      • Submodules
      • com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp.neighbors_client module
    • com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context package
      • Submodules
      • com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.l2vpns_client module
  • 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

com.vmware.nsx_policy.model_client.BgpRoutingConfig

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

com.vmware.nsx_policy.model_client.BgpRoutingConfig

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.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

com.vmware.nsx_policy.model_client.L2VpnContext

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

com.vmware.nsx_policy.model_client.L3VpnContext

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

com.vmware.nsx_policy.model_client.L3VpnContext

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 method L3vpns.list().

LIST_L3VPN_SESSION_ROUTEBASEDL3VPNSESSION = 'RouteBasedL3VpnSession'

Possible value for l3vpnSession of method L3vpns.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

com.vmware.nsx_policy.model_client.L3Vpn

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 or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

• included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)

• l3vpn_session (str or None) – Resource type of L3Vpn Session (optional)

• page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

• sort_ascending (bool or None) – (optional)

• sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx_policy.model_client.L3VpnListResult

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

com.vmware.nsx_policy.model_client.L3Vpn

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

com.vmware.nsx_policy.model_client.L3Vpn

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.StubFactory(stub_config)

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance