com.vmware.nsx_policy.infra.tier_0s.groups package¶
Submodules¶
com.vmware.nsx_policy.infra.tier_0s.groups.members_client module¶
-
class
com.vmware.nsx_policy.infra.tier_0s.groups.members_client.
IpAddresses
(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterface
- Parameters
config (
vmware.vapi.bindings.stub.StubConfiguration
) – Configuration to be used for creating the stub.
-
list
(tier0_id, group_id, cursor=None, enforcement_point_path=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶ Get IP addresses that belong to this Tier-0 Group. This API is applicable for Groups containing either VirtualMachine, VIF, Segment ,Segment Port or IP Address member type.For Groups containing other member types,an empty list is returned
- Parameters
tier0_id (
str
) – Tier-0 id (required)group_id (
str
) – Group Id (required)cursor (
str
orNone
) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)enforcement_point_path (
str
orNone
) – String Path of the enforcement point (optional)include_mark_for_delete_objects (
bool
orNone
) – Include objects that are marked for deletion in results (optional, default to false)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.PolicyGroupIPMembersListResult
- Returns
com.vmware.nsx_policy.model.PolicyGroupIPMembersListResult
- 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.groups.members_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_policy.infra.tier_0s.groups.members_client.
VirtualMachines
(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterface
- Parameters
config (
vmware.vapi.bindings.stub.StubConfiguration
) – Configuration to be used for creating the stub.
-
list
(tier0_id, group_id, cursor=None, enforcement_point_path=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶ Get Virtual machines that belong to this Tier-0 Group. This API is applicable for Groups containing VirtualMachine member type. For Groups containing other member types,an empty list is returned.
- Parameters
tier0_id (
str
) – Tier-0 id (required)group_id (
str
) – Group Id (required)cursor (
str
orNone
) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)enforcement_point_path (
str
orNone
) – String Path of the enforcement point (optional)include_mark_for_delete_objects (
bool
orNone
) – Include objects that are marked for deletion in results (optional, default to false)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.RealizedVirtualMachineListResult
- Returns
com.vmware.nsx_policy.model.RealizedVirtualMachineListResult
- 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