com.vmware.nsx_policy.infra.realized_state.enforcement_points package

Submodules

com.vmware.nsx_policy.infra.realized_state.enforcement_points.firewalls_client module

class com.vmware.nsx_policy.infra.realized_state.enforcement_points.firewalls_client.FirewallSections(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

get(enforcement_point_name, firewall_section_id)

Read a Firewall and the complete tree underneath. Returns the populated Firewall object.

Parameters

  • enforcement_point_name (str) – Enforcement Point Name (required)

  • firewall_section_id (str) – Firewall Section Id (required)

Return type

com.vmware.nsx_policy.model_client.RealizedFirewallSection

Returns

com.vmware.nsx_policy.model.RealizedFirewallSection

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(enforcement_point_name, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)

Paginated list of all Firewalls. Returns populated Firewalls.

Parameters

  • enforcement_point_name (str) – Enforcement Point Name (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)

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

Returns

com.vmware.nsx_policy.model.RealizedFirewallSectionListResult

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.realized_state.enforcement_points.firewalls_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.realized_state.enforcement_points.groups_client module

class com.vmware.nsx_policy.infra.realized_state.enforcement_points.groups_client.Nsgroups(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

get(enforcement_point_name, nsgroup_name)

Read a NSGroup and the complete tree underneath. Returns the populated NSgroup object.

Parameters

  • enforcement_point_name (str) – Enforcement Point Name (required)

  • nsgroup_name (str) – Group Name (required)

Return type

com.vmware.nsx_policy.model_client.GenericPolicyRealizedResource

Returns

com.vmware.nsx_policy.model.GenericPolicyRealizedResource

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(enforcement_point_name, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)

Paginated list of all NSGroups. Returns populated NSGroups.

Parameters

  • enforcement_point_name (str) – Enforcement Point Name (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)

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

Returns

com.vmware.nsx_policy.model.GenericPolicyRealizedResourceListResult

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.realized_state.enforcement_points.groups_client.Securitygroups(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

get(enforcement_point_name, securitygroup_name)

Read a Security Group and the complete tree underneath. Returns the populated Security Group object.

Parameters

  • enforcement_point_name (str) – Enforcement Point Name (required)

  • securitygroup_name (str) – Group Name (required)

Return type

com.vmware.nsx_policy.model_client.RealizedSecurityGroup

Returns

com.vmware.nsx_policy.model.RealizedSecurityGroup

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(enforcement_point_name, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)

Paginated list of all Security Groups. Returns populated Security Groups.

Parameters

  • enforcement_point_name (str) – Enforcement Point Name (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)

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

Returns

com.vmware.nsx_policy.model.RealizedSecurityGroupListResult

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.realized_state.enforcement_points.groups_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.realized_state.enforcement_points.ip_sets_client module

class com.vmware.nsx_policy.infra.realized_state.enforcement_points.ip_sets_client.IpSetsNsxt(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

get(enforcement_point_name, ip_set_name)

Read an IPSet

Parameters

  • enforcement_point_name (str) – Enforcement Point Name (required)

  • ip_set_name (str) – IPSet name (required)

Return type

com.vmware.nsx_policy.model_client.GenericPolicyRealizedResource

Returns

com.vmware.nsx_policy.model.GenericPolicyRealizedResource

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(enforcement_point_name, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)

Paginated list of all Realized IPSets

Parameters

  • enforcement_point_name (str) – Enforcement Point Name (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)

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

Returns

com.vmware.nsx_policy.model.GenericPolicyRealizedResourceListResult

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.realized_state.enforcement_points.ip_sets_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.realized_state.enforcement_points.mac_sets_client module

class com.vmware.nsx_policy.infra.realized_state.enforcement_points.mac_sets_client.MacSetsNsxt(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

get(enforcement_point_name, mac_set_name)

Read an MACSet

Parameters

  • enforcement_point_name (str) – Enforcement Point Name (required)

  • mac_set_name (str) – MACSet name (required)

Return type

com.vmware.nsx_policy.model_client.GenericPolicyRealizedResource

Returns

com.vmware.nsx_policy.model.GenericPolicyRealizedResource

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(enforcement_point_name, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)

Paginated list of all Realized MACSets

Parameters

  • enforcement_point_name (str) – Enforcement Point Name (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)

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

Returns

com.vmware.nsx_policy.model.GenericPolicyRealizedResourceListResult

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.realized_state.enforcement_points.mac_sets_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.realized_state.enforcement_points.services_client module

class com.vmware.nsx_policy.infra.realized_state.enforcement_points.services_client.Nsservices(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

get(enforcement_point_name, nsservice_name)

Read a NSService.

Parameters

  • enforcement_point_name (str) – Enforcement Point Name (required)

  • nsservice_name (str) – NSService Name (required)

Return type

com.vmware.nsx_policy.model_client.GenericPolicyRealizedResource

Returns

com.vmware.nsx_policy.model.GenericPolicyRealizedResource

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(enforcement_point_name, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)

Paginated list of all Realized NSService.

Parameters

  • enforcement_point_name (str) – Enforcement Point Name (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)

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

Returns

com.vmware.nsx_policy.model.GenericPolicyRealizedResourceListResult

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.realized_state.enforcement_points.services_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.realized_state.enforcement_points.virtual_machines_client module

class com.vmware.nsx_policy.infra.realized_state.enforcement_points.virtual_machines_client.Details(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

get(enforcement_point_name, virtual_machine_id)

This API return optional details about a virtual machines (e.g. user login session) from the specified enforcement point. In case of NSXT, virtual-machine-id would be the value of the external_id of the virtual machine.

Parameters

  • enforcement_point_name (str) – (required)

  • virtual_machine_id (str) – (required)

Return type

com.vmware.nsx_policy.model_client.VirtualMachineDetails

Returns

com.vmware.nsx_policy.model.VirtualMachineDetails

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

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters

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