info: description: VMware NSX-T Data Center Policy REST API title: NSX-T Data Center Policy API version: 3.2.0.0.0 schemes: - https produces: - application/json securityDefinitions: BasicAuth: description: HTTP Basic Authentication type: basic host: nsxmanager.your.domain security: - BasicAuth: [] swagger: '2.0' basePath: /policy/api/v1 paths: /aaa/effective-permissions: get: consumes: - application/json description: | Returns none if user doesn't have access or feature_name from required request parameter is empty/invalid/doesn't match with object-path provided. operationId: GetPathPermissions parameters: - description: Feature name in: query name: feature_name required: true type: string - description: Exact object Policy path in: query name: object_path required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PathPermissionGroup' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get effective object permissions to object specified by path for current user. tags: - System Administration - Settings - User Management - Authorization - Object Permissions x-vmw-nsx-module: PolicyAuthz /aaa/features-with-properties: get: consumes: - application/json description: | List features operationId: ListFeatures produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/FeaturePermissionListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List feature permissions tags: - System Administration - Settings - User Management - Roles x-vmw-nsx-module: AAA /aaa/ldap-identity-sources: get: consumes: - application/json description: |- Return a list of all configured LDAP identity sources. operationId: ListLdapIdentitySources parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/LdapIdentitySourceListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List LDAP identity sources tags: - System Administration - Settings - User Management - LDAP Identity Sources x-vmw-nsx-module: LdapIdentitySources /aaa/ldap-identity-sources/{ldap-identity-source-id}: delete: consumes: - application/json description: |- Delete an LDAP identity source. Users defined in that source will no longer be able to access NSX. operationId: DeleteLdapIdentitySource parameters: - in: path name: ldap-identity-source-id required: true type: string responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete an LDAP identity source tags: - System Administration - Settings - User Management - LDAP Identity Sources x-vmw-nsx-module: LdapIdentitySources get: consumes: - application/json description: |- Return details about one LDAP identity source operationId: ReadLdapIdentitySource parameters: - in: path name: ldap-identity-source-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/LdapIdentitySource' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read a single LDAP identity source tags: - System Administration - Settings - User Management - LDAP Identity Sources x-vmw-nsx-module: LdapIdentitySources put: consumes: - application/json description: |- Update the configuration of an existing LDAP identity source. You may wish to verify the new configuration using the POST /aaa/ldap-identity-sources?action=probe API before changing the configuration. Note that if you are using LDAP on an active and standby NSX-T Global Manager in a federated environment, you must use the same name for your LDAP identity sources on the active and standby Global Managers. operationId: CreateOrUpdateLdapIdentitySource parameters: - in: path name: ldap-identity-source-id required: true type: string - in: body name: LdapIdentitySource required: true schema: $ref: '#/definitions/LdapIdentitySource' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/LdapIdentitySource' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Update an existing LDAP identity source tags: - System Administration - Settings - User Management - LDAP Identity Sources x-vmw-nsx-module: LdapIdentitySources /aaa/ldap-identity-sources/{ldap-identity-source-id}/search: post: consumes: - application/json description: |- Search the LDAP identity source for users and groups that match the given filter_value. In most cases, the LDAP source performs a case-insensitive search. operationId: SearchLdapIdentitySource parameters: - in: path name: ldap-identity-source-id required: true type: string - description: Search filter value in: query name: filter_value required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/LdapIdentitySourceSearchResultList' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Search the LDAP identity source tags: - System Administration - Settings - User Management - LDAP Identity Sources x-vmw-nsx-module: LdapIdentitySources /aaa/ldap-identity-sources/{ldap-identity-source-id}?action=probe: post: consumes: - application/json description: |- Attempt to connect to an existing LDAP identity source and report any errors encountered. operationId: ProbeConfiguredLdapIdentitySource parameters: - in: path name: ldap-identity-source-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/LdapIdentitySourceProbeResults' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Test the configuration of an existing LDAP identity source tags: - System Administration - Settings - User Management - LDAP Identity Sources x-vmw-nsx-module: LdapIdentitySources /aaa/ldap-identity-sources?action=fetch_certificate: post: consumes: - application/json description: |- Attempt to connect to an LDAP server and retrieve the server certificate it presents. operationId: FetchIdentitySourceLdapServerCertificate parameters: - in: body name: IdentitySourceLdapServerEndpoint required: true schema: $ref: '#/definitions/IdentitySourceLdapServerEndpoint' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PeerCertificateChain' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Fetch the server certificate of an LDAP server tags: - System Administration - Settings - User Management - LDAP Identity Sources x-vmw-nsx-module: LdapIdentitySources /aaa/ldap-identity-sources?action=probe_identity_source: post: consumes: - application/json description: |- Verify that the configuration of an LDAP identity source is correct before actually creating the source. operationId: ProbeUnconfiguredLdapIdentitySource parameters: - in: body name: LdapIdentitySource required: true schema: $ref: '#/definitions/LdapIdentitySource' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/LdapIdentitySourceProbeResults' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Probe an LDAP identity source tags: - System Administration - Settings - User Management - LDAP Identity Sources x-vmw-nsx-module: LdapIdentitySources /aaa/ldap-identity-sources?action=probe_ldap_server: post: consumes: - application/json description: |- Attempt to connect to an LDAP server and ensure that the server can be contacted using the given URL and authentication credentials. operationId: ProbeIdentitySourceLdapServer parameters: - in: body name: IdentitySourceLdapServer required: true schema: $ref: '#/definitions/IdentitySourceLdapServer' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/IdentitySourceLdapServerProbeResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Test an LDAP server tags: - System Administration - Settings - User Management - LDAP Identity Sources x-vmw-nsx-module: LdapIdentitySources /aaa/object-permissions: delete: consumes: - application/json description: |- Delete object-permissions entries operationId: DeleteObjectPermissions parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: false description: Does children of this object inherit this rule in: query name: inheritance_disabled required: false type: boolean - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - description: Path prefix in: query name: path_prefix required: false type: string - description: Role name in: query name: role_name required: false type: string - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete object-permissions entries tags: - System Administration - Settings - User Management - Authorization - Object Permissions x-vmw-nsx-module: PolicyAuthz get: consumes: - application/json description: |- Get list of Object-level RBAC entries. operationId: GetObjectPermissions parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: false description: Does children of this object inherit this rule in: query name: inheritance_disabled required: false type: boolean - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - description: Path prefix in: query name: path_prefix required: false type: string - description: Role name in: query name: role_name required: false type: string - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ObjectRolePermissionGroupListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get list of Object-level RBAC entries. tags: - System Administration - Settings - User Management - Authorization - Object Permissions x-vmw-nsx-module: PolicyAuthz patch: consumes: - application/json description: |- Create/update object permission mappings operationId: UpdateObjectPermissions parameters: - in: body name: ObjectRolePermissionGroup required: true schema: $ref: '#/definitions/ObjectRolePermissionGroup' produces: - application/json responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create/update object permission mappings tags: - System Administration - Settings - User Management - Authorization - Object Permissions x-vmw-nsx-module: PolicyAuthz /aaa/registration-token: post: consumes: - application/json description: |- The privileges of the registration token will be the same as the caller. operationId: CreateRegistrationToken produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/RegistrationToken' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create registration access token tags: - System Administration - Settings - User Management - Access Token x-vmw-nsx-module: RegistrationTokenEndPoint /aaa/registration-token/{token}: delete: consumes: - application/json description: |- Delete registration access token operationId: DeleteRegistrationToken parameters: - description: |- Registration token in: path name: token required: true type: string produces: - application/json responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete registration access token tags: - System Administration - Settings - User Management - Access Token x-vmw-nsx-module: RegistrationTokenEndPoint get: consumes: - application/json description: |- Get registration access token operationId: GetRegistrationToken parameters: - description: |- Registration token in: path name: token required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/RegistrationToken' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get registration access token tags: - System Administration - Settings - User Management - Access Token x-vmw-nsx-module: RegistrationTokenEndPoint /aaa/role-bindings: get: consumes: - application/json description: | Get all users and groups with their roles. operationId: GetAllRoleBindings parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Identity source ID in: query name: identity_source_id required: false type: string - description: Identity source type enum: - VIDM - LDAP - OIDC in: query name: identity_source_type required: false type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - description: User/Group name in: query name: name required: false type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - description: Role ID in: query name: role required: false type: string - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string - description: Type enum: - remote_user - remote_group - local_user - principal_identity in: query name: type required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/RoleBindingListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get all users and groups with their roles tags: - System Administration - Settings - User Management - Roles x-vmw-nsx-module: AAA post: consumes: - application/json description: | This API is used to assign a user/group any role(s) of choice. User has union of all the roles assigned to it. User name is dealt case-insensitively. operationId: CreateRoleBinding parameters: - in: body name: RoleBinding required: true schema: $ref: '#/definitions/RoleBinding' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/RoleBinding' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Assign roles to User or Group tags: - System Administration - Settings - User Management - Roles x-vmw-nsx-module: AAA /aaa/role-bindings/{binding-id}: delete: consumes: - application/json description: | Delete the user/group's role assignment. operationId: DeleteRoleBinding parameters: - description: |- User/Group's id in: path name: binding-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Identity source ID in: query name: identity_source_id required: false type: string - description: Identity source type enum: - VIDM - LDAP - OIDC in: query name: identity_source_type required: false type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - description: User/Group name in: query name: name required: false type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - description: Role ID in: query name: role required: false type: string - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string - description: Type enum: - remote_user - remote_group - local_user - principal_identity in: query name: type required: false type: string responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete user/group's roles assignment tags: - System Administration - Settings - User Management - Roles x-vmw-nsx-module: AAA get: consumes: - application/json description: |- Get user/group's role information operationId: GetRoleBinding parameters: - description: |- User/Group's id in: path name: binding-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Identity source ID in: query name: identity_source_id required: false type: string - description: Identity source type enum: - VIDM - LDAP - OIDC in: query name: identity_source_type required: false type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - description: User/Group name in: query name: name required: false type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - description: Role ID in: query name: role required: false type: string - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string - description: Type enum: - remote_user - remote_group - local_user - principal_identity in: query name: type required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/RoleBinding' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get user/group's role information tags: - System Administration - Settings - User Management - Roles x-vmw-nsx-module: AAA put: consumes: - application/json description: | This API is used to update a user/group any role(s) of choice. User name is dealt case-insensitively. operationId: UpdateRoleBinding parameters: - description: |- User/Group's id in: path name: binding-id required: true type: string - in: body name: RoleBinding required: true schema: $ref: '#/definitions/RoleBinding' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/RoleBinding' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Update User or Group's roles tags: - System Administration - Settings - User Management - Roles x-vmw-nsx-module: AAA /aaa/role-bindings?action=delete_stale_bindings: post: consumes: - application/json description: |- Delete all stale role assignments operationId: DeleteAllStaleRoleBindings parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Identity source ID in: query name: identity_source_id required: false type: string - description: Identity source type enum: - VIDM - LDAP - OIDC in: query name: identity_source_type required: false type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - description: User/Group name in: query name: name required: false type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - description: Role ID in: query name: role required: false type: string - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string - description: Type enum: - remote_user - remote_group - local_user - principal_identity in: query name: type required: false type: string responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete all stale role assignments tags: - System Administration - Settings - User Management - Roles x-vmw-nsx-module: AAA /aaa/roles: get: consumes: - application/json description: |- Get information about all roles operationId: GetAllRolesInfo produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/RoleListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get information about all roles tags: - System Administration - Settings - User Management - Roles x-vmw-nsx-module: AAA /aaa/roles-with-feature-permissions: get: consumes: - application/json description: |- Get information about all roles with features and their permissions operationId: ListRolesInfo parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/RoleWithFeaturesListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get information about all roles with features and their permissions tags: - System Administration - Settings - User Management - Roles x-vmw-nsx-module: AAA /aaa/roles/{role}: delete: consumes: - application/json description: | If a role is assigned to a role binding then the deletion of the role is not allowed. Precanned roles cannot be deleted. operationId: DeleteRole parameters: - description: |- Custom role id in: path name: role required: true type: string responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete custom role tags: - System Administration - Settings - User Management - Roles x-vmw-nsx-module: AAA get: consumes: - application/json description: |- Get role information operationId: GetRoleInfo parameters: - description: |- Role id in: path name: role required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/RoleWithFeatures' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get role information tags: - System Administration - Settings - User Management - Roles x-vmw-nsx-module: AAA put: consumes: - application/json description: | Creates a new role with id as <role> if there does not exist any role with id <role>, else updates the existing role. operationId: CreateOrUpdateRole parameters: - description: |- Custom role id in: path name: role required: true type: string - in: body name: RoleWithFeatures required: true schema: $ref: '#/definitions/RoleWithFeatures' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/RoleWithFeatures' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Update custom role tags: - System Administration - Settings - User Management - Roles x-vmw-nsx-module: AAA /aaa/roles/{role}?action=clone: post: consumes: - application/json description: | The role with id <role> is cloned and the new id, name and description are the ones provided in the request body. operationId: CloneRole parameters: - description: |- Role id in: path name: role required: true type: string - in: body name: NewRole required: true schema: $ref: '#/definitions/NewRole' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/NewRole' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Clone an already present role tags: - System Administration - Settings - User Management - Roles x-vmw-nsx-module: AAA /aaa/roles?action=validate: post: consumes: - application/json description: | Validate the permissions of an incoming role. Also, recommend the permissions which need to be corrected. operationId: ValidateAndRecommendPermissions parameters: - in: body name: FeaturePermissionArray required: true schema: $ref: '#/definitions/FeaturePermissionArray' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/RecommendedFeaturePermissionListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Validate a new feature permission set tags: - System Administration - Settings - User Management - Roles x-vmw-nsx-module: AAA /aaa/user-info: get: consumes: - application/json description: | This API will return the name and role information of the user invoking this API request. This API is available for all NSX users no matter their authentication method (Local account, VIDM, LDAP etc). operationId: GetCurrentUserInfo parameters: - description: Prefix path of the context in: query name: root_path required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/UserInfo' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get the name and role information of the user. tags: - System Administration - Settings - User Management - Users x-vmw-nsx-module: AAA /aaa/vidm/groups: get: consumes: - application/json description: |- Get all the User Groups where vIDM display name matches the search key case insensitively. The search key is checked to be a substring of display name. This is a non paginated API. This API will return as many results that vIDM returns to NSX during the search query. vIDM may not send all results at once so to zero in on the group of interest more characters need to be entered. operationId: GetGroupVidmSearchResult parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - description: 'Search string to search for. ' in: query name: search_string required: true type: string - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/VidmInfoListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get all the User Groups where vIDM display name matches the search key case insensitively. The search key is checked to be a substring of display name. This is a non paginated API. This API will return as many results that vIDM returns to NSX during the search query. vIDM may not send all results at once so to zero in on the group of interest more characters need to be entered. tags: - System Administration - Settings - User Management - VIDM Configuration x-vmw-nsx-module: AAA /aaa/vidm/search: post: consumes: - application/json description: |- Get all the users and groups from vIDM matching the search key case insensitively. The search key is checked to be a substring of name or given name or family name of user and display name of group. This is a non paginated API. This API will return as many results that vIDM returns to NSX during the search query. vIDM may not send all results at once so to zero in on the user/group of interest more characters need to be entered. operationId: GetVidmSearchResult parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - description: 'Search string to search for. ' in: query name: search_string required: true type: string - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/VidmInfoListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get all the users and groups from vIDM matching the search key case insensitively. The search key is checked to be a substring of name or given name or family name of user and display name of group. This is a non paginated API. This API will return as many results that vIDM returns to NSX during the search query. vIDM may not send all results at once so to zero in on the user/group of interest more characters need to be entered. tags: - System Administration - Settings - User Management - VIDM Configuration x-vmw-nsx-module: AAA /aaa/vidm/users: get: consumes: - application/json description: |- Get all the users from vIDM whose userName, givenName or familyName matches the search key case insensitively. The search key is checked to be a substring of name or given name or family name. This is a non paginated API. This API will return as many results that vIDM returns to NSX during the search query. vIDM may not send all results at once so to zero in on the user of interest more characters need to be entered. operationId: GetUserVidmSearchResult parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - description: 'Search string to search for. ' in: query name: search_string required: true type: string - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/VidmInfoListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get all the users from vIDM whose userName, givenName or familyName matches the search key case insensitively. The search key is checked to be a substring of name or given name or family name. This is a non paginated API. This API will return as many results that vIDM returns to NSX during the search query. vIDM may not send all results at once so to zero in on the user of interest more characters need to be entered. tags: - System Administration - Settings - User Management - VIDM Configuration x-vmw-nsx-module: AAA /alb/controller-nodes/cluster: get: consumes: - application/json description: | Returns information about Advanced Load Balancer controller cluster status operationId: ListALBControllerClusterInfo produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ALBControllerClusterInfo' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Returns information for Advanced Load Balancer controller cluster tags: - System Administration - Configuration - NSX Advanced Load Balancer - Controller - Cluster x-vmw-nsx-module: PolicyALBControllerDeployment put: consumes: - application/json description: | Re-trigger clustering for Advanced Load Balancer Nodes. operationId: RetriggerClustering produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ALBControllerClusterTrigger' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Re-trigger clustering for Advanced Load Balancer Nodes. tags: - System Administration - Configuration - NSX Advanced Load Balancer - Controller - Cluster x-vmw-nsx-module: PolicyALBControllerDeployment /alb/controller-nodes/clusterconfig: get: consumes: - application/json description: | Returns cluster configuration for the Advanced Load Balancer controller cluster. operationId: ReadALBControllerNodeClusterConfig produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ALBControllerNodeVMClusterConfig' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Returns info for of the cluster configuration for the Advanced Load Balancer controller cluster tags: - System Administration - Configuration - NSX Advanced Load Balancer - Controller - Cluster Config x-vmw-nsx-module: PolicyALBControllerDeployment post: consumes: - application/json description: | Set the cluster configuration for Advanced Load Balancer controller cluster. operationId: AddALBControllerNodeClusterConfig parameters: - in: body name: ALBControllerNodeVMClusterConfig required: true schema: $ref: '#/definitions/ALBControllerNodeVMClusterConfig' produces: - application/json responses: '201': description: Created schema: $ref: '#/definitions/ALBControllerNodeVMClusterConfig' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Set the cluster configuration for the Advanced Load Balancer controller VM. The VIP can be set once. Attempting to change the VIP once set will return an error. tags: - System Administration - Configuration - NSX Advanced Load Balancer - Controller - Cluster Config x-vmw-nsx-module: PolicyALBControllerDeployment /alb/controller-nodes/deployments: get: consumes: - application/json description: | Returns request information for every attempted deployment of a cluster node VM. operationId: ListALBControllerNodeVMDeploymentRequests parameters: - description: the current state of the Advanced Load Balancer controller VM enum: - DEPLOYED - PENDING in: query name: state type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ALBControllerNodeVMDeploymentRequestList' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Returns info for all cluster node VM auto-deployment attempts tags: - System Administration - Configuration - NSX Advanced Load Balancer - Controller - Deployments x-vmw-nsx-module: PolicyALBControllerDeployment post: consumes: - application/json description: | Deploys a Advanced Load Balancer controller node VM as specified by the deployment config. operationId: AddALBControllerNodeVM parameters: - in: body name: AddALBControllerNodeVMInfo required: true schema: $ref: '#/definitions/AddALBControllerNodeVMInfo' produces: - application/json responses: '201': description: Created schema: $ref: '#/definitions/ALBControllerNodeVMDeploymentRequestList' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Deploy and register a Advanced Load Balancer controller node VM tags: - System Administration - Configuration - NSX Advanced Load Balancer - Controller - Deployments x-vmw-nsx-module: PolicyALBControllerDeployment /alb/controller-nodes/deployments/{node-id}: get: consumes: - application/json description: | Returns deployment request information for a specific attempted deployment of a cluster node VM. operationId: ReadALBControllerNodeVMDeploymentRequest parameters: - in: path name: node-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ALBControllerNodeVMDeploymentRequest' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Returns info for a Advanced Load Balancer controller deployment attempt tags: - System Administration - Configuration - NSX Advanced Load Balancer - Controller - Deployments x-vmw-nsx-module: PolicyALBControllerDeployment put: consumes: - application/json description: | Update Advanced Load Balancer Controller node VM details operationId: UpdateALBControllerNodeVMDeploymentRequest parameters: - in: path name: node-id required: true type: string - in: body name: ALBControllerNodeVMDeploymentRequest required: true schema: $ref: '#/definitions/ALBControllerNodeVMDeploymentRequest' - description: Update Advanced Load Balancer Controller runtime config as well in: query name: running_config type: boolean produces: - application/json responses: '201': description: Created schema: $ref: '#/definitions/ALBControllerNodeVMDeploymentRequest' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Update a Advanced Load Balancer controller cluster node VM. Only updating password, ntp and dns servers are supported. If controller is in a cluster then all nodes in the cluster are updated with the provided values tags: - System Administration - Configuration - NSX Advanced Load Balancer - Controller - Deployments x-vmw-nsx-module: PolicyALBControllerDeployment /alb/controller-nodes/deployments/{node-id}/status: get: consumes: - application/json description: | Returns the current deployment or undeployment status for a VM along with any other relevant current information, such as error messages. operationId: ReadALBControllerNodeVMDeploymentStatus parameters: - in: path name: node-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ALBControllerNodeVMDeploymentStatusReport' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Returns the status of the VM creation/deletion tags: - System Administration - Configuration - NSX Advanced Load Balancer - Controller - Deployments x-vmw-nsx-module: PolicyALBControllerDeployment /alb/controller-nodes/deployments/{node-id}?action=delete: post: consumes: - application/json description: | Attempts to unregister and undeploy a specified auto-deployed cluster node VM. If it is a member of a cluster, then the VM will be automatically detached from the cluster before being unregistered and undeployed. Alternatively, if the original deployment attempt failed or the VM is not found, cleans up the deployment information associated with the deployment attempt. Note: If a VM has been successfully auto-deployed, then the associated deployment information will not be deleted unless and until the VM is successfully deleted. operationId: DeleteAutoDeployedALBControllerNodeVM parameters: - in: path name: node-id required: true type: string - description: Delete by force in: query name: force_delete type: boolean - description: Delete when controller is inaccessible in: query name: inaccessible type: string responses: '202': description: Accepted '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Attempt to delete an auto-deployed Advanced Load Balancer controller node tags: - System Administration - Configuration - NSX Advanced Load Balancer - Controller - Deployments x-vmw-nsx-module: PolicyALBControllerDeployment /alb/controller-nodes/form-factors: get: consumes: - application/json description: | Returns information about all form factors available for Advanced Load Balancer controller nodes. operationId: ListALBControllerFormFactors produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ALBControllerNodeFormFactors' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List available Advanced Load Balancer controller form factors tags: - System Administration - Configuration - NSX Advanced Load Balancer - Controller - Form Factors x-vmw-nsx-module: PolicyALBControllerDeployment /batch: post: consumes: - application/json description: | Enables you to make multiple API requests using a single request. The batch API takes in an array of logical HTTP requests represented as JSON arrays. Each request has a method (GET, PUT, POST, or DELETE), a relative_url (the portion of the URL after https://<nsx-mgr>/api/), optional headers array (corresponding to HTTP headers) and an optional body (for POST and PUT requests). The batch API returns an array of logical HTTP responses represented as JSON arrays. Each response has a status code, an optional headers array and an optional body (which is a JSON-encoded string). operationId: RegisterBatchRequest parameters: - in: body name: BatchRequest required: true schema: $ref: '#/definitions/BatchRequest' - default: false description: Ignored (transactional atomicity flag) in: query name: atomic required: false type: boolean produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/BatchResponse' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Register a Collection of API Calls at a Single End Point tags: - System Administration - Configuration - NSX Managers - API Services - API Request Batching x-vmw-nsx-module: Batch /cluster/backups/config: get: consumes: - application/json description: | Get a configuration of a file server and timers for automated backup. Fields that contain secrets (password, passphrase) are not returned. operationId: GetBackupConfig produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/BackupConfiguration' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get backup configuration tags: - System Administration - Lifecycle Management - Backup Restore Management - Backup x-vmw-nsx-module: BackupConfiguration put: consumes: - application/json description: | Configure file server and timers for automated backup. If secret fields are omitted (password, passphrase) then use the previously set value. operationId: ConfigureBackupConfig parameters: - in: body name: BackupConfiguration required: true schema: $ref: '#/definitions/BackupConfiguration' - default: LOCAL_LOCAL_MANAGER description: Frame type enum: - GLOBAL_MANAGER - LOCAL_MANAGER - LOCAL_LOCAL_MANAGER - NSX_INTELLIGENCE in: query name: frame_type required: false type: string - default: localhost description: Site ID in: query name: site_id required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/BackupConfiguration' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Configure backup tags: - System Administration - Lifecycle Management - Backup Restore Management - Backup x-vmw-nsx-module: BackupConfiguration /cluster/backups/history: get: consumes: - application/json description: | Get history of previous backup operations operationId: GetBackupHistory produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/BackupOperationHistory' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get backup history tags: - System Administration - Lifecycle Management - Backup Restore Management - Backup x-vmw-nsx-module: BackupConfiguration /cluster/backups/overview: get: consumes: - application/json description: | Get a configuration of a file server, timers for automated backup, latest backup status, backups list for a site. Fields that contain secrets (password, passphrase) are not returned. operationId: GetBackupOverview parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: LOCAL_LOCAL_MANAGER description: Frame type enum: - GLOBAL_MANAGER - LOCAL_MANAGER - LOCAL_LOCAL_MANAGER - NSX_INTELLIGENCE in: query name: frame_type required: false type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - default: true description: Need a list of backups in: query name: show_backups_list required: false type: boolean - default: localhost description: UUID of the site in: query name: site_id required: false type: string - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/BackupOverview' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get all backup related information for a site tags: - System Administration - Lifecycle Management - Backup Restore Management - Backup x-vmw-nsx-module: BackupConfiguration /cluster/backups/status: get: consumes: - application/json description: | Get status of active backup operations operationId: GetBackupStatus produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/CurrentBackupOperationStatus' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get backup status tags: - System Administration - Lifecycle Management - Backup Restore Management - Backup x-vmw-nsx-module: BackupConfiguration /cluster/backups?action=retrieve_ssh_fingerprint: post: consumes: - application/json description: | Get SHA256 fingerprint of ECDSA key of remote server. The caller should independently verify that the key is trusted. operationId: GetSshFingerprintOfServer parameters: - in: body name: RemoteServerFingerprintRequest required: true schema: $ref: '#/definitions/RemoteServerFingerprintRequest' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/RemoteServerFingerprint' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get ssh fingerprint of remote(backup) server tags: - System Administration - Lifecycle Management - Backup Restore Management - Backup x-vmw-nsx-module: BackupConfiguration /cluster/restore/backuptimestamps: get: consumes: - application/json description: | Returns timestamps for all backup files that are available on the SFTP server. operationId: ListClusterBackupTimestamps parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ClusterBackupInfoListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List timestamps of all available Cluster Backups. tags: - System Administration - Lifecycle Management - Backup Restore Management - Restore x-vmw-nsx-module: ClusterRestore /cluster/restore/config: get: consumes: - application/json description: | Deprecated. Please use API /cluster/backups/config, to get remote file server(where backuped-up files are stored) details durign restore. In older versions - Get configuration information for the file server used to store backed-up files. Fields that contain secrets (password, passphrase) are not returned. operationId: GetRestoreConfig produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/RestoreConfiguration' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Deprecated. Get Restore configuration tags: - System Administration - Lifecycle Management - Backup Restore Management - Restore x-vmw-nsx-module: BackupConfiguration put: consumes: - application/json description: | Deprecated. Please use API /cluster/backups/config, to configure remote file server(where backed-up files are stored) details during restore. In older versions - Configure file server where the backed-up files used for the Restore operation are available. operationId: ConfigureRestoreConfig parameters: - in: body name: RestoreConfiguration required: true schema: $ref: '#/definitions/RestoreConfiguration' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/RestoreConfiguration' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Deprecated. Configure Restore SFTP server credentials tags: - System Administration - Lifecycle Management - Backup Restore Management - Restore x-vmw-nsx-module: BackupConfiguration /cluster/restore/instruction-resources: get: consumes: - application/json description: | For restore operations requiring user input e.g. performing an action, accepting/rejecting an action, etc. the information to be conveyed to users is provided in this call. operationId: ListRestoreInstructionResources parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - description: Id of the instruction set whose instructions are to be returned in: query name: instruction_id required: true type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ActionableResourceListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: | List resources for a given instruction, to be shown to/executed by users. tags: - System Administration - Lifecycle Management - Backup Restore Management - Restore x-vmw-nsx-module: ClusterRestore /cluster/restore?action=advance: post: consumes: - application/json description: | Advance any currently suspended restore operation. The operation might have been suspended because (1) the user had suspended it previously, or (2) the operation is waiting for user input, to be provided as a part of the POST request body. This operation is only valid when a GET cluster/restore/status returns a status with value SUSPENDED. Otherwise, a 409 response is returned. operationId: AdvanceClusterRestore parameters: - in: body name: AdvanceClusterRestoreRequest required: true schema: $ref: '#/definitions/AdvanceClusterRestoreRequest' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ClusterRestoreStatus' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '409': description: Conflict schema: $ref: '#/definitions/ClusterRestoreStatus' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Advance any suspended restore operation tags: - System Administration - Lifecycle Management - Backup Restore Management - Restore x-vmw-nsx-module: ClusterRestore /cluster/restore?action=cancel: post: consumes: - application/json description: | This operation is only valid when a restore is in suspended state. The UI user can cancel any restore operation when the restore is suspended either due to an error, or for a user input. The API user would need to monitor the progression of a restore by calling periodically "/api/v1/cluster/restore/status" API. The response object (ClusterRestoreStatus), contains a field "endpoints". The API user can cancel the restore process if 'cancel' action is shown in the endpoint field. This operation is only valid when a GET cluster/restore/status returns a status with value SUSPENDED. operationId: CancelClusterRestore produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ClusterRestoreStatus' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '409': description: Conflict schema: $ref: '#/definitions/ClusterRestoreStatus' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Cancel any running restore operation tags: - System Administration - Lifecycle Management - Backup Restore Management - Restore x-vmw-nsx-module: ClusterRestore /cluster/restore?action=retry: post: consumes: - application/json description: | Retry any currently in-progress, failed restore operation. Only the last step of the multi-step restore operation would have failed,and only that step is retried. This operation is only valid when a GET cluster/restore/status returns a status with value FAILED. Otherwise, a 409 response is returned. operationId: RetryClusterRestore produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ClusterRestoreStatus' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '409': description: Conflict schema: $ref: '#/definitions/ClusterRestoreStatus' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Retry any failed restore operation tags: - System Administration - Lifecycle Management - Backup Restore Management - Restore x-vmw-nsx-module: ClusterRestore /cluster/restore?action=start: post: consumes: - application/json description: | Start the restore of an NSX cluster, from some previously backed-up configuration. This operation is only valid when a GET cluster/restore/status returns a status with value NOT_STARTED. Otherwise, a 409 response is returned. operationId: InitiateClusterRestore parameters: - in: body name: InitiateClusterRestoreRequest required: true schema: $ref: '#/definitions/InitiateClusterRestoreRequest' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ClusterRestoreStatus' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '409': description: Conflict schema: $ref: '#/definitions/ClusterRestoreStatus' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Initiate a restore operation tags: - System Administration - Lifecycle Management - Backup Restore Management - Restore x-vmw-nsx-module: ClusterRestore /cluster/restore?action=suspend: post: consumes: - application/json description: | Suspend any currently running restore operation. The restore operation is made up of a number of steps. When this call is issued, any currently running step is allowed to finish (successfully or with errors), and the next step (and therefore the entire restore operation) is suspended until a subsequent resume or cancel call is issued. This operation is only valid when a GET cluster/restore/status returns a status with value RUNNING. Otherwise, a 409 response is returned. operationId: SuspendClusterRestore produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ClusterRestoreStatus' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '409': description: Conflict schema: $ref: '#/definitions/ClusterRestoreStatus' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Suspend any running restore operation tags: - System Administration - Lifecycle Management - Backup Restore Management - Restore x-vmw-nsx-module: ClusterRestore /cluster?action=backup_to_remote: post: consumes: - application/json description: | Request one-time backup. The backup will be uploaded using the same server configuration as for automatic backup. operationId: RequestOnetimeBackup parameters: - default: LOCAL_LOCAL_MANAGER description: Frame type enum: - GLOBAL_MANAGER - LOCAL_MANAGER - LOCAL_LOCAL_MANAGER - NSX_INTELLIGENCE in: query name: frame_type required: false type: string - default: localhost description: Site ID in: query name: site_id required: false type: string responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Request one-time backup tags: - System Administration - Lifecycle Management - Backup Restore Management - Backup x-vmw-nsx-module: BackupConfiguration /cluster?action=summarize_inventory_to_remote: post: consumes: - application/json description: | Request one-time inventory summary. The backup will be uploaded using the same server configuration as for an automatic backup. operationId: RequestOnetimeInventorySummary responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Request one-time inventory summary. tags: - System Administration - Lifecycle Management - Backup Restore Management - Backup x-vmw-nsx-module: BackupConfiguration /compliance/status: get: consumes: - application/json description: |- Returns the compliance status and details of non compliant configuration operationId: GetPolicyComplianceStatus produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyComplianceStatus' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Returns the compliance status tags: - Policy - Monitoring - Compliance x-vmw-nsx-module: PolicyCompliance /configs/management: get: consumes: - application/json description: | Returns the NSX Management nodes global configuration. operationId: ReadManagementConfig produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ManagementConfig' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read NSX Management nodes global configuration. tags: - System Administration - Configuration - NSX Managers - Manager Configuration x-vmw-nsx-module: ConfigManagement put: consumes: - application/json description: |- Modifies the NSX Management nodes global configuration. operationId: UpdateManagementConfig parameters: - in: body name: ManagementConfig required: true schema: $ref: '#/definitions/ManagementConfig' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ManagementConfig' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Update NSX Management nodes global configuration tags: - System Administration - Configuration - NSX Managers - Manager Configuration x-vmw-nsx-module: ConfigManagement /enforcement-points/{enforcement-point-id}/service-definitions: get: consumes: - application/json description: | List all Service Definitions registered on given enforcement point. operationId: ListServiceDefinitions parameters: - description: |- Enforcement point id in: path name: enforcement-point-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ServiceInsertionServiceListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List all Service Definitions registered on given enforcement point. tags: - Policy - Security - Service Insertion - Service Definitions x-vmw-nsx-module: PolicyServiceInsertion post: consumes: - application/json description: |- Create a Service Definition on given enforcement point. operationId: CreateServiceDefinition parameters: - description: |- Enforcement point id in: path name: enforcement-point-id required: true type: string - in: body name: ServiceDefinition required: true schema: $ref: '#/definitions/ServiceDefinition' produces: - application/json responses: '201': description: Created schema: $ref: '#/definitions/ServiceDefinition' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create a Service Definition on given enforcement point. tags: - Policy - Security - Service Insertion - Service Definitions x-vmw-nsx-module: PolicyServiceInsertion /enforcement-points/{enforcement-point-id}/service-definitions/{service-definition-id}: delete: consumes: - application/json description: | Delete an existing Service Definition on the given enforcement point. operationId: DeleteServiceDefinition parameters: - description: |- Enforcement point id in: path name: enforcement-point-id required: true type: string - description: |- Id of service definition in: path name: service-definition-id required: true type: string responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: | Delete an existing Service Definition on the given enforcement point tags: - Policy - Security - Service Insertion - Service Definitions x-vmw-nsx-module: PolicyServiceInsertion get: consumes: - application/json description: | Read Service Definition with given service-definition-id. operationId: ReadServiceDefinition parameters: - description: |- Enforcement point id in: path name: enforcement-point-id required: true type: string - description: |- Id of service definition in: path name: service-definition-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ServiceDefinition' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read Service Definition with given service-definition-id. tags: - Policy - Security - Service Insertion - Service Definitions x-vmw-nsx-module: PolicyServiceInsertion put: consumes: - application/json description: | Update an existing Service Definition on the given enforcement point. operationId: UpdateServiceDefinition parameters: - description: |- Enforcement point id in: path name: enforcement-point-id required: true type: string - description: |- Id of service definition in: path name: service-definition-id required: true type: string - in: body name: ServiceDefinition required: true schema: $ref: '#/definitions/ServiceDefinition' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ServiceDefinition' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: | Update an existing Service Definition on the given enforcement point tags: - Policy - Security - Service Insertion - Service Definitions x-vmw-nsx-module: PolicyServiceInsertion /error-resolver: get: consumes: - application/json description: | Returns a list of metadata for all the error resolvers registered. operationId: ListErrorResolverInfo produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ErrorResolverInfoList' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Fetches a list of metadata for all the registered error resolvers tags: - System Administration - Monitoring - Error Resolver x-vmw-nsx-module: ErrorResolver /error-resolver/{error_id}: get: consumes: - application/json description: | Returns some metadata about the given error_id. This includes information of whether there is a resolver present for the given error_id and its associated user input data operationId: GetErrorResolverInfo parameters: - in: path name: error_id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ErrorResolverInfo' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Fetches metadata about the given error_id tags: - System Administration - Monitoring - Error Resolver x-vmw-nsx-module: ErrorResolver /error-resolver?action=resolve_error: post: consumes: - application/json description: | Invokes the corresponding error resolver for the given error(s) present in the payload operationId: ResolveError parameters: - in: body name: ErrorResolverMetadataList required: true schema: $ref: '#/definitions/ErrorResolverMetadataList' responses: '204': description: No Content '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Resolves the error tags: - System Administration - Monitoring - Error Resolver x-vmw-nsx-module: ErrorResolver /eula/accept: post: consumes: - application/json description: | Accept end user license agreement operationId: AcceptEULA produces: - application/json responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: | Accept end user license agreement tags: - System Administration - Settings - Licenses x-vmw-nsx-module: EULA /eula/acceptance: get: consumes: - application/json description: | Return the acceptance status of end user license agreement operationId: GetEULAAcceptance produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/EULAAcceptance' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: | Return the acceptance status of end user license agreement tags: - System Administration - Settings - Licenses x-vmw-nsx-module: EULA /eula/content: get: consumes: - application/json description: | Return the content of end user license agreement in the specified format. By default, it's pure string without line break operationId: GetEULAContent parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string - description: End User License Agreement content output format in: query name: value_format type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/EULAContent' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: | Return the content of end user license agreement tags: - System Administration - Settings - Licenses x-vmw-nsx-module: EULA /fine-tuning/resources: get: consumes: - application/json description: | This API provides field names of attributes in NSX types that are owned by Policy, as opposed to those owned by the enforcement point. For any type on NSX, some of the attributes of that type may be owned and set by Policy when realizing the intent, while some others may be owned and set by the enforcement point itself. This information can be used to disable updates to Policy owned attributes by the advanced networking UI, while allowing tweaking to the attributes owned by the management plane. operationId: ListResourceInfo parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string - description: Type query in: query name: type required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ResourceInfoListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- For each type of entity what are the attributes owned by policy. tags: - Policy - Monitoring - Finetuning x-vmw-nsx-module: PolicyFineTuning /global-infra: get: consumes: - application/json description: | Read infra. Returns only the infra related properties. Inner object are not populated. operationId: GlobalInfraReadInfra parameters: - description: Base Path for retrieving hierarchical intent in: query name: base_path required: false type: string - description: Filter string as java regex in: query name: filter required: false type: string - description: Filter string to retrieve hierarchy. in: query name: type_filter required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/Infra' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read infra tags: - Policy - Infra - Hierarchical API x-vmw-nsx-module: Policy patch: consumes: - application/json description: | Patch API at infra level can be used in two flavours 1. Like a regular API to update Infra object 2. Hierarchical API: To create/update/delete entire or part of intent hierarchy Hierarchical API: Provides users a way to create entire or part of intent in single API invocation. Input is expressed in a tree format. Each node in tree can have multiple children of different types. System will resolve the dependecies of nodes within the intent tree and will create the model. Children for any node can be specified using ChildResourceReference or ChildPolicyConfigResource. If a resource is specified using ChildResourceReference then it will not be updated only its children will be updated. If Object is specified using ChildPolicyConfigResource, object along with its children will be updated. Hierarchical API can also be used to delete any sub-branch of entire tree. operationId: GlobalInfraPatchInfra parameters: - in: body name: Infra required: true schema: $ref: '#/definitions/Infra' - default: false description: Force revision check in: query name: enforce_revision_check required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Update the infra including all the nested entities tags: - Policy - Infra - Hierarchical API x-vmw-nsx-module: Policy /global-infra/bfd-profiles: get: consumes: - application/json description: | Paginated list of all BfdProfiles. operationId: GlobalInfraListBfdProfile parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/BfdProfileListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List BfdProfiles tags: - Policy - Networking - Networking Profiles - BFD Profiles x-vmw-nsx-module: PolicyConnectivity /global-infra/bfd-profiles/{bfd-profile-id}: delete: consumes: - application/json description: |- Delete BFD Config and all the entities contained by this BfdProfile. operationId: GlobalInfraDeleteBfdProfile parameters: - description: |- BfdProfile ID in: path name: bfd-profile-id required: true type: string - default: false description: Locally override the global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete BFD Config and all the entities contained by this BfdProfile tags: - Policy - Networking - Networking Profiles - BFD Profiles x-vmw-nsx-module: PolicyConnectivity get: consumes: - application/json description: |- Read a BfdProfile. operationId: GlobalInfraReadBfdProfile parameters: - description: |- BfdProfile ID in: path name: bfd-profile-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/BfdProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read a BfdProfile tags: - Policy - Networking - Networking Profiles - BFD Profiles x-vmw-nsx-module: PolicyConnectivity patch: consumes: - application/json description: | If a BfdProfile with the bfd-profile-id is not already present, create a new BfdProfile. If it already exists, update the BfdProfile. This operation will fully replace the object. operationId: GlobalInfraPatchBfdProfile parameters: - description: |- BfdProfile ID in: path name: bfd-profile-id required: true type: string - in: body name: BfdProfile required: true schema: $ref: '#/definitions/BfdProfile' - default: false description: Locally override the global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or update a BfdProfile tags: - Policy - Networking - Networking Profiles - BFD Profiles x-vmw-nsx-module: PolicyConnectivity put: consumes: - application/json description: | If a BfdProfile with the bfd-profile-id is not already present, create a new BfdProfile. If it already exists, update the BfdProfile. This operation will fully replace the object. operationId: GlobalInfraUpdateBfdProfile parameters: - description: |- BfdProfile ID in: path name: bfd-profile-id required: true type: string - in: body name: BfdProfile required: true schema: $ref: '#/definitions/BfdProfile' - default: false description: Locally override the global object in: query name: override required: false type: boolean produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/BfdProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or update a BfdProfile tags: - Policy - Networking - Networking Profiles - BFD Profiles x-vmw-nsx-module: PolicyConnectivity /global-infra/certificates: get: consumes: - application/json description: | Returns all certificate information viewable by the user, including each certificate's id; pem_encoded data; and history of the certificate (who created or modified it and when). For additional information, include the ?details=true modifier at the end of the request URI. operationId: GlobalInfraListTlsCertificates parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: whether to expand the pem data and show all its details in: query name: details required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string - description: Type of certificate to return enum: - cluster_api_certificate in: query name: type required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/TlsCertificateList' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Return All the User-Facing Components' Certificates tags: - Policy - Infra - Certificates - Certificates x-vmw-nsx-module: PolicyCertificate /global-infra/certificates/{certificate-id}: get: consumes: - application/json description: | Returns information for the specified certificate ID, including the certificate's id; pem_encoded data; and history of the certificate (who created or modified it and when). For additional information, include the ?details=true modifier at the end of the request URI. operationId: GlobalInfraGetTlsCertificate parameters: - description: |- ID of certificate to read in: path name: certificate-id required: true type: string - default: false description: whether to expand the pem data and show all its details in: query name: details required: false type: boolean produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/TlsCertificate' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Show Certificate Data for the Given Certificate ID tags: - Policy - Infra - Certificates - Certificates x-vmw-nsx-module: PolicyCertificate /global-infra/constraints: get: consumes: - application/json description: |- List tenant constraints. operationId: GlobalInfraListTenantConstraints parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ConstraintListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List tenant Constraints. tags: - Policy - Infra - Constraints x-vmw-nsx-module: PolicyConstraints /global-infra/constraints/{constraint-id}: get: consumes: - application/json description: |- Read tenant constraint. operationId: GlobalInfraReadTenantConstraint parameters: - in: path name: constraint-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/Constraint' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read tenant Constraint. tags: - Policy - Infra - Constraints x-vmw-nsx-module: PolicyConstraints /global-infra/context-profiles: get: consumes: - application/json description: | Get all PolicyContextProfiles operationId: GlobalInfraListPolicyContextProfiles parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyContextProfileListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get PolicyContextProfiles tags: - Policy - Inventory - Profiles - Context Profiles x-vmw-nsx-module: PolicyContextProfile /global-infra/context-profiles/attributes: get: consumes: - application/json description: | Returns supported attribute and sub-attributes for specified attribute key with their supported values, if provided in query/request parameter, else will fetch all supported attributes and sub-attributes for all supported attribute keys. Alternatively, to get a list of supported attributes and sub-attributes fire the following REST API GET https://<policy-mgr>/policy/api/v1/infra/context-profiles/attributes operationId: GlobalInfraListProfileSupportedAttributes parameters: - description: Fetch attributes and sub-attributes for the given attribute key in: query name: attribute_key required: false type: string - default: SYSTEM description: Source of the attribute, System Defined or custom enum: - ALL - CUSTOM - SYSTEM in: query name: attribute_source required: false type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyContextProfileListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Policy Context Profile supported attributes and sub-attributes tags: - Policy - Inventory - Profiles - Context Profiles x-vmw-nsx-module: PolicyContextProfile /global-infra/context-profiles/custom-attributes: patch: consumes: - application/json description: | This API updates custom attribute value list for given key. operationId: GlobalInfraPatchCustomAttributeList parameters: - in: body name: PolicyAttributes required: true schema: $ref: '#/definitions/PolicyAttributes' responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Update custom object attribute value list for given attribute key tags: - Policy - Inventory - Profiles - Context Profiles x-vmw-nsx-module: PolicyContextProfile post: consumes: - application/json description: | This API adds/removes custom attribute values from list for a given attribute key. operationId: GlobalInfraAddRemoveCustomAttributeValues parameters: - in: body name: PolicyAttributes required: true schema: $ref: '#/definitions/PolicyAttributes' - description: Add or Remove Custom Context Profile Attribute values. enum: - add - remove in: query name: action required: true type: string responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Adds/Removes custom attribute values from list tags: - Policy - Inventory - Profiles - Context Profiles x-vmw-nsx-module: PolicyContextProfile /global-infra/context-profiles/custom-attributes/default: get: consumes: - application/json description: | This API updates custom attribute value list for given key. operationId: GlobalInfraGetCustomAttribute parameters: - description: Fetch attributes and sub-attributes for the given attribute key in: query name: attribute_key required: false type: string - default: SYSTEM description: Source of the attribute, System Defined or custom enum: - ALL - CUSTOM - SYSTEM in: query name: attribute_source required: false type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyContextProfileListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Update custom object attribute value list for given attribute key tags: - Policy - Inventory - Profiles - Context Profiles x-vmw-nsx-module: PolicyContextProfile patch: consumes: - application/json description: | This API updates custom attribute value list for given key. operationId: GlobalInfraPatchCustomAttribute parameters: - in: body name: PolicyCustomAttributes required: true schema: $ref: '#/definitions/PolicyCustomAttributes' responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Update custom object attribute value list for given attribute key tags: - Policy - Inventory - Profiles - Context Profiles x-vmw-nsx-module: PolicyContextProfile post: consumes: - application/json description: | This API adds/removes custom attribute values from list for a given attribute key. operationId: GlobalInfraAddRemoveCustomAttribute parameters: - in: body name: PolicyCustomAttributes required: true schema: $ref: '#/definitions/PolicyCustomAttributes' - description: Add or Remove Custom Context Profile Attribute values. enum: - add - remove in: query name: action required: true type: string responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Adds/Removes custom attribute values from list tags: - Policy - Inventory - Profiles - Context Profiles x-vmw-nsx-module: PolicyContextProfile /global-infra/context-profiles/{context-profile-id}: delete: consumes: - application/json description: | Deletes the specified Policy Context Profile. If the Policy Context Profile is consumed in a firewall rule, it won't get deleted. operationId: GlobalInfraDeletePolicyContextProfile parameters: - description: |- Policy Context Profile Id in: path name: context-profile-id required: true type: string - default: false description: 'Force delete the resource even if it is being used somewhere ' in: query name: force type: boolean - default: false description: Delete the locally overriden global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete Policy Context Profile tags: - Policy - Inventory - Profiles - Context Profiles x-vmw-nsx-module: PolicyContextProfile get: consumes: - application/json description: | Get a single PolicyContextProfile by id operationId: GlobalInfraGetPolicyContextProfile parameters: - in: path name: context-profile-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyContextProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get PolicyContextProfile tags: - Policy - Inventory - Profiles - Context Profiles x-vmw-nsx-module: PolicyContextProfile patch: consumes: - application/json description: | Creates/Updates a PolicyContextProfile, which encapsulates attribute and sub-attributes of network services. Rules for using attributes and sub-attributes in single PolicyContextProfile 1. One type of attribute can't have multiple occurrences. ( Eg. - Attribute type APP_ID can be used only once per PolicyContextProfile.) 2. For specifying multiple values for an attribute, provide them in an array. 3. If sub-attribtes are mentioned for an attribute, then only single value is allowed for that attribute. 4. To get a list of supported attributes and sub-attributes fire the following REST API GET https://<policy-mgr>/policy/api/v1/infra/context-profiles/attributes operationId: GlobalInfraPatchCreateOrUpdatePolicyContextProfile parameters: - in: path name: context-profile-id required: true type: string - in: body name: PolicyContextProfile required: true schema: $ref: '#/definitions/PolicyContextProfile' - default: false description: Locally override the global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create PolicyContextProfile tags: - Policy - Inventory - Profiles - Context Profiles x-vmw-nsx-module: PolicyContextProfile put: consumes: - application/json description: | Creates/Updates a PolicyContextProfile, which encapsulates attribute and sub-attributes of network services. Rules for using attributes and sub-attributes in single PolicyContextProfile 1. One type of attribute can't have multiple occurrences. ( Eg. - Attribute type APP_ID can be used only once per PolicyContextProfile.) 2. For specifying multiple values for an attribute, provide them in an array. 3. If sub-attribtes are mentioned for an attribute, then only single value is allowed for that attribute. 4. To get a list of supported attributes and sub-attributes fire the following REST API GET https://<policy-mgr>/policy/api/v1/infra/context-profiles/attributes operationId: GlobalInfraPutCreateOrUpdatePolicyContextProfile parameters: - in: path name: context-profile-id required: true type: string - in: body name: PolicyContextProfile required: true schema: $ref: '#/definitions/PolicyContextProfile' - default: false description: Locally override the global object in: query name: override required: false type: boolean produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyContextProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create PolicyContextProfile tags: - Policy - Inventory - Profiles - Context Profiles x-vmw-nsx-module: PolicyContextProfile /global-infra/crls: get: consumes: - application/json description: | Returns information about all CRLs. For additional information, include the ?details=true modifier at the end of the request URI. operationId: GlobalInfraListTlsCrls parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: whether to expand the pem data and show all its details in: query name: details required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string - description: Type of certificate to return enum: - cluster_api_certificate in: query name: type required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/TlsCrlListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Return All Added CRLs tags: - Policy - Infra - Certificates - Certification Revocation List x-vmw-nsx-module: PolicyCertificate /global-infra/crls/{crl-id}: get: consumes: - application/json description: | Returns information about the specified CRL. For additional information, include the ?details=true modifier at the end of the request URI. operationId: GlobalInfraGetTlsCrl parameters: - in: path name: crl-id required: true type: string - default: false description: whether to expand the pem data and show all its details in: query name: details required: false type: boolean produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/TlsCrl' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Show CRL Data for the Given CRL id. tags: - Policy - Infra - Certificates - Certification Revocation List x-vmw-nsx-module: PolicyCertificate /global-infra/dhcp-relay-configs: get: consumes: - application/json description: | Paginated list of all DHCP relay config instances operationId: GlobalInfraListDhcpRelayConfig parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/DhcpRelayConfigListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List DHCP relay config instances tags: - Policy - Networking - IP Management - DHCP - DHCP Relay Configs x-vmw-nsx-module: PolicyConnectivity /global-infra/dhcp-relay-configs/{dhcp-relay-config-id}: get: consumes: - application/json description: |- Read DHCP relay configuration operationId: GlobalInfraReadDhcpRelayConfig parameters: - description: |- DHCP relay config ID in: path name: dhcp-relay-config-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/DhcpRelayConfig' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read DHCP relay configuration tags: - Policy - Networking - IP Management - DHCP - DHCP Relay Configs x-vmw-nsx-module: PolicyConnectivity /global-infra/dhcp-server-configs: get: consumes: - application/json description: | Paginated list of all DHCP server config instances operationId: GlobalInfraListDhcpServerConfig parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/DhcpServerConfigListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List DHCP server config instances tags: - Policy - Networking - IP Management - DHCP - DHCP Server Configs x-vmw-nsx-module: PolicyConnectivity /global-infra/dhcp-server-configs/{config-id}/leases: get: consumes: - application/json description: |- Read DHCP server leases operationId: GlobalInfraReadDhcpServerLeases parameters: - in: path name: config-id required: true type: string - description: IP or MAC address in: query name: address required: false type: string - description: String Path of Tier0, Tier1 or Segment in: query name: connectivity_path required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - description: Segment path to retrieve lease information in: query name: segment_path required: false type: string - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string - description: Data source type. enum: - realtime - cached in: query name: source required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/DhcpLeasesResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read DHCP server leases tags: - Policy - Networking - IP Management - DHCP - DHCP Server Configs x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/dhcp-server-configs/{config-id}/state: get: consumes: - application/json description: |- Read DHCP server state operationId: GlobalInfraReadDhcpServerState parameters: - in: path name: config-id required: true type: string - description: String Path of Tier0, Tier1 or Segment in: query name: connectivity_path required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/DhcpServerState' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read DHCP server state tags: - Policy - Networking - IP Management - DHCP - DHCP Server Configs x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/dhcp-server-configs/{config-id}/stats: get: consumes: - application/json description: |- Read DHCP server statistics operationId: GlobalInfraReadDhcpServerStats parameters: - in: path name: config-id required: true type: string - description: String Path of Tier0, Tier1 or Segment in: query name: connectivity_path required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/DhcpServerStatistics' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read DHCP server statistics tags: - Policy - Networking - IP Management - DHCP - DHCP Server Configs x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/dhcp-server-configs/{config-id}/status: get: consumes: - application/json description: |- Read DHCP server status operationId: GlobalInfraReadDhcpServerStatus parameters: - in: path name: config-id required: true type: string - description: String Path of Tier0, Tier1 or Segment in: query name: connectivity_path required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/DhcpServerStatus' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read DHCP server status tags: - Policy - Networking - IP Management - DHCP - DHCP Server Configs x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/dhcp-server-configs/{dhcp-server-config-id}: get: consumes: - application/json description: |- Read DHCP server configuration operationId: GlobalInfraReadDhcpServerConfig parameters: - description: |- DHCP server config ID in: path name: dhcp-server-config-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/DhcpServerConfig' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read DHCP server configuration tags: - Policy - Networking - IP Management - DHCP - DHCP Server Configs x-vmw-nsx-module: PolicyConnectivity /global-infra/dns-forwarder-zones: get: consumes: - application/json description: | Paginated list of all Dns Forwarder Zones operationId: GlobalInfraListPolicyDnsForwarderZone parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyDnsForwarderZoneListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Dns Forwarder Zones tags: - Policy - Networking - IP Management - DNS - DNS Forwarder - DNS Zones x-vmw-nsx-module: PolicyDnsForwarder /global-infra/dns-forwarder-zones/{dns-forwarder-zone-id}: get: consumes: - application/json description: |- Read the DNS Forwarder Zone operationId: GlobalInfraReadPolicyDnsForwarderZone parameters: - description: |- DNS Forwarder Zone ID in: path name: dns-forwarder-zone-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyDnsForwarderZone' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read the DNS Forwarder Zone tags: - Policy - Networking - IP Management - DNS - DNS Forwarder - DNS Zones x-vmw-nsx-module: PolicyDnsForwarder /global-infra/dns-security-profiles: get: consumes: - application/json description: |- List all DNS security profiles operationId: GlobalInfraListDnsSecurityProfiles parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/DnsSecurityProfileListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List all DNS security profiles tags: - Policy - Security - Security Profiles - DNS Security Profiles x-vmw-nsx-module: PolicyProfile /global-infra/dns-security-profiles/{profile-id}: delete: consumes: - application/json description: |- Delete DNS security profile operationId: GlobalInfraDeleteDnsSecurityProfile parameters: - in: path name: profile-id required: true type: string - default: false description: Locally override the global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete DNS security profile tags: - Policy - Security - Security Profiles - DNS Security Profiles x-vmw-nsx-module: PolicyProfile get: consumes: - application/json description: |- Read the DNS Forwarder for the given tier-0 instance operationId: GlobalInfraReadDnsSecurityProfile parameters: - in: path name: profile-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/DnsSecurityProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read the DNS Forwarder for the given tier-0 instance tags: - Policy - Security - Security Profiles - DNS Security Profiles x-vmw-nsx-module: PolicyProfile patch: consumes: - application/json description: |- Create or update DNS security profile operationId: GlobalInfraPatchDnsSecurityProfile parameters: - in: path name: profile-id required: true type: string - in: body name: DnsSecurityProfile required: true schema: $ref: '#/definitions/DnsSecurityProfile' - default: false description: Locally override the global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or update DNS security profile tags: - Policy - Security - Security Profiles - DNS Security Profiles x-vmw-nsx-module: PolicyProfile put: consumes: - application/json description: |- Create or update DNS security profile operationId: GlobalInfraUpdateDnsSecurityProfile parameters: - in: path name: profile-id required: true type: string - in: body name: DnsSecurityProfile required: true schema: $ref: '#/definitions/DnsSecurityProfile' - default: false description: Locally override the global object in: query name: override required: false type: boolean produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/DnsSecurityProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or update DNS security profile tags: - Policy - Security - Security Profiles - DNS Security Profiles x-vmw-nsx-module: PolicyProfile /global-infra/domains: get: consumes: - application/json description: | Paginated list of all domains for infra. operationId: GlobalInfraListDomainForInfra parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/DomainListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List domains for infra tags: - Policy - Infra - Domains - Domain x-vmw-nsx-module: Policy /global-infra/domains/firewall-session-timer-profile-binding-maps: get: consumes: - application/json description: | API will list all Firewall Session Timer Profile Binding Maps across all domains. This API returns the binding maps order by the sequence number. operationId: GlobalInfraListFirewallSessionTimerBindingsAcrossDomains parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyFirewallSessionTimerProfileBindingMapListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Firewall Session Timer Profile Binding Maps for all domains tags: - Policy - Security - Security Profiles - Session Timer Profile Bindings x-vmw-nsx-module: PolicyFirewallSessionTimerProfileBinding /global-infra/domains/{domain-id}: get: consumes: - application/json description: | Read a domain. operationId: GlobalInfraReadDomainForInfra parameters: - description: |- Domain ID in: path name: domain-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/Domain' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read domain tags: - Policy - Infra - Domains - Domain x-vmw-nsx-module: Policy /global-infra/domains/{domain-id}/domain-deployment-maps: get: consumes: - application/json description: | Paginated list of all Domain Deployment Entries for infra. operationId: GlobalInfraListDomainDeploymentMapsForInfra parameters: - in: path name: domain-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/DomainDeploymentMapListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Domain Deployment maps for infra tags: - Policy - Infra - Domains - Domain Deployment Maps x-vmw-nsx-module: PolicyEnforcementPointManagement /global-infra/domains/{domain-id}/domain-deployment-maps/{domain-deployment-map-id}: get: consumes: - application/json description: | Read a Domain Deployment Map operationId: GlobalInfraReadDomainDeploymentMapForInfra parameters: - in: path name: domain-id required: true type: string - in: path name: domain-deployment-map-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/DomainDeploymentMap' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read a DomainDeploymentMap tags: - Policy - Infra - Domains - Domain Deployment Maps x-vmw-nsx-module: PolicyEnforcementPointManagement /global-infra/domains/{domain-id}/forwarding-policies: get: consumes: - application/json description: | List all forwarding policies for the given domain ordered by precedence. operationId: GlobalInfraListForwardingPolicies parameters: - description: |- Domain id in: path name: domain-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - default: false description: Include the count of rules in policy in: query name: include_rule_count required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ForwardingPolicyListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List forwarding policies for the given domain tags: - Policy - Networking - Network Services - Forwarding Policies x-vmw-nsx-module: PolicyForwarding /global-infra/domains/{domain-id}/forwarding-policies/{forwarding-policy-id}: get: consumes: - application/json description: | Read forwarding policy. operationId: GlobalInfraReadForwardingPolicy parameters: - description: |- Domain id in: path name: domain-id required: true type: string - description: |- Forwarding map id in: path name: forwarding-policy-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ForwardingPolicy' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read forwarding policy tags: - Policy - Networking - Network Services - Forwarding Policies x-vmw-nsx-module: PolicyForwarding /global-infra/domains/{domain-id}/forwarding-policies/{forwarding-policy-id}/rules: get: consumes: - application/json description: |- List rules operationId: GlobalInfraListForwardingRule parameters: - description: |- Domain id in: path name: domain-id required: true type: string - description: |- Forwarding map id in: path name: forwarding-policy-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ForwardingRuleListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List rules tags: - Policy - Networking - Network Services - Forwarding Policies x-vmw-nsx-module: PolicyForwarding /global-infra/domains/{domain-id}/forwarding-policies/{forwarding-policy-id}/rules/{rule-id}: get: consumes: - application/json description: |- Read rule operationId: GlobalInfraReadForwardingRule parameters: - description: |- Domain id in: path name: domain-id required: true type: string - description: |- Forwarding map id in: path name: forwarding-policy-id required: true type: string - description: |- Rule id in: path name: rule-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ForwardingRule' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read rule tags: - Policy - Networking - Network Services - Forwarding Policies x-vmw-nsx-module: PolicyForwarding /global-infra/domains/{domain-id}/gateway-policies: get: consumes: - application/json description: |- List all gateway policies for specified Domain. operationId: GlobalInfraListGatewayPoliciesForDomain parameters: - in: path name: domain-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - default: false description: Include the count of rules in policy in: query name: include_rule_count required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/GatewayPolicyListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List gateway policies tags: - Policy - Security - North South Security - Gateway Firewall - Rules x-vmw-nsx-module: PolicyEdgeFirewall /global-infra/domains/{domain-id}/gateway-policies/{gateway-policy-id}: get: consumes: - application/json description: | Read gateway policy for a domain. operationId: GlobalInfraReadGatewayPolicyForDomain parameters: - in: path name: domain-id required: true type: string - in: path name: gateway-policy-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/GatewayPolicy' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read gateway policy tags: - Policy - Security - North South Security - Gateway Firewall - Rules x-vmw-nsx-module: PolicyEdgeFirewall /global-infra/domains/{domain-id}/gateway-policies/{gateway-policy-id}/rules: get: consumes: - application/json description: |- List rules operationId: GlobalInfraListGatewayRules parameters: - in: path name: domain-id required: true type: string - in: path name: gateway-policy-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/RuleListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List rules tags: - Policy - Security - North South Security - Gateway Firewall - Rules x-vmw-nsx-module: PolicyEdgeFirewall /global-infra/domains/{domain-id}/gateway-policies/{gateway-policy-id}/rules/{rule-id}: get: consumes: - application/json description: |- Read rule operationId: GlobalInfraReadGatewayRule parameters: - in: path name: domain-id required: true type: string - in: path name: gateway-policy-id required: true type: string - in: path name: rule-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/Rule' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read rule tags: - Policy - Security - North South Security - Gateway Firewall - Rules x-vmw-nsx-module: PolicyEdgeFirewall /global-infra/domains/{domain-id}/gateway-policies/{gateway-policy-id}/rules/{rule-id}/statistics: get: consumes: - application/json description: | Get statistics of a gateway rule. - no enforcement point path specified: Stats will be evaluated on each enforcement. point. - {enforcement_point_path}: Stats are evaluated only on the given enforcement point. operationId: GlobalInfraGetGatewayRuleStatistics parameters: - in: path name: domain-id required: true type: string - in: path name: gateway-policy-id required: true type: string - in: path name: rule-id required: true type: string - description: String Path of the Container Cluster entity in: query name: container_cluster_path required: false type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/RuleStatisticsListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get gateway rule statistics tags: - Policy - Security - North South Security - Gateway Firewall - Statistics x-vmw-nsx-module: PolicyEdgeFirewall /global-infra/domains/{domain-id}/gateway-policies/{gateway-policy-id}/statistics: get: consumes: - application/json description: | Get statistics of a gateay policy. - no enforcement point path specified: Stats will be evaluated on each enforcement. point. - {enforcement_point_path}: Stats are evaluated only on the given enforcement point. operationId: GlobalInfraGetGatewayPolicyStatistics parameters: - in: path name: domain-id required: true type: string - in: path name: gateway-policy-id required: true type: string - description: String Path of the Container Cluster entity in: query name: container_cluster_path required: false type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SecurityPolicyStatisticsListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get gateway policy statistics tags: - Policy - Security - North South Security - Gateway Firewall - Statistics x-vmw-nsx-module: PolicyEdgeFirewall /global-infra/domains/{domain-id}/groups: get: consumes: - application/json description: | List Groups for a domain. Groups can be filtered using member_types query parameter, which returns the groups that contains the specified member types. Multiple member types can be provided as comma separated values. The API also return groups having member type that are subset of provided member_types. operationId: GlobalInfraListGroupForDomain parameters: - description: |- Domain ID in: path name: domain-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - description: Comma Seperated Member types in: query name: member_types required: false type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/GroupListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Groups for a domain tags: - Policy - Inventory - Groups - Groups x-vmw-nsx-module: Policy /global-infra/domains/{domain-id}/groups/{group-id}: get: consumes: - application/json description: |- Read group operationId: GlobalInfraReadGroupForDomain parameters: - description: |- Domain ID in: path name: domain-id required: true type: string - description: |- Group ID in: path name: group-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/Group' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read group tags: - Policy - Inventory - Groups - Groups x-vmw-nsx-module: Policy /global-infra/domains/{domain-id}/groups/{group-id}/discovery-profile-binding-maps: get: consumes: - application/json description: |- API will get Group discovery profile binding map operationId: GlobalInfraListGroupDiscoveryProfileBindings parameters: - description: |- Domain ID in: path name: domain-id required: true type: string - description: |- Group ID in: path name: group-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/GroupDiscoveryProfileBindingMapListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Group discovery profile binding map tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Discovery Profile Binding x-vmw-nsx-module: PolicyDiscoveryProfileBinding /global-infra/domains/{domain-id}/groups/{group-id}/discovery-profile-binding-maps/{discovery-profile-binding-map-id}: get: consumes: - application/json description: |- API will get Group discovery profile binding map operationId: GlobalInfraGetGroupDiscoveryProfileBinding parameters: - description: |- Domain ID in: path name: domain-id required: true type: string - description: |- Group ID in: path name: group-id required: true type: string - description: |- Group discovery profile binding map ID in: path name: discovery-profile-binding-map-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/GroupDiscoveryProfileBindingMap' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Group discovery profile binding map tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Discovery Profile Binding x-vmw-nsx-module: PolicyDiscoveryProfileBinding /global-infra/domains/{domain-id}/groups/{group-id}/dns-security-profile-binding-maps: get: consumes: - application/json description: |- API will get DNS security profile binding map operationId: GlobalInfraListDnsSecurityProfileBindings parameters: - in: path name: domain-id required: true type: string - in: path name: group-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/DnsSecurityProfileBindingMapListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get DNS security profile binding map tags: - Policy - Security - Security Profiles - DNS Security Profile Bindings x-vmw-nsx-module: PolicyFirewallDnsSecurityProfileBinding ? /global-infra/domains/{domain-id}/groups/{group-id}/dns-security-profile-binding-maps/{dns-security-profile-binding-map-id} : get: consumes: - application/json description: |- API will get DNS security profile binding map operationId: GlobalInfraGetDnsSecurityProfileBinding parameters: - description: |- Domain ID in: path name: domain-id required: true type: string - description: |- Group ID in: path name: group-id required: true type: string - description: |- DNS security profile binding map ID in: path name: dns-security-profile-binding-map-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/DnsSecurityProfileBindingMap' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get DNS security profile binding map tags: - Policy - Security - Security Profiles - DNS Security Profile Bindings x-vmw-nsx-module: PolicyFirewallDnsSecurityProfileBinding /global-infra/domains/{domain-id}/groups/{group-id}/firewall-flood-protection-profile-binding-maps: get: consumes: - application/json description: | API will list all Firewall Flood Protection Profile Binding Maps in current group id. operationId: GlobalInfraListPolicyFirewallFloodProtectionBindings parameters: - in: path name: domain-id required: true type: string - in: path name: group-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyFirewallFloodProtectionProfileBindingMapListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Firewall Flood Protection Profile Binding Maps tags: - Policy - Security - Security Profiles - Flood Protection Profile Binding x-vmw-nsx-module: PolicyFirewallFloodProtectionProfileBinding ? /global-infra/domains/{domain-id}/groups/{group-id}/firewall-flood-protection-profile-binding-maps/{firewall-flood-protection-profile-binding-map-id} : get: consumes: - application/json description: | API will get Firewall Flood Protection Profile Binding Map operationId: GlobalInfraGetPolicyFirewallFloodProtectionBinding parameters: - description: |- Domain-ID in: path name: domain-id required: true type: string - description: |- Group ID in: path name: group-id required: true type: string - description: |- Firewall Flood Protection Profile Binding Map ID in: path name: firewall-flood-protection-profile-binding-map-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyFirewallFloodProtectionProfileBindingMap' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Firewall Flood Protection Profile Binding Map tags: - Policy - Security - Security Profiles - Flood Protection Profile Binding x-vmw-nsx-module: PolicyFirewallFloodProtectionProfileBinding /global-infra/domains/{domain-id}/groups/{group-id}/firewall-session-timer-profile-binding-maps: get: consumes: - application/json description: | API will list all Firewall Session Timer Profile Binding Maps in current group id. operationId: GlobalInfraListPolicyFirewallSessionTimerBindings parameters: - in: path name: domain-id required: true type: string - in: path name: group-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyFirewallSessionTimerProfileBindingMapListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Firewall Session Timer Profile Binding Maps tags: - Policy - Security - Security Profiles - Session Timer Profile Bindings x-vmw-nsx-module: PolicyFirewallSessionTimerProfileBinding ? /global-infra/domains/{domain-id}/groups/{group-id}/firewall-session-timer-profile-binding-maps/{firewall-session-timer-profile-binding-map-id} : get: consumes: - application/json description: | API will get Firewall Session Timer Profile Binding Map operationId: GlobalInfraGetPolicyFirewallSessionTimerBinding parameters: - description: |- Domain-ID in: path name: domain-id required: true type: string - description: |- Group ID in: path name: group-id required: true type: string - description: |- Firewall Session Timer Profile Binding Map ID in: path name: firewall-session-timer-profile-binding-map-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyFirewallSessionTimerProfileBindingMap' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Firewall Session Timer Profile Binding Map tags: - Policy - Security - Security Profiles - Session Timer Profile Bindings x-vmw-nsx-module: PolicyFirewallSessionTimerProfileBinding /global-infra/domains/{domain-id}/groups/{group-id}/group-monitoring-profile-binding-maps: get: consumes: - application/json description: | API will list all Group Monitoring Profile Binding Maps in current group id. operationId: GlobalInfraListGroupMonitoringBindings parameters: - in: path name: domain-id required: true type: string - in: path name: group-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/GroupMonitoringProfileBindingMapListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Group Monitoring Profile Binding Maps tags: - Policy - Security - Security Profiles - Monitoring Profile Binding x-vmw-nsx-module: PolicyMonitoringProfileBinding ? /global-infra/domains/{domain-id}/groups/{group-id}/group-monitoring-profile-binding-maps/{group-monitoring-profile-binding-map-id} : get: consumes: - application/json description: | API will get Group Monitoring Profile Binding Map operationId: GlobalInfraGetGroupMonitoringBinding parameters: - description: |- Domain-ID in: path name: domain-id required: true type: string - description: |- Group ID in: path name: group-id required: true type: string - description: |- Group Monitoring Profile Binding Map ID in: path name: group-monitoring-profile-binding-map-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/GroupMonitoringProfileBindingMap' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Group Monitoring Profile Binding Map tags: - Policy - Security - Security Profiles - Monitoring Profile Binding x-vmw-nsx-module: PolicyMonitoringProfileBinding ? /global-infra/domains/{domain-id}/groups/{group-id}/group-monitoring-profile-binding-maps/{group-monitoring-profile-binding-map-id}/mirror-stack-status : get: consumes: - application/json description: | API will get mirror stack status by Group Monitoring Profile Binding Map operationId: GlobalInfraGetGroupMonitoringBindingMirrorStackStatus parameters: - in: path name: domain-id required: true type: string - in: path name: group-id required: true type: string - in: path name: group-monitoring-profile-binding-map-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Binding map path enforcemnt point path to remote L3 mirror session in: query name: enforcement_point_path required: false type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/MirrorStackStatusListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get mirror stack status for Group Monitoring Profile Binding Map. tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Monitoring Profile Binding x-vmw-nsx-module: PolicyMonitoringProfileBinding /global-infra/domains/{domain-id}/groups/{group-id}/member-types: get: consumes: - application/json description: | It retrieves member types for a given group. In case of nested groups, it calculates member types of child groups as well. Considers member type for members added via static members and dynamic membership criteria. operationId: GlobalInfraGetMemberTypesForGroup parameters: - description: |- Domain ID in: path name: domain-id required: true type: string - description: |- Group ID in: path name: group-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/GroupMemberTypeListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get member types for a given Group tags: - Policy - Inventory - Groups - Group Members x-vmw-nsx-module: Policy /global-infra/domains/{domain-id}/groups/{group-id}/members/consolidated-effective-ip-addresses: get: consumes: - application/json description: | Returns consolidated effective ip address members of the specified NSGroup. Applicable in case of federated environment. The response contains site-wise list of consolidated effective IP address members. In the response, for the local-site, the list will contain static and dynamicaly translated IPs. For the remote sites, the list will contain only the dynamically translated IPs. The static IPs will not be seen in the response of this API. Hence, user can refer to the local-site Ip response in the API results or the group definition to see the static IP membership of the Group. This API is applicable only for Global Groups containing (directly or via nesting) either VirtualMachine, VIF, Segment, SegmentPort or IPSet member type. Use the cursor value in the response to fetch the next page. If there is no cursor value for a response, it implies the last page in the results for the query. operationId: GlobalInfraGetConsolidatedEffectiveIPMembers parameters: - description: |- Domain id in: path name: domain-id required: true type: string - description: |- Group Id in: path name: group-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - description: IP address, range, or subnet format: address-or-block-or-range in: query name: ip_filter required: false type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - description: 'UUID of the site from which the effective IP addresses are to be fetched ' in: query name: site_id required: false type: string - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ConsolidatedEffectiveIPAddressMemberListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get consolidated effective IPAddress translated from this group across site tags: - Policy - Inventory - Groups - Group Members x-vmw-nsx-module: PolicyGroupRealization /global-infra/domains/{domain-id}/groups/{group-id}/members/dvpg: get: consumes: - application/json description: | Get Discovered Port Groups that belong to this Group operationId: GlobalInfraGetGroupDVPGMembers parameters: - description: |- Domain id in: path name: domain-id required: true type: string - description: |- Group Id in: path name: group-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyGroupMembersListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Discovered Port Groups that belong to this Group tags: - Policy - Inventory - Groups - Group Members x-vmw-nsx-module: PolicyGroupRealization /global-infra/domains/{domain-id}/groups/{group-id}/members/dvports: get: consumes: - application/json description: | Get discovered ports that belong to this Group operationId: GlobalInfraGetGroupDiscoveredPortMembers parameters: - description: |- Domain id in: path name: domain-id required: true type: string - description: |- Group Id in: path name: group-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyGroupMembersListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get discovered ports that belong to this Group tags: - Policy - Inventory - Groups - Group Members x-vmw-nsx-module: PolicyGroupRealization /global-infra/domains/{domain-id}/groups/{group-id}/members/ip-addresses: get: consumes: - application/json description: | Get IP addresses that belong to this 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 operationId: GlobalInfraGetGroupIPMembers parameters: - description: |- Domain id in: path name: domain-id required: true type: string - description: |- Group Id in: path name: group-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyGroupIPMembersListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get IP addresses that belong to this Group tags: - Policy - Inventory - Groups - Group Members x-vmw-nsx-module: PolicyGroupRealization /global-infra/domains/{domain-id}/groups/{group-id}/members/logical-ports: get: consumes: - application/json description: | Get logical ports that belong to this Group This API is applicable for Groups containing either VirtualMachine, VIF, Segment or Segment Port member type.For Groups containing other member types,an empty list is returned. operationId: GlobalInfraGetGroupLPMembers parameters: - description: |- Domain id in: path name: domain-id required: true type: string - description: |- Group Id in: path name: group-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyGroupMembersListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get logical ports that belong to this Group tags: - Policy - Inventory - Groups - Group Members x-vmw-nsx-module: PolicyGroupRealization /global-infra/domains/{domain-id}/groups/{group-id}/members/logical-switches: get: consumes: - application/json description: | Get logical switches that belong to this Group. This API is applicable for Groups containing Segment member type. For Groups containing other member types, an empty list is returned. operationId: GlobalInfraGetGroupLSMembers parameters: - description: |- Domain id in: path name: domain-id required: true type: string - description: |- Group Id in: path name: group-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyGroupMembersListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get logical switches that belong to this Group tags: - Policy - Inventory - Groups - Group Members x-vmw-nsx-module: PolicyGroupRealization /global-infra/domains/{domain-id}/groups/{group-id}/members/pods: get: consumes: - application/json description: | Get pods that belong to this Group. This API is applicable for Groups containing either Pod, Cluster, Namespace, Service member type. For Groups containing other member types an empty list is returned operationId: GlobalInfraGetGroupPodMembers parameters: - description: |- Domain id in: path name: domain-id required: true type: string - description: |- Group Id in: path name: group-id required: true type: string - description: Cluster ID in: query name: cluster_id required: false type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyContainerGroupMembersListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get pods that belong to this Group tags: - Policy - Inventory - Groups - Group Members x-vmw-nsx-module: PolicyGroupRealization /global-infra/domains/{domain-id}/groups/{group-id}/members/segment-ports: get: consumes: - application/json description: | Get segment ports that belong to this Group operationId: GlobalInfraGetGroupSegmentPortMembers parameters: - description: |- Domain id in: path name: domain-id required: true type: string - description: |- Group Id in: path name: group-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyGroupMembersListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get segment ports that belong to this Group tags: - Policy - Inventory - Groups - Group Members x-vmw-nsx-module: PolicyGroupRealization /global-infra/domains/{domain-id}/groups/{group-id}/members/segments: get: consumes: - application/json description: | Get segments that belong to this Group operationId: GlobalInfraGetGroupSegmentMembers parameters: - description: |- Domain id in: path name: domain-id required: true type: string - description: |- Group Id in: path name: group-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyGroupMembersListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get segments that belong to this Group tags: - Policy - Inventory - Groups - Group Members x-vmw-nsx-module: PolicyGroupRealization /global-infra/domains/{domain-id}/groups/{group-id}/members/vifs: get: consumes: - application/json description: | Get Virtual Network Interface instances that belong to this Group. This API is applicable for Groups containing VirtualNetworkInterface and VirtualMachine member types. For Groups containing other member types,an empty list is returned.target_id in response is external_id of VirtualNetworkInterface or VirtualMachine. operationId: GlobalInfraGetGroupVIFMembers parameters: - description: |- Domain id in: path name: domain-id required: true type: string - description: |- Group Id in: path name: group-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/VirtualNetworkInterfaceListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Virtual Network Interface instances that belong to this Group tags: - Policy - Inventory - Groups - Group Members x-vmw-nsx-module: PolicyGroupRealization /global-infra/domains/{domain-id}/groups/{group-id}/members/virtual-machines: get: consumes: - application/json description: | Get Virtual machines that belong to this Group. This API is applicable for Groups containing VirtualMachine,member type. For Groups containing other member types,an empty list is returned. operationId: GlobalInfraGetGroupVMMembers parameters: - description: |- Domain id in: path name: domain-id required: true type: string - description: |- Group Id in: path name: group-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/RealizedVirtualMachineListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Virtual machines that belong to this Group tags: - Policy - Inventory - Groups - Group Members x-vmw-nsx-module: PolicyGroupRealization /global-infra/domains/{domain-id}/groups/{group-id}/tags: get: consumes: - application/json description: | Get tags used to define conditions inside a Group. Also includes tags inside nested groups. operationId: GlobalInfraGetGroupTags parameters: - description: |- Domain id in: path name: domain-id required: true type: string - description: |- Group Id in: path name: group-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/GroupTagsList' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get tags used to define conditions inside a Group tags: - Policy - Inventory - Groups - Group Members x-vmw-nsx-module: PolicyGroupRealization /global-infra/domains/{domain-id}/security-policies: get: consumes: - application/json description: | List all security policies for a domain. operationId: GlobalInfraListSecurityPoliciesForDomain parameters: - in: path name: domain-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - default: false description: Include the count of rules in policy in: query name: include_rule_count required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SecurityPolicyListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List security policies tags: - Policy - Security - East West Security - Distributed Firewall - Rules x-vmw-nsx-module: DfwSecurityPolicy /global-infra/domains/{domain-id}/security-policies/{security-policy-id}: get: consumes: - application/json description: | Read security policy for a domain. operationId: GlobalInfraReadSecurityPolicyForDomain parameters: - in: path name: domain-id required: true type: string - in: path name: security-policy-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SecurityPolicy' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read security policy tags: - Policy - Security - East West Security - Distributed Firewall - Rules x-vmw-nsx-module: DfwSecurityPolicy /global-infra/domains/{domain-id}/security-policies/{security-policy-id}/rules: get: consumes: - application/json description: |- List rules operationId: GlobalInfraListSecurityRules parameters: - in: path name: domain-id required: true type: string - in: path name: security-policy-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/RuleListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List rules tags: - Policy - Security - East West Security - Distributed Firewall - Rules x-vmw-nsx-module: DfwSecurityPolicy /global-infra/domains/{domain-id}/security-policies/{security-policy-id}/rules/{rule-id}: get: consumes: - application/json description: |- Read rule operationId: GlobalInfraReadSecurityRule parameters: - in: path name: domain-id required: true type: string - in: path name: security-policy-id required: true type: string - in: path name: rule-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/Rule' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read rule tags: - Policy - Security - East West Security - Distributed Firewall - Rules x-vmw-nsx-module: DfwSecurityPolicy /global-infra/domains/{domain-id}/security-policies/{security-policy-id}/rules/{rule-id}/statistics: get: consumes: - application/json description: | Get statistics of a rule. - no enforcement point path specified: Stats will be evaluated on each enforcement point. - {enforcement_point_path}: Stats are evaluated only on the given enforcement point. operationId: GlobalInfraGetRuleStatistics parameters: - description: |- Domain id in: path name: domain-id required: true type: string - description: |- Security policy id in: path name: security-policy-id required: true type: string - description: |- Rule id in: path name: rule-id required: true type: string - description: String Path of the Container Cluster entity in: query name: container_cluster_path required: false type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/RuleStatisticsListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get rule statistics tags: - Policy - Security - East West Security - Distributed Firewall - Statistics x-vmw-nsx-module: DfwSecurityPolicy /global-infra/domains/{domain-id}/security-policies/{security-policy-id}/statistics: get: consumes: - application/json description: | Get statistics of a security policy. - no enforcement point path specified: Stats will be evaluated on each enforcement point. - {enforcement_point_path}: Stats are evaluated only on the given enforcement point. operationId: GlobalInfraGetSecurityPolicyStatistics parameters: - description: |- Domain id in: path name: domain-id required: true type: string - description: |- Security policy id in: path name: security-policy-id required: true type: string - description: String Path of the Container Cluster entity in: query name: container_cluster_path required: false type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SecurityPolicyStatisticsListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get security policy statistics tags: - Policy - Security - East West Security - Distributed Firewall - Statistics x-vmw-nsx-module: DfwSecurityPolicy /global-infra/federation-config: get: consumes: - application/json description: |- Read a federation config from Global Manager. operationId: GlobalInfraReadFederationConfig produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/FederationConfig' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read federation config tags: - Federation - Federation Configuration x-vmw-nsx-module: PolicySiteGM /global-infra/firewall-session-timer-profiles: get: consumes: - application/json description: |- API will list all Firewall Session Timer Profiles operationId: GlobalInfraListPolicyFirewallSessionTimerProfiles parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyFirewallSessionTimerProfileListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Firewall Session Timer Profiles tags: - Policy - Security - Security Profiles - Session Timer Profiles x-vmw-nsx-module: PolicyFirewallSessionTimerProfile /global-infra/firewall-session-timer-profiles/{firewall-session-timer-profile-id}: delete: consumes: - application/json description: |- API will delete Firewall Session Timer Profile operationId: GlobalInfraDeletePolicyFirewallSessionTimerProfile parameters: - description: |- Firewall Session Timer Profile ID in: path name: firewall-session-timer-profile-id required: true type: string - default: false description: Locally override the global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete Firewall Session Timer Profile tags: - Policy - Security - Security Profiles - Session Timer Profiles x-vmw-nsx-module: PolicyFirewallSessionTimerProfile get: consumes: - application/json description: |- API will get Firewall Session Timer Profile operationId: GlobalInfraGetPolicyFirewallSessionTimerProfile parameters: - description: |- Firewall Session Timer Profile ID in: path name: firewall-session-timer-profile-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyFirewallSessionTimerProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Firewall Session Timer Profile tags: - Policy - Security - Security Profiles - Session Timer Profiles x-vmw-nsx-module: PolicyFirewallSessionTimerProfile patch: consumes: - application/json description: |- API will create/update Firewall Session Timer Profile operationId: GlobalInfraPatchPolicyFirewallSessionTimerProfile parameters: - description: |- Firewall Session Timer Profile ID in: path name: firewall-session-timer-profile-id required: true type: string - in: body name: PolicyFirewallSessionTimerProfile required: true schema: $ref: '#/definitions/PolicyFirewallSessionTimerProfile' - default: false description: Locally override the global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or update Firewall Session Timer Profile tags: - Policy - Security - Security Profiles - Session Timer Profiles x-vmw-nsx-module: PolicyFirewallSessionTimerProfile put: consumes: - application/json description: |- API will update Firewall Session Timer Profile operationId: GlobalInfraUpdatePolicyFirewallSessionTimerProfile parameters: - description: |- Firewall Session Timer Profile ID in: path name: firewall-session-timer-profile-id required: true type: string - in: body name: PolicyFirewallSessionTimerProfile required: true schema: $ref: '#/definitions/PolicyFirewallSessionTimerProfile' - default: false description: Locally override the global object in: query name: override required: false type: boolean produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyFirewallSessionTimerProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Update Firewall Session Timer Profile tags: - Policy - Security - Security Profiles - Session Timer Profiles x-vmw-nsx-module: PolicyFirewallSessionTimerProfile /global-infra/firewall/policies: get: consumes: - application/json description: | Get the list of policies filtered based on the given criteria. operationId: GlobalInfraGetFilteredPolicies parameters: - description: Path of the enforcement point in: query name: enforcement_point_path required: false type: string - description: Path of the parent object of the entities in: query name: parent_path required: false type: string - description: Scope filter criteria in: query name: scope required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyResourceReferenceForEPListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get policies filtered based on the given criteria tags: - Policy - Security x-vmw-nsx-module: PolicyFirewallConfiguration /global-infra/firewall/rules: get: consumes: - application/json description: | Get the list of rules of given parent path of policy/section, filtered based on the given criteria. Parent path is mandatory. operationId: GlobalInfraGetFilteredRules parameters: - description: Path of the enforcement point in: query name: enforcement_point_path required: false type: string - description: Path of the parent object of the entities in: query name: parent_path required: false type: string - description: Scope filter criteria in: query name: scope required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyResourceReferenceForEPListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get rules filtered based on the given criteria tags: - Policy - Security x-vmw-nsx-module: PolicyFirewallConfiguration /global-infra/flood-protection-profiles: get: consumes: - application/json description: |- API will list all Flood Protection Profiles operationId: GlobalInfraListFloodProtectionProfiles parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/FloodProtectionProfileListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Flood Protection Profiles tags: - Policy - Security - Security Profiles - Flood Protection Profiles x-vmw-nsx-module: PolicyProfile /global-infra/flood-protection-profiles/{flood-protection-profile-id}: delete: consumes: - application/json description: |- API will delete Flood Protection Profile operationId: GlobalInfraDeleteFloodProtectionProfile parameters: - description: |- Flood Protection Profile ID in: path name: flood-protection-profile-id required: true type: string - default: false description: Locally override the global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete Flood Protection Profile tags: - Policy - Security - Security Profiles - Flood Protection Profiles x-vmw-nsx-module: PolicyProfile get: consumes: - application/json description: |- API will get Flood Protection Profile operationId: GlobalInfraGetFloodProtectionProfile parameters: - description: |- Flood Protection Profile ID in: path name: flood-protection-profile-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/FloodProtectionProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Flood Protection Profile tags: - Policy - Security - Security Profiles - Flood Protection Profiles x-vmw-nsx-module: PolicyProfile patch: consumes: - application/json description: |- API will create/update Flood Protection Profile operationId: GlobalInfraPatchFloodProtectionProfile parameters: - description: |- Firewall Flood Protection Profile ID in: path name: flood-protection-profile-id required: true type: string - in: body name: FloodProtectionProfile required: true schema: $ref: '#/definitions/FloodProtectionProfile' - default: false description: Locally override the global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or update Flood Protection Profile tags: - Policy - Security - Security Profiles - Flood Protection Profiles x-vmw-nsx-module: PolicyProfile put: consumes: - application/json description: |- API will update Firewall Flood Protection Profile operationId: GlobalInfraUpdateFloodProtectionProfile parameters: - description: |- Flood Protection Profile ID in: path name: flood-protection-profile-id required: true type: string - in: body name: FloodProtectionProfile required: true schema: $ref: '#/definitions/FloodProtectionProfile' - default: false description: Locally override the global object in: query name: override required: false type: boolean produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/FloodProtectionProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Update Firewall Flood Protection Profile tags: - Policy - Security - Security Profiles - Flood Protection Profiles x-vmw-nsx-module: PolicyProfile /global-infra/flood-protection-profiles/{flood-protection-profile-id}/bindings: get: consumes: - application/json description: |- API will list all Flood Protection Profiles bindings. operationId: GlobalInfraListFloodProtectionProfileBindings parameters: - in: path name: flood-protection-profile-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/FloodProtectionProfileBindingListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Flood Protection Profiles tags: - Policy - Security - Security Profiles - Flood Protection Profiles x-vmw-nsx-module: PolicyProfile /global-infra/full-sync-states: get: consumes: - application/json description: |- List full sync state. operationId: GlobalInfraListFullSyncStates parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/FullSyncStateListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List full sync states tags: - Federation - Full Synchronization x-vmw-nsx-module: PolicyFullSync /global-infra/full-sync-states/{full-sync-id}: get: consumes: - application/json description: |- Get full sync state. operationId: GlobalInfraGetFullSyncStates parameters: - in: path name: full-sync-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/FullSyncState' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get full sync state tags: - Federation - Full Synchronization x-vmw-nsx-module: PolicyFullSync /global-infra/gateway-qos-profiles: get: consumes: - application/json description: | Paginated list of all gateway QoS profle instances operationId: GlobalInfraListGatewayQosProfiles parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/GatewayQosProfileListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List all gateway QoS profiles tags: - Policy - Networking - Networking Profiles - Gateway QOS Profiles x-vmw-nsx-module: PolicyConnectivity /global-infra/gateway-qos-profiles/{qos-profile-id}: delete: consumes: - application/json description: |- Delete QoS profile operationId: GlobalInfraDeleteGatewayQosProfile parameters: - in: path name: qos-profile-id required: true type: string - default: false description: Locally override the global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete gateway QoS profile tags: - Policy - Networking - Networking Profiles - Gateway QOS Profiles x-vmw-nsx-module: PolicyConnectivity get: consumes: - application/json description: |- Read gateway QoS profile operationId: GlobalInfraReadGatewayQosProfile parameters: - in: path name: qos-profile-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/GatewayQosProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read gateway QoS profile tags: - Policy - Networking - Networking Profiles - Gateway QOS Profiles x-vmw-nsx-module: PolicyConnectivity patch: consumes: - application/json description: | If profile with the qos-profile-id is not already present, create a new gateway QoS profile instance. If it already exists, update the gateway QoS profile instance with specified attributes. operationId: GlobalInfraPatchGatewayQosProfile parameters: - in: path name: qos-profile-id required: true type: string - in: body name: GatewayQosProfile required: true schema: $ref: '#/definitions/GatewayQosProfile' - default: false description: Locally override the global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or update Gateway QoS profile tags: - Policy - Networking - Networking Profiles - Gateway QOS Profiles x-vmw-nsx-module: PolicyConnectivity put: consumes: - application/json description: | If profile with the qos-profile-id is not already present, create a new gateway QoS profile instance. If it already exists, replace the gateway QoS profile instance with this object. operationId: GlobalInfraCreateOrReplaceGatewayQosProfile parameters: - in: path name: qos-profile-id required: true type: string - in: body name: GatewayQosProfile required: true schema: $ref: '#/definitions/GatewayQosProfile' - default: false description: Locally override the global object in: query name: override required: false type: boolean produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/GatewayQosProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or update Gateway QoS profile tags: - Policy - Networking - Networking Profiles - Gateway QOS Profiles x-vmw-nsx-module: PolicyConnectivity /global-infra/global-manager-config?action=show-sensitive-data: get: consumes: - application/json description: | Read a Global Manager config along with sensitive data. For example - rtep_config.ibgp_password operationId: GlobalInfraReadGlobalManagerConfigWithSensitiveData produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/GlobalManagerConfig' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read Global Manager config along with sensitive data tags: - Federation - Federation Configuration x-vmw-nsx-module: PolicySiteGM /global-infra/global-managers: get: consumes: - application/json description: | List Global Managers under Infra. operationId: GlobalInfraListInfraGlobalManagers parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/GlobalManagerListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Global Managers tags: - Federation - Global Managers x-vmw-nsx-module: PolicySiteGM /global-infra/global-managers/{global-manager-id}: get: consumes: - application/json description: | Retrieve information about a particular configured global manager. Global Manager id 'self' is reserved and can be used for referring to local logged in Global Manager. Example - /infra/global-managers/self operationId: GlobalInfraReadInfraGlobalManager parameters: - in: path name: global-manager-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/GlobalManager' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read a Global Manager tags: - Federation - Global Managers x-vmw-nsx-module: PolicySiteGM /global-infra/group-associations: get: consumes: - application/json description: | Get policy groups for which the given object is a member. In Federation environment, if the given object is a global entity (eg: global segment) and if the entity is not stretched to the site specified in the enforcement_point_path parameter,then the following is returned:- 1)If the entity is a member of any global group and that group is stretched to the enforcement_point_path site,then the API returns an empty list. 2)If the entity is not a member of any global group,this API returns an 'invalid path' error message. 3)If both the entity and its corresponding groups are stretched to the enforcement_point_path site , then the API returns the groups list. operationId: GlobalInfraGetGroupsForObject parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - description: String path of the intent object in: query name: intent_path required: true type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyResourceReferenceForEPListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get groups for which the given object is a member tags: - Policy - Inventory - Groups - Group Members x-vmw-nsx-module: PolicyGroupRealization /global-infra/group-service-associations: get: consumes: - application/json description: | The API returns all the services associated with the given Group. It also returns the services associated with the parent groups of the given group. operationId: GlobalInfraGetPolicyGroupServiceAssociations parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - description: Path of the entity in: query name: intent_path required: true type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyResourceReferenceListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get the list of services where the given group is consumed. tags: - Policy x-vmw-nsx-module: PolicyGroupRealization /global-infra/ip-address-group-associations: get: consumes: - application/json description: | Get policy groups for which the given IP address is a member. operationId: GlobalInfraGetGroupsForIPAddress parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - description: IPAddress in: query name: ip_address required: true type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyResourceReferenceForEPListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get groups for which the given IP address is a member tags: - Policy - Inventory - Groups - Group Members x-vmw-nsx-module: PolicyGroupRealization /global-infra/ip-discovery-profiles: get: consumes: - application/json description: | API will list all IP Discovery Profiles active in current discovery profile id. operationId: GlobalInfraGetIPDiscoveryProfiles parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/IPDiscoveryProfileListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List IP Discovery Profiles tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - IP Discovery Profiles x-vmw-nsx-module: PolicyIpDiscovery /global-infra/ip-discovery-profiles/{ip-discovery-profile-id}: delete: consumes: - application/json description: | API will delete IP Discovery profile. operationId: GlobalInfraDeleteIPDiscoveryProfile parameters: - description: |- IP Discovery Profile ID in: path name: ip-discovery-profile-id required: true type: string - default: false description: Locally override the global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete IP Discovery Profile tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - IP Discovery Profiles x-vmw-nsx-module: PolicyIpDiscovery get: consumes: - application/json description: | API will get IP Discovery profile. operationId: GlobalInfraGetIPDiscoveryProfile parameters: - description: |- IP Discovery Profile ID in: path name: ip-discovery-profile-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/IPDiscoveryProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get IP Discovery Profile tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - IP Discovery Profiles x-vmw-nsx-module: PolicyIpDiscovery patch: consumes: - application/json description: | API will create IP Discovery profile. operationId: GlobalInfraCreateIPDiscoveryProfile parameters: - description: |- IP Discovery Profile ID in: path name: ip-discovery-profile-id required: true type: string - in: body name: IPDiscoveryProfile required: true schema: $ref: '#/definitions/IPDiscoveryProfile' - default: false description: Locally override the global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create IP Discovery Profile tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - IP Discovery Profiles x-vmw-nsx-module: PolicyIpDiscovery put: consumes: - application/json description: | API will update IP Discovery profile. operationId: GlobalInfraUpdateIPDiscoveryProfile parameters: - description: |- IP Discovery Profile ID in: path name: ip-discovery-profile-id required: true type: string - in: body name: IPDiscoveryProfile required: true schema: $ref: '#/definitions/IPDiscoveryProfile' - default: false description: Locally override the global object in: query name: override required: false type: boolean produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/IPDiscoveryProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Update IP Discovery Profile tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - IP Discovery Profiles x-vmw-nsx-module: PolicyIpDiscovery /global-infra/ipfix-dfw-collector-profiles: get: consumes: - application/json description: | API will provide list of all IPFIX dfw collector profiles and their details. operationId: GlobalInfraListIPFIXDFWCollectorProfiles parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/IPFIXDFWCollectorProfileListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List IPFIX Collector profiles. tags: - Policy - Monitoring - IPFIX - Firewall IPFIX Collectors x-vmw-nsx-module: PolicyIPFIXDFW /global-infra/ipfix-dfw-collector-profiles/{ipfix-dfw-collector-profile-id}: delete: consumes: - application/json description: | API deletes IPFIX dfw collector profile. Flow forwarding to collector will be stopped. operationId: GlobalInfraDeleteIPFIXDFWCollectorProfile parameters: - description: |- IPFIX dfw collector Profile id in: path name: ipfix-dfw-collector-profile-id required: true type: string - default: false description: Locally override the global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete IPFIX dfw Collector profile tags: - Policy - Monitoring - IPFIX - Firewall IPFIX Collectors x-vmw-nsx-module: PolicyIPFIXDFW get: consumes: - application/json description: | API will return details of IPFIX dfw collector profile. If profile does not exist, it will return 404. operationId: GlobalInfraReadIPFIXDFWCollectorProfile parameters: - description: |- IPFIX dfw collector profile id in: path name: ipfix-dfw-collector-profile-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/IPFIXDFWCollectorProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get IPFIX dfw Collector profile tags: - Policy - Monitoring - IPFIX - Firewall IPFIX Collectors x-vmw-nsx-module: PolicyIPFIXDFW patch: consumes: - application/json description: | Create a new IPFIX dfw collector profile if the IPFIX dfw collector profile with given id does not already exist. If the IPFIX dfw collector profile with the given id already exists, patch with the existing IPFIX dfw collector profile. operationId: GlobalInfraPatchIPFIXDFWCollectorProfile parameters: - in: path name: ipfix-dfw-collector-profile-id required: true type: string - in: body name: IPFIXDFWCollectorProfile required: true schema: $ref: '#/definitions/IPFIXDFWCollectorProfile' - default: false description: Locally override the global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- IPFIX dfw collector profile id tags: - Policy - Monitoring - IPFIX - Firewall IPFIX Collectors x-vmw-nsx-module: PolicyIPFIXDFW put: consumes: - application/json description: | Create or Replace IPFIX dfw collector profile. IPFIX data will be sent to IPFIX collector port. operationId: GlobalInfraCreateOrReplaceIPFIXDFWCollectorProfile parameters: - description: |- IPFIX dfw collector profile id in: path name: ipfix-dfw-collector-profile-id required: true type: string - in: body name: IPFIXDFWCollectorProfile required: true schema: $ref: '#/definitions/IPFIXDFWCollectorProfile' - default: false description: Locally override the global object in: query name: override required: false type: boolean produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/IPFIXDFWCollectorProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or Replace IPFIX dfw collector profile tags: - Policy - Monitoring - IPFIX - Firewall IPFIX Collectors x-vmw-nsx-module: PolicyIPFIXDFW /global-infra/ipfix-dfw-profiles: get: consumes: - application/json description: | API provides list IPFIX DFW profiles available on selected logical DFW. operationId: GlobalInfraListIPFIXDFWProfiles parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/IPFIXDFWProfileListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List IPFIX DFW Profile tags: - Policy - Monitoring - IPFIX - Firewall IPFIX Profiles x-vmw-nsx-module: PolicyIPFIXDFW /global-infra/ipfix-dfw-profiles/{ipfix-dfw-profile-id}: delete: consumes: - application/json description: | API deletes IPFIX DFW Profile. Selected IPFIX Collectors will stop receiving flows. operationId: GlobalInfraDeleteIPFIXDFWProfile parameters: - description: |- IPFIX DFW Profile ID in: path name: ipfix-dfw-profile-id required: true type: string - default: false description: Locally override the global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete IPFIX DFW Profile tags: - Policy - Monitoring - IPFIX - Firewall IPFIX Profiles x-vmw-nsx-module: PolicyIPFIXDFW get: consumes: - application/json description: | API will return details of IPFIX DFW profile. operationId: GlobalInfraReadIPFIXDFWProfile parameters: - description: |- IPFIX DFW collection id in: path name: ipfix-dfw-profile-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/IPFIXDFWProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get IPFIX DFW Profile tags: - Policy - Monitoring - IPFIX - Firewall IPFIX Profiles x-vmw-nsx-module: PolicyIPFIXDFW patch: consumes: - application/json description: | Create a new IPFIX DFW profile if the IPFIX DFW profile with given id does not already exist. If the IPFIX DFW profile with the given id already exists, patch with the existing IPFIX DFW profile. operationId: GlobalInfraPatchIPFIXDFWProfile parameters: - description: |- IPFIX DFW Profile ID in: path name: ipfix-dfw-profile-id required: true type: string - in: body name: IPFIXDFWProfile required: true schema: $ref: '#/definitions/IPFIXDFWProfile' - default: false description: Locally override the global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Patch IPFIX DFW profile tags: - Policy - Monitoring - IPFIX - Firewall IPFIX Profiles x-vmw-nsx-module: PolicyIPFIXDFW put: consumes: - application/json description: | Create or replace IPFIX DFW profile. Config will start forwarding data to provided IPFIX DFW collector. operationId: GlobalInfraCreateOrReplaceIPFIXDFWProfile parameters: - description: |- IPFIX DFW Profile ID in: path name: ipfix-dfw-profile-id required: true type: string - in: body name: IPFIXDFWProfile required: true schema: $ref: '#/definitions/IPFIXDFWProfile' - default: false description: Locally override the global object in: query name: override required: false type: boolean produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/IPFIXDFWProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or Replace IPFIX DFW collection Config. tags: - Policy - Monitoring - IPFIX - Firewall IPFIX Profiles x-vmw-nsx-module: PolicyIPFIXDFW /global-infra/ipfix-l2-collector-profiles: get: consumes: - application/json description: | API will provide list of all IPFIX collector profiles and their details. operationId: GlobalInfraListIPFIXL2CollectorProfiles parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/IPFIXL2CollectorProfileListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List IPFIX Collector profiles. tags: - Policy - Monitoring - IPFIX - Switch IPFIX Collectors x-vmw-nsx-module: PolicyIPFIXSwitch /global-infra/ipfix-l2-collector-profiles/{ipfix-l2-collector-profile-id}: delete: consumes: - application/json description: | API deletes IPFIX collector profile. Flow forwarding to collector will be stopped. operationId: GlobalInfraDeleteIPFIXL2CollectorProfile parameters: - description: |- IPFIX collector Profile id in: path name: ipfix-l2-collector-profile-id required: true type: string - default: false description: Locally override the global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete IPFIX Collector profile tags: - Policy - Monitoring - IPFIX - Switch IPFIX Collectors x-vmw-nsx-module: PolicyIPFIXSwitch get: consumes: - application/json description: | API will return details of IPFIX collector profile. operationId: GlobalInfraReadIPFIXL2CollectorProfile parameters: - description: |- IPFIX collector profile id in: path name: ipfix-l2-collector-profile-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/IPFIXL2CollectorProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get IPFIX Collector profile tags: - Policy - Monitoring - IPFIX - Switch IPFIX Collectors x-vmw-nsx-module: PolicyIPFIXSwitch patch: consumes: - application/json description: | Create a new IPFIX collector profile if the IPFIX collector profile with given id does not already exist. If the IPFIX collector profile with the given id already exists, patch with the existing IPFIX collector profile. operationId: GlobalInfraPatchIPFIXL2CollectorProfile parameters: - description: |- IPFIX collector profile id in: path name: ipfix-l2-collector-profile-id required: true type: string - in: body name: IPFIXL2CollectorProfile required: true schema: $ref: '#/definitions/IPFIXL2CollectorProfile' - default: false description: Locally override the global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Patch IPFIX collector profile tags: - Policy - Monitoring - IPFIX - Switch IPFIX Collectors x-vmw-nsx-module: PolicyIPFIXSwitch put: consumes: - application/json description: | Create or Replace IPFIX collector profile. IPFIX data will be sent to IPFIX collector. operationId: GlobalInfraCreateOrReplaceIPFIXL2CollectorProfile parameters: - description: |- IPFIX collector profile id in: path name: ipfix-l2-collector-profile-id required: true type: string - in: body name: IPFIXL2CollectorProfile required: true schema: $ref: '#/definitions/IPFIXL2CollectorProfile' - default: false description: Locally override the global object in: query name: override required: false type: boolean produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/IPFIXL2CollectorProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or Replace IPFIX collector profile tags: - Policy - Monitoring - IPFIX - Switch IPFIX Collectors x-vmw-nsx-module: PolicyIPFIXSwitch /global-infra/ipfix-l2-profiles: get: consumes: - application/json description: | API provides list IPFIX L2 Profiles available on selected logical l2. operationId: GlobalInfraListIPFIXL2Profiles parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/IPFIXL2ProfileListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List IPFIX L2 Profiles tags: - Policy - Monitoring - IPFIX - Switch IPFIX Profiles x-vmw-nsx-module: PolicyIPFIXSwitch /global-infra/ipfix-l2-profiles/{ipfix-l2-profile-id}: delete: consumes: - application/json description: | API deletes IPFIX L2 Profile. Flow forwarding to selected collector will be stopped. operationId: GlobalInfraDeleteIPFIXL2Profile parameters: - description: |- IPFIX L2 Profile ID in: path name: ipfix-l2-profile-id required: true type: string - default: false description: Locally override the global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete IPFIX L2 Profile tags: - Policy - Monitoring - IPFIX - Switch IPFIX Profiles x-vmw-nsx-module: PolicyIPFIXSwitch get: consumes: - application/json description: | API will return details of IPFIX L2 profile. operationId: GlobalInfraReadIPFIXL2Profile parameters: - description: |- IPFIX L2 profile id in: path name: ipfix-l2-profile-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/IPFIXL2Profile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get IPFIX L2 Profile tags: - Policy - Monitoring - IPFIX - Switch IPFIX Profiles x-vmw-nsx-module: PolicyIPFIXSwitch patch: consumes: - application/json description: | Create a new IPFIX L2 profile if the IPFIX L2 profile with given id does not already exist. If the IPFIX L2 profile with the given id already exists, patch with the existing IPFIX L2 profile. operationId: GlobalInfraPatchIPFIXL2Profile parameters: - description: |- IPFIX L2 Profile ID in: path name: ipfix-l2-profile-id required: true type: string - in: body name: IPFIXL2Profile required: true schema: $ref: '#/definitions/IPFIXL2Profile' - default: false description: Locally override the global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Patch IPFIX L2profile tags: - Policy - Monitoring - IPFIX - Switch IPFIX Profiles x-vmw-nsx-module: PolicyIPFIXSwitch put: consumes: - application/json description: | Create or replace IPFIX L2 Profile. Profile is reusable entity. Single profile can attached multiple bindings e.g group, segment and port. operationId: GlobalInfraCreateOrReplaceIPFIXL2Profile parameters: - description: |- IPFIX L2 Profile ID in: path name: ipfix-l2-profile-id required: true type: string - in: body name: IPFIXL2Profile required: true schema: $ref: '#/definitions/IPFIXL2Profile' - default: false description: Locally override the global object in: query name: override required: false type: boolean produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/IPFIXL2Profile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or Replace IPFIX L2 profile tags: - Policy - Monitoring - IPFIX - Switch IPFIX Profiles x-vmw-nsx-module: PolicyIPFIXSwitch /global-infra/ipv6-dad-profiles: get: consumes: - application/json description: | Paginated list of all IPv6 DAD profile instances operationId: GlobalInfraListIpv6DadProfiles parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/Ipv6DadProfileListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List all IPv6 DAD profiles tags: - Policy - Networking - Networking Profiles - IPV6 DAD Profiles x-vmw-nsx-module: PolicyConnectivity /global-infra/ipv6-dad-profiles/{dad-profile-id}: delete: consumes: - application/json description: |- Delete IPv6 DAD profile operationId: GlobalInfraDeleteIpv6DadProfile parameters: - in: path name: dad-profile-id required: true type: string - default: false description: Locally override the global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete IPv6 DAD profile tags: - Policy - Networking - Networking Profiles - IPV6 DAD Profiles x-vmw-nsx-module: PolicyConnectivity get: consumes: - application/json description: |- Read IPv6 DAD profile operationId: GlobalInfraReadIpv6DadProfile parameters: - in: path name: dad-profile-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/Ipv6DadProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read IPv6 DAD profile tags: - Policy - Networking - Networking Profiles - IPV6 DAD Profiles x-vmw-nsx-module: PolicyConnectivity patch: consumes: - application/json description: | If profile with the dad-profile-id is not already present, create a new IPv6 DAD profile instance. If it already exists, update the IPv6 DAD profile instance with specified attributes. operationId: GlobalInfraPatchIpv6DadProfile parameters: - in: path name: dad-profile-id required: true type: string - in: body name: Ipv6DadProfile required: true schema: $ref: '#/definitions/Ipv6DadProfile' - default: false description: Locally override the global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or update IPv6 DAD profile tags: - Policy - Networking - Networking Profiles - IPV6 DAD Profiles x-vmw-nsx-module: PolicyConnectivity put: consumes: - application/json description: | If profile with the dad-profile-id is not already present, create a new IPv6 DAD profile instance. If it already exists, replace the IPv6 DAD profile instance with this object. operationId: GlobalInfraCreateOrReplaceIpv6DadProfile parameters: - in: path name: dad-profile-id required: true type: string - in: body name: Ipv6DadProfile required: true schema: $ref: '#/definitions/Ipv6DadProfile' - default: false description: Locally override the global object in: query name: override required: false type: boolean produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/Ipv6DadProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or update IPv6 DAD profile tags: - Policy - Networking - Networking Profiles - IPV6 DAD Profiles x-vmw-nsx-module: PolicyConnectivity /global-infra/ipv6-ndra-profiles: get: consumes: - application/json description: | Paginated list of all IPv6 NDRA profile instances operationId: GlobalInfraListIpv6NdraProfiles parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/Ipv6NdraProfileListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List all IPv6 NDRA profiles tags: - Policy - Networking - Networking Profiles - IPV6 NDRA Profiles x-vmw-nsx-module: PolicyConnectivity /global-infra/ipv6-ndra-profiles/{ndra-profile-id}: delete: consumes: - application/json description: |- Delete IPv6 NDRA profile operationId: GlobalInfraDeleteIpv6NdraProfile parameters: - in: path name: ndra-profile-id required: true type: string - default: false description: Locally override the global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete IPv6 NDRA profile tags: - Policy - Networking - Networking Profiles - IPV6 NDRA Profiles x-vmw-nsx-module: PolicyConnectivity get: consumes: - application/json description: |- Read IPv6 NDRA profile operationId: GlobalInfraReadIpv6NdraProfile parameters: - in: path name: ndra-profile-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/Ipv6NdraProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read IPv6 NDRA profile tags: - Policy - Networking - Networking Profiles - IPV6 NDRA Profiles x-vmw-nsx-module: PolicyConnectivity patch: consumes: - application/json description: | If profile with the ndra-profile-id is not already present, create a new IPv6 NDRA profile instance. If it already exists, update the IPv6 NDRA profile instance with specified attributes. operationId: GlobalInfraPatchIpv6NdraProfile parameters: - in: path name: ndra-profile-id required: true type: string - in: body name: Ipv6NdraProfile required: true schema: $ref: '#/definitions/Ipv6NdraProfile' - default: false description: Locally override the global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or update IPv6 NDRA profile tags: - Policy - Networking - Networking Profiles - IPV6 NDRA Profiles x-vmw-nsx-module: PolicyConnectivity put: consumes: - application/json description: | If profile with the ndra-profile-id is not already present, create a new IPv6 NDRA profile instance. If it already exists, replace the IPv6 NDRA profile instance with this object. operationId: GlobalInfraCreateOrReplaceIpv6NdraProfile parameters: - in: path name: ndra-profile-id required: true type: string - in: body name: Ipv6NdraProfile required: true schema: $ref: '#/definitions/Ipv6NdraProfile' - default: false description: Locally override the global object in: query name: override required: false type: boolean produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/Ipv6NdraProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or update IPv6 NDRA profile tags: - Policy - Networking - Networking Profiles - IPV6 NDRA Profiles x-vmw-nsx-module: PolicyConnectivity /global-infra/labels: get: consumes: - application/json description: | Paginated list of all labels for infra. operationId: GlobalInfraListPolicyLabelForInfra parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyLabelListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List labels for infra tags: - Policy - Infra - Labels x-vmw-nsx-module: PolicyLabel /global-infra/labels/{label-id}: get: consumes: - application/json description: | Read a label. operationId: GlobalInfraReadPolicyLabelForInfra parameters: - in: path name: label-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyLabel' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read lable tags: - Policy - Infra - Labels x-vmw-nsx-module: PolicyLabel /global-infra/mac-discovery-profiles: get: consumes: - application/json description: | API will list all Mac Discovery Profiles active in current discovery profile id. operationId: GlobalInfraGetMacDiscoveryProfiles parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/MacDiscoveryProfileListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Mac Discovery Profiles tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - MAC Discovery Profiles x-vmw-nsx-module: PolicyMacDiscovery /global-infra/mac-discovery-profiles/{mac-discovery-profile-id}: delete: consumes: - application/json description: | API will delete Mac Discovery profile. operationId: GlobalInfraDeleteMacDiscoveryProfile parameters: - description: |- Mac Discovery Profile ID in: path name: mac-discovery-profile-id required: true type: string - default: false description: Locally override the global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete Mac Discovery Profile tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - MAC Discovery Profiles x-vmw-nsx-module: PolicyMacDiscovery get: consumes: - application/json description: | API will get Mac Discovery profile. operationId: GlobalInfraGetMacDiscoveryProfile parameters: - description: |- Mac Discovery Profile ID in: path name: mac-discovery-profile-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/MacDiscoveryProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Mac Discovery Profile tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - MAC Discovery Profiles x-vmw-nsx-module: PolicyMacDiscovery patch: consumes: - application/json description: | API will create Mac Discovery profile. operationId: GlobalInfraCreateMacDiscoveryProfile parameters: - description: |- Mac Discovery Profile ID in: path name: mac-discovery-profile-id required: true type: string - in: body name: MacDiscoveryProfile required: true schema: $ref: '#/definitions/MacDiscoveryProfile' - default: false description: Locally override the global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create Mac Discovery Profile tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - MAC Discovery Profiles x-vmw-nsx-module: PolicyMacDiscovery put: consumes: - application/json description: | API will update Mac Discovery profile. operationId: GlobalInfraUpdateMacDiscoveryProfile parameters: - description: |- Mac Discovery Profile ID in: path name: mac-discovery-profile-id required: true type: string - in: body name: MacDiscoveryProfile required: true schema: $ref: '#/definitions/MacDiscoveryProfile' - default: false description: Locally override the global object in: query name: override required: false type: boolean produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/MacDiscoveryProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Update Mac Discovery Profile tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - MAC Discovery Profiles x-vmw-nsx-module: PolicyMacDiscovery /global-infra/metadata-proxies/{metadata-proxy-id}/statistics: get: consumes: - application/json description: |- Get metadata proxy status operationId: GlobalInfraReadMetadataProxyStatistics parameters: - in: path name: metadata-proxy-id required: true type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string - description: String Path of the segment which is associated with this metadata proxy in: query name: segment_path required: false type: string - description: Data source type. enum: - realtime - cached in: query name: source required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyMetadataProxyStatistics' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get metadata proxy status tags: - Policy - Networking - Network Services - Metadata Proxy - Status x-vmw-nsx-module: PolicyMetadataProxy /global-infra/metadata-proxies/{metadata-proxy-id}/status: get: consumes: - application/json description: |- Get metadata proxy status operationId: GlobalInfraReadMetadataProxyStatus parameters: - in: path name: metadata-proxy-id required: true type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string - description: String Path of the segment which is associated with this metadata proxy in: query name: segment_path required: false type: string - description: Data source type. enum: - realtime - cached in: query name: source required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyMetadataProxyStatus' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get metadata proxy status tags: - Policy - Networking - Network Services - Metadata Proxy - Status x-vmw-nsx-module: PolicyMetadataProxy /global-infra/pod-group-associations: get: consumes: - application/json description: | Get policy groups for which the given pod is a member. operationId: GlobalInfraGetGroupsForContainerApplicationInstance parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - description: ContainerApplicationInstance in: query name: pod_id required: true type: string - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyResourceReferenceForEPListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get groups for which the given pod is a member tags: - Policy - Inventory - Groups - Group Members x-vmw-nsx-module: PolicyGroupRealization /global-infra/port-mirroring-profiles: get: consumes: - application/json description: | API will list all port mirroring profiles group. operationId: GlobalInfraListPortMirroringProfiles parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PortMirroringProfileListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Port Mirroring Profiles tags: - Policy - Monitoring - Port Mirroring x-vmw-nsx-module: PolicyPortMirroring /global-infra/port-mirroring-profiles/{port-mirroring-profile-id}: delete: consumes: - application/json description: | API will delete port mirroring profile. Mirroring from source to destination ports will be stopped. operationId: GlobalInfraDeletePortMirroringProfile parameters: - description: |- Port Mirroring Profile Id in: path name: port-mirroring-profile-id required: true type: string - default: false description: Locally override the global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete Port Mirroring Profile tags: - Policy - Monitoring - Port Mirroring x-vmw-nsx-module: PolicyPortMirroring get: consumes: - application/json description: | API will return details of port mirroring profile. operationId: GlobalInfraReadPortMirroringProfile parameters: - description: |- Port Mirroring Profile Id in: path name: port-mirroring-profile-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PortMirroringProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: | Details of Port Mirroring Profile tags: - Policy - Monitoring - Port Mirroring x-vmw-nsx-module: PolicyPortMirroring patch: consumes: - application/json description: | Create a new Port Mirroring Profile if the Port Mirroring Profile with given id does not already exist. If the Port Mirroring Profile with the given id already exists, patch with the existing Port Mirroring Profile. Realized entities of this API can be found using the path of monitoring profile binding map that is used to apply this profile. operationId: GlobalInfraPatchPortMirroringProfile parameters: - description: |- Port Mirroring Profile Id in: path name: port-mirroring-profile-id required: true type: string - in: body name: PortMirroringProfile required: true schema: $ref: '#/definitions/PortMirroringProfile' - default: false description: Locally override the global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Patch Port Mirroring Profile. tags: - Policy - Monitoring - Port Mirroring x-vmw-nsx-module: PolicyPortMirroring put: consumes: - application/json description: | Create or Replace port mirroring profile. Packets will be mirrored from source group, segment, port to destination group. Realized entities of this API can be found using the path of monitoring profile binding map that is used to apply this profile. operationId: GlobalInfraCreateOrReplacePortMirroringProfile parameters: - description: |- Port Mirroring Profiles Id in: path name: port-mirroring-profile-id required: true type: string - in: body name: PortMirroringProfile required: true schema: $ref: '#/definitions/PortMirroringProfile' - default: false description: Locally override the global object in: query name: override required: false type: boolean produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PortMirroringProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or Replace Port Mirroring Profile. tags: - Policy - Monitoring - Port Mirroring x-vmw-nsx-module: PolicyPortMirroring /global-infra/qos-profiles: get: consumes: - application/json description: | API will list all QoS profiles. operationId: GlobalInfraListQoSProfiles parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/QoSProfileListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List QoS Profiles tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - QOS Profiles x-vmw-nsx-module: PolicyQoS /global-infra/qos-profiles/{qos-profile-id}: delete: consumes: - application/json description: | API will delete QoS profile. operationId: GlobalInfraDeleteQoSProfile parameters: - description: |- QoS profile Id in: path name: qos-profile-id required: true type: string - default: false description: Locally override the global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete QoS profile tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - QOS Profiles x-vmw-nsx-module: PolicyQoS get: consumes: - application/json description: | API will return details of QoS profile. operationId: GlobalInfraReadQoSProfile parameters: - description: |- QoS profile Id in: path name: qos-profile-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/QoSProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: | Details of QoS profile tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - QOS Profiles x-vmw-nsx-module: PolicyQoS patch: consumes: - application/json description: | Create a new QoS profile if the QoS profile with given id does not already exist. If the QoS profile with the given id already exists, patch with the existing QoS profile. operationId: GlobalInfraPatchQoSProfile parameters: - description: |- QoS profile Id in: path name: qos-profile-id required: true type: string - in: body name: QoSProfile required: true schema: $ref: '#/definitions/QoSProfile' - default: false description: Locally override the global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Patch QoS profile. tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - QOS Profiles x-vmw-nsx-module: PolicyQoS put: consumes: - application/json description: | Create or Replace QoS profile. operationId: GlobalInfraCreateOrReplaceQoSProfile parameters: - description: |- QoS profile Id in: path name: qos-profile-id required: true type: string - in: body name: QoSProfile required: true schema: $ref: '#/definitions/QoSProfile' - default: false description: Locally override the global object in: query name: override required: false type: boolean produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/QoSProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or Replace QoS profile. tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - QOS Profiles x-vmw-nsx-module: PolicyQoS /global-infra/realized-state/realized-entities: get: consumes: - application/json description: | Get list of realized entities associated with intent object, specified by path in query parameter operationId: GlobalInfraListRealizedEntities parameters: - description: String Path of the intent object in: query name: intent_path required: true type: string - description: Policy Path of the site in: query name: site_path required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/GenericPolicyRealizedResourceListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get list of realized objects associated with intent object tags: - Policy - Infra - Realized State x-vmw-nsx-module: PolicyRealizedState /global-infra/realized-state/realized-entity?action=refresh: post: consumes: - application/json description: | Refresh the status and statistics of all realized entities associated with given intent path synchronously. The vmw-async: True HTTP header cannot be used with this API. operationId: GlobalInfraRefreshRealizedState parameters: - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string - description: String Path of the intent object in: query name: intent_path required: true type: string responses: '204': description: No Content '400': description: Bad Request '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Refresh all realized entities associated with the intent-path tags: - Policy - Infra - Realized State x-vmw-nsx-module: PolicyRealizedState /global-infra/realized-state/status: get: consumes: - application/json description: | Get Consolidated Status of an intent object (with or without enforcement specific status details). The request is evaluated as follows: - <intent_path>: the request is evaluated on all enforcement points for the given intent without enforcement point specific details. - <intent_path, include_enforced_status>: the request is evaluated on all enforcement points for the given intent with enforcement point specific details. operationId: GlobalInfraReadIntentStatus parameters: - default: false description: Include Enforced Status Flag in: query name: include_enforced_status type: boolean - description: Policy Path of the intent object in: query name: intent_path required: true type: string - description: Policy Path of the site from where the realization status needs to be fetched in: query name: site_path required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ConsolidatedRealizedStatus' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get consolidated status of an intent object tags: - Policy - Infra - Realized State x-vmw-nsx-module: PolicyRealizedState /global-infra/security-global-config: get: consumes: - application/json description: | This reads the security-global-config used for NSX Manager appliance certificates. These properties are not sent to the hosts. operationId: GlobalInfraReadSecurityGlobalConfig produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/InfraSecurityConfig' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read security global configuration x-vmw-nsx-module: Policy put: consumes: - application/json description: | This updates the security-global-config used for NSX Manager appliance certificates. These properties are not sent to the hosts. operationId: GlobalInfraUpdateSecurityGlobalConfig parameters: - in: body name: InfraSecurityConfig required: true schema: $ref: '#/definitions/InfraSecurityConfig' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/InfraSecurityConfig' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Update the security global configuration x-vmw-nsx-module: Policy /global-infra/security/tls-inspection-config-profiles: get: consumes: - application/json description: |- API will list all TLS Config Profiles operationId: GlobalInfraListPolicyTlsConfigProfiles parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyTlsConfigProfileListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List TLS Config Profiles tags: - Policy - Security - North South Security - Gateway Firewall - Tls Inspection - Tls Config x-vmw-nsx-module: PolicyTlsConfigProfile /global-infra/security/tls-inspection-config-profiles/{tls-inspection-config-profile}: delete: consumes: - application/json description: |- API will delete TLS Config Profile operationId: GlobalInfraDeletePolicyTlsConfigProfile parameters: - description: |- TLS Config Profile ID in: path name: tls-inspection-config-profile required: true type: string - default: false description: Locally override the global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete TLS Config Profile tags: - Policy - Security - North South Security - Gateway Firewall - Tls Inspection - Tls Config x-vmw-nsx-module: PolicyTlsConfigProfile get: consumes: - application/json description: |- API will get TLS Config Profile operationId: GlobalInfraGetPolicyTlsConfigProfile parameters: - description: |- TLS Config Profile ID in: path name: tls-inspection-config-profile required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyTlsConfigProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get TLS Config Profile tags: - Policy - Security - North South Security - Gateway Firewall - Tls Inspection - Tls Config x-vmw-nsx-module: PolicyTlsConfigProfile patch: consumes: - application/json description: |- API will create/update TLS Config Profile operationId: GlobalInfraPatchPolicyTlsConfigProfile parameters: - description: |- TLS Config Profile ID in: path name: tls-inspection-config-profile required: true type: string - in: body name: PolicyTlsConfigProfile required: true schema: $ref: '#/definitions/PolicyTlsConfigProfile' - default: false description: Locally override the global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or update TLS Config Profile tags: - Policy - Security - North South Security - Gateway Firewall - Tls Inspection - Tls Config x-vmw-nsx-module: PolicyTlsConfigProfile put: consumes: - application/json description: |- API will update TLS Config Profile operationId: GlobalInfraUpdatePolicyTlsConfigProfile parameters: - description: |- TLS Config Profile ID in: path name: tls-inspection-config-profile required: true type: string - in: body name: PolicyTlsConfigProfile required: true schema: $ref: '#/definitions/PolicyTlsConfigProfile' - default: false description: Locally override the global object in: query name: override required: false type: boolean produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyTlsConfigProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Update TLS Config Profile tags: - Policy - Security - North South Security - Gateway Firewall - Tls Inspection - Tls Config x-vmw-nsx-module: PolicyTlsConfigProfile /global-infra/segment-security-profiles: get: consumes: - application/json description: | API will list all segment security profiles. operationId: GlobalInfraListSegmentSecurityProfiles parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentSecurityProfileListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List segment security profiles tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Segment Security Profiles x-vmw-nsx-module: PolicySegmentSecurity /global-infra/segment-security-profiles/{segment-security-profile-id}: delete: consumes: - application/json description: | API will delete segment security profile with the given id. operationId: GlobalInfraDeleteSegmentSecurityProfile parameters: - description: |- Segment security profile id in: path name: segment-security-profile-id required: true type: string - default: false description: Locally override the global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- DELETE segment security profile tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Segment Security Profiles x-vmw-nsx-module: PolicySegmentSecurity get: consumes: - application/json description: | API will return details of the segment security profile with given id. If the profile does not exist, it will return 404. operationId: GlobalInfraGetSegmentSecurityProfile parameters: - description: |- Segment security profile id in: path name: segment-security-profile-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentSecurityProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- GET Segment security profile id tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Segment Security Profiles x-vmw-nsx-module: PolicySegmentSecurity patch: consumes: - application/json description: | Create a new segment security profile if the segment security profile with given id does not exist. Otherwise, PATCH the existing segment security profile operationId: GlobalInfraPatchSegmentSecurityProfile parameters: - description: |- Segment security profile id in: path name: segment-security-profile-id required: true type: string - in: body name: SegmentSecurityProfile required: true schema: $ref: '#/definitions/SegmentSecurityProfile' - default: false description: Locally override the global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- PATCH segment security profile id tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Segment Security Profiles x-vmw-nsx-module: PolicySegmentSecurity put: consumes: - application/json description: | Create or replace a segment security profile operationId: GlobalInfraCreateOrUpdateSegmentSecurityProfile parameters: - description: |- Segment security profile id in: path name: segment-security-profile-id required: true type: string - in: body name: SegmentSecurityProfile required: true schema: $ref: '#/definitions/SegmentSecurityProfile' - default: false description: Locally override the global object in: query name: override required: false type: boolean produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentSecurityProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- PUT segment security profile id tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Segment Security Profiles x-vmw-nsx-module: PolicySegmentSecurity /global-infra/segments: get: consumes: - application/json description: | Paginated list of all segments under infra. operationId: GlobalInfraListAllInfraSegments parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - description: Segment type enum: - DVPortgroup - ALL in: query name: segment_type type: string - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List all segments under infra tags: - Policy - Networking - Connectivity - Segments - Segments x-vmw-nsx-module: PolicyConnectivity /global-infra/segments/state: get: consumes: - application/json description: | Returns all infra segments with configuration state on the enforcement point specified in the request operationId: GlobalInfraGetInfraSegmentsByState parameters: - description: Configuration state of the segment on enforcement point enum: - pending - in_progress - success - failed - partial_success - orphaned - unknown in: query name: configuration_state required: false type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string - description: Data source type. enum: - realtime - cached in: query name: source required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentConfigurationStateListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get infra segments by configuration state tags: - Policy - Networking - Connectivity - Segments - Statistics x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-discovery-profile-binding-maps: get: consumes: - application/json description: | API will list all Infra Port Discovery Profile Binding Maps in current port id. operationId: GlobalInfraListInfraPortDiscoveryBindings parameters: - in: path name: infra-segment-id required: true type: string - in: path name: infra-port-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PortDiscoveryProfileBindingMapListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Infra Port Discovery Profile Binding Maps tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Discovery Profile Binding x-vmw-nsx-module: PolicyDiscoveryProfileBinding ? /global-infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id} : delete: consumes: - application/json description: |- API will delete Infra Port Discovery Profile Binding Profile operationId: GlobalInfraDeleteInfraPortDiscoveryBinding parameters: - description: |- Infra Segment ID in: path name: infra-segment-id required: true type: string - description: |- Infra Port ID in: path name: infra-port-id required: true type: string - description: |- Port Discovery Profile Binding Map ID in: path name: port-discovery-profile-binding-map-id required: true type: string responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete Infra Port Discovery Profile Binding Profile tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Discovery Profile Binding x-vmw-nsx-module: PolicyDiscoveryProfileBinding get: consumes: - application/json description: | API will get Infra Port Discovery Profile Binding Map operationId: GlobalInfraGetInfraPortDiscoveryBinding parameters: - description: |- Infra Segment ID in: path name: infra-segment-id required: true type: string - description: |- Infra Port ID in: path name: infra-port-id required: true type: string - description: |- Port Discovery Profile Binding Map ID in: path name: port-discovery-profile-binding-map-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PortDiscoveryProfileBindingMap' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Infra Port Discovery Profile Binding Map tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Discovery Profile Binding x-vmw-nsx-module: PolicyDiscoveryProfileBinding patch: consumes: - application/json description: |- API will create Infra Port Discovery Profile Binding Map. For objects with no binding maps, default profile is applied. operationId: GlobalInfraPatchInfraPortDiscoveryBinding parameters: - description: |- Infra Segment ID in: path name: infra-segment-id required: true type: string - description: |- Port ID in: path name: infra-port-id required: true type: string - description: |- Port Discovery Profile Binding Map ID in: path name: port-discovery-profile-binding-map-id required: true type: string - in: body name: PortDiscoveryProfileBindingMap required: true schema: $ref: '#/definitions/PortDiscoveryProfileBindingMap' responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create Infra Port Discovery Profile Binding Map tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Discovery Profile Binding x-vmw-nsx-module: PolicyDiscoveryProfileBinding put: consumes: - application/json description: |- API will update Infra Port Discovery Profile Binding Map. For objects with no binding maps, default profile is applied. operationId: GlobalInfraUpdateInfraPortDiscoveryBinding parameters: - description: |- Infra Segment ID in: path name: infra-segment-id required: true type: string - description: |- Infra Port ID in: path name: infra-port-id required: true type: string - description: |- Port Discovery Profile Binding Map ID in: path name: port-discovery-profile-binding-map-id required: true type: string - in: body name: PortDiscoveryProfileBindingMap required: true schema: $ref: '#/definitions/PortDiscoveryProfileBindingMap' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PortDiscoveryProfileBindingMap' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Update Infra Port Discovery Profile Binding Map tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Discovery Profile Binding x-vmw-nsx-module: PolicyDiscoveryProfileBinding /global-infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-monitoring-profile-binding-maps: get: consumes: - application/json description: | API will list all Infra Port Monitoring Profile Binding Maps in current port id. operationId: GlobalInfraListInfraPortMonitoringBindings parameters: - in: path name: infra-segment-id required: true type: string - in: path name: infra-port-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PortMonitoringProfileBindingMapListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Infra Port Monitoring Profile Binding Maps tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Monitoring Profile Binding x-vmw-nsx-module: PolicyMonitoringProfileBinding ? /global-infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-monitoring-profile-binding-maps/{port-monitoring-profile-binding-map-id} : delete: consumes: - application/json description: |- API will delete Infra Port Monitoring Profile Binding Profile. operationId: GlobalInfraDeleteInfraPortMonitoringBinding parameters: - description: |- Infra Segment ID in: path name: infra-segment-id required: true type: string - description: |- Infra Port ID in: path name: infra-port-id required: true type: string - description: |- Port Monitoring Profile Binding Map ID in: path name: port-monitoring-profile-binding-map-id required: true type: string responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete Infra Port Monitoring Profile Binding Profile tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Monitoring Profile Binding x-vmw-nsx-module: PolicyMonitoringProfileBinding get: consumes: - application/json description: | API will get Infra Port Monitoring Profile Binding Map. operationId: GlobalInfraGetInfraPortMonitoringBinding parameters: - description: |- Infra Segment ID in: path name: infra-segment-id required: true type: string - description: |- Infra Port ID in: path name: infra-port-id required: true type: string - description: |- Port Monitoring Profile Binding Map ID in: path name: port-monitoring-profile-binding-map-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PortMonitoringProfileBindingMap' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Infra Port Monitoring Profile Binding Map tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Monitoring Profile Binding x-vmw-nsx-module: PolicyMonitoringProfileBinding patch: consumes: - application/json description: |- API will create Infra Port Monitoring Profile Binding Map. operationId: GlobalInfraPatchInfraPortMonitoringBinding parameters: - description: |- Infra Segment ID in: path name: infra-segment-id required: true type: string - description: |- Infra Port ID in: path name: infra-port-id required: true type: string - description: |- Port Monitoring Profile Binding Map ID in: path name: port-monitoring-profile-binding-map-id required: true type: string - in: body name: PortMonitoringProfileBindingMap required: true schema: $ref: '#/definitions/PortMonitoringProfileBindingMap' responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create Infra Port Monitoring Profile Binding Map tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Monitoring Profile Binding x-vmw-nsx-module: PolicyMonitoringProfileBinding put: consumes: - application/json description: |- API will update Infra Port Monitoring Profile Binding Map. operationId: GlobalInfraUpdateInfraPortMonitoringBinding parameters: - description: |- InfraSegment ID in: path name: infra-segment-id required: true type: string - description: |- Infra Port ID in: path name: infra-port-id required: true type: string - description: |- Port Monitoring Profile Binding Map ID in: path name: port-monitoring-profile-binding-map-id required: true type: string - in: body name: PortMonitoringProfileBindingMap required: true schema: $ref: '#/definitions/PortMonitoringProfileBindingMap' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PortMonitoringProfileBindingMap' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Update Infra Port Monitoring Profile Binding Map tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Monitoring Profile Binding x-vmw-nsx-module: PolicyMonitoringProfileBinding ? /global-infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-monitoring-profile-binding-maps/{port-monitoring-profile-binding-map-id}/mirror-stack-status : get: consumes: - application/json description: | API will get Infra Port Monitoring Profile Binding Map mirror stack status. operationId: GlobalInfraGetInfraPortMonitoringBindingMirrorStackStatus parameters: - in: path name: infra-segment-id required: true type: string - in: path name: infra-port-id required: true type: string - in: path name: port-monitoring-profile-binding-map-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Binding map path enforcemnt point path to remote L3 mirror session in: query name: enforcement_point_path required: false type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/MirrorStackStatusListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get mirror stack status for Infra Port Monitoring Profile Binding Map tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Monitoring Profile Binding x-vmw-nsx-module: PolicyMonitoringProfileBinding /global-infra/segments/{infra-segment-id}/segment-discovery-profile-binding-maps: get: consumes: - application/json description: | API will list all Infra Segment Discovery Profile Binding Maps in current segment id. operationId: GlobalInfraListInfraSegmentDiscoveryBindings parameters: - in: path name: infra-segment-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentDiscoveryProfileBindingMapListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Infra Segment Discovery Profile Binding Maps tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Discovery Profile Binding x-vmw-nsx-module: PolicyDiscoveryProfileBinding ? /global-infra/segments/{infra-segment-id}/segment-discovery-profile-binding-maps/{segment-discovery-profile-binding-map-id} : get: consumes: - application/json description: | API will get Infra Segment Discovery Profile Binding Map operationId: GlobalInfraGetInfraSegmentDiscoveryBinding parameters: - description: |- Infra Segment ID in: path name: infra-segment-id required: true type: string - description: |- Segment Discovery Profile Binding Map ID in: path name: segment-discovery-profile-binding-map-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentDiscoveryProfileBindingMap' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Infra Segment Discovery Profile Binding Map tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Discovery Profile Binding x-vmw-nsx-module: PolicyDiscoveryProfileBinding /global-infra/segments/{infra-segment-id}/segment-monitoring-profile-binding-maps: get: consumes: - application/json description: | API will list all Infra Segment Monitoring Profile Binding Maps in current segment id. operationId: GlobalInfraListInfraSegmentMonitoringBindings parameters: - in: path name: infra-segment-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentMonitoringProfileBindingMapListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Infra Segment Monitoring Profile Binding Maps tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Monitoring Profile Binding x-vmw-nsx-module: PolicyMonitoringProfileBinding ? /global-infra/segments/{infra-segment-id}/segment-monitoring-profile-binding-maps/{segment-monitoring-profile-binding-map-id} : get: consumes: - application/json description: | API will get Infra Segment Monitoring Profile Binding Map. operationId: GlobalInfraGetInfraSegmentMonitoringBinding parameters: - description: |- Infra Segment ID in: path name: infra-segment-id required: true type: string - description: |- Segment Monitoring Profile Binding Map ID in: path name: segment-monitoring-profile-binding-map-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentMonitoringProfileBindingMap' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Infra Segment Monitoring Profile Binding Map tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Monitoring Profile Binding x-vmw-nsx-module: PolicyMonitoringProfileBinding ? /global-infra/segments/{infra-segment-id}/segment-monitoring-profile-binding-maps/{segment-monitoring-profile-binding-map-id}/mirror-stack-status : get: consumes: - application/json description: | API will get Infra Segment Monitoring Profile Binding Map mirror stack status. operationId: GlobalInfraGetInfraSegmentMonitoringBindingMirrorStackStatus parameters: - in: path name: infra-segment-id required: true type: string - in: path name: segment-monitoring-profile-binding-map-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Binding map path enforcemnt point path to remote L3 mirror session in: query name: enforcement_point_path required: false type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/MirrorStackStatusListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Infra Segment Monitoring Profile Binding Map tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Monitoring Profile Binding x-vmw-nsx-module: PolicyMonitoringProfileBinding /global-infra/segments/{segment-id}: get: consumes: - application/json description: | Read infra segment Note: Extended Segment: Please note that old vpn path deprecated. If user specify old l2vpn path in the "l2_extension" object in the PATCH API payload, the path returned in the GET response payload may include the new path instead of the deprecated l2vpn path. Both old and new l2vpn path refer to same resource. there is no functional impact. Also note that l2vpn path included in the error messages returned from validation may include the new VPN path instead of the deprecated l2vpn path. Both new path and old vpn path refer to same resource. operationId: GlobalInfraReadInfraSegment parameters: - description: |- Segment ID in: path name: segment-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/Segment' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read infra segment tags: - Policy - Networking - Connectivity - Segments - Segments x-vmw-nsx-module: PolicyConnectivity /global-infra/segments/{segment-id}/arp-proxy: get: consumes: - application/json description: | Returns ARP proxy table for downlink port on connected to the segment operationId: GlobalInfraGetDownlinkPortArpProxiesForInfraSegment parameters: - in: path name: segment-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string - description: Data source type. enum: - realtime - cached in: query name: source required: false type: string - description: TransportNode Id in: query name: transport_node_id required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyArpProxyTableListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get downlink port Address Resolution Protocol Proxies for infra segment tags: - Policy - Networking - Connectivity - Segments x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/segments/{segment-id}/arp-proxy?format=csv: get: consumes: - application/json description: | Returns ARP proxy table for downlink port on connected to the segment in CSV format operationId: GlobalInfraGetDownlinkPortArpProxiesForInfraSegmentInCsv parameters: - in: path name: segment-id required: true type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - description: Data source type. enum: - realtime - cached in: query name: source required: false type: string - description: TransportNode Id in: query name: transport_node_id required: false type: string produces: - text/csv responses: '200': description: OK schema: $ref: '#/definitions/PolicyArpProxyTableCsvListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get downlink port Address Resolution Protocol Proxies for infra segment in CSV format tags: - Policy - Networking - Connectivity - Segments x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/segments/{segment-id}/arp-table: get: consumes: - application/json description: | Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) for the interface (downlink) attaching segment to tier-0/tier-1 gateway, on a edge node specified in edge_path parameter. The edge_path parameter is mandatory. operationId: GlobalInfraGetInfraSegmentInterfaceArpTable parameters: - in: path name: segment-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Policy path of edge node in: query name: edge_path type: string - description: Enforcement point path in: query name: enforcement_point_path type: string - description: Policy path of host transport node in: query name: host_transport_node_path type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/InterfaceArpTable' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get ARP table from segment interface (downlink) tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Interfaces - ARP Table x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/segments/{segment-id}/arp-table?format=csv: get: consumes: - application/json description: | Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) in CSV format for the interface (downlink) attaching segment to tier-0/tier-1 gateway, on a edge node specified in edge_path parameter. The edge_path parameter is mandatory. operationId: GlobalInfraGetInfraSegmentInterfaceArpTableCsv parameters: - in: path name: segment-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Policy path of edge node in: query name: edge_path type: string - description: Enforcement point path in: query name: enforcement_point_path type: string - description: Policy path of host transport node in: query name: host_transport_node_path type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - text/csv responses: '200': description: OK schema: $ref: '#/definitions/InterfaceArpTableInCsvFormat' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get ARP table from segment interface (downlink) in CSV format tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Interfaces - ARP Table x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/segments/{segment-id}/dhcp-static-binding-configs: get: consumes: - application/json description: | Paginated list of all DHCP static binding instances operationId: GlobalInfraListInfraSegmentDhcpStaticBinding parameters: - in: path name: segment-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/DhcpStaticBindingConfigListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List all DHCP static bindings tags: - Policy - Networking - IP Management - DHCP - DHCP Static Bindings - Segments Bindings x-vmw-nsx-module: PolicyConnectivity /global-infra/segments/{segment-id}/dhcp-static-binding-configs/{binding-id}: get: consumes: - application/json description: |- Read DHCP static binding operationId: GlobalInfraReadInfraSegmentDhcpStaticBinding parameters: - in: path name: segment-id required: true type: string - in: path name: binding-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/DhcpStaticBindingConfig' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read DHCP static binding tags: - Policy - Networking - IP Management - DHCP - DHCP Static Bindings - Segments Bindings x-vmw-nsx-module: PolicyConnectivity /global-infra/segments/{segment-id}/dhcp-static-bindings/{binding-id}/state: get: consumes: - application/json description: |- Read DHCP static binding state operationId: GlobalInfraReadInfraSegmentDhcpStaticBindingState parameters: - in: path name: segment-id required: true type: string - in: path name: binding-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/DhcpStaticBindingState' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read DHCP static binding state tags: - Policy - Networking - IP Management - DHCP - DHCP Static Bindings x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/segments/{segment-id}/gateway-interface-arp-table: get: consumes: - application/json description: | This API is deprecated because it is duplicate. Please use /infra/segments/<segment-id>/arp-table Segment ID is the ID of the segment that is connected to the the tier-0 operationId: GlobalInfraGetDownlinkPortArpTableForInfraSegment parameters: - in: path name: segment-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Policy path of edge node in: query name: edge_path type: string - description: Enforcement point path in: query name: enforcement_point_path type: string - description: Policy path of host transport node in: query name: host_transport_node_path type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/InterfaceArpTable' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get ARP table for downlink router port on tier-0 router tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Interfaces - ARP Table x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/segments/{segment-id}/gateway-interface-arp-table?format=csv: get: consumes: - application/json description: | This API is deprecated because it is duplicate. Please use /infra/segments/<segment-id>/arp-table?format=csv Segment ID is the ID of the segment that is connected to the the tier-0 operationId: GlobalInfraGetDownlinkPortArpTableForInfraSegmentInCsv parameters: - in: path name: segment-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Policy path of edge node in: query name: edge_path type: string - description: Enforcement point path in: query name: enforcement_point_path type: string - description: Policy path of host transport node in: query name: host_transport_node_path type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - text/csv responses: '200': description: OK schema: $ref: '#/definitions/InterfaceArpTableInCsvFormat' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get ARP table for downlink router port on tier-0 router in CSV tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Interfaces - ARP Table x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/segments/{segment-id}/gateway-interface-dad-state: get: consumes: - application/json description: | Segment ID is the ID of the segment that is connected to the the tier-0 operationId: GlobalInfraGetDownlinkPortDadStateForInfraSegment parameters: - in: path name: segment-id required: true type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string - description: Data source type. enum: - realtime - cached in: query name: source required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/InterfaceDADState' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get DAD state for downlink router port on tier-0 router tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Interfaces - DAD State x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/segments/{segment-id}/gateway-interface-statistics: get: consumes: - application/json description: | Segment ID is the ID of the segment that is connected to the the tier-0 operationId: GlobalInfraGetDownlinkPortStatisticsForInfraSegment parameters: - in: path name: segment-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Policy path of edge node in: query name: edge_path type: string - description: Enforcement point path in: query name: enforcement_point_path type: string - description: Policy path of host transport node in: query name: host_transport_node_path type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyInterfaceStatistics' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get statistics for downlink router port on tier-0 router tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Interfaces - Statistics x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/segments/{segment-id}/gateway-interface-statistics/summary: get: consumes: - application/json description: | Segment ID is the ID of the segment that is connected to the the tier-0 operationId: GlobalInfraGetDownlinkPortStatisticsSummaryForInfraSegment parameters: - in: path name: segment-id required: true type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string - description: Data source type. enum: - realtime - cached in: query name: source required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyInterfaceStatisticsSummary' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get statistics for downlink router port on tier-0 router tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Interfaces - Statistics x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/segments/{segment-id}/inter-site-forwarder/site-span-info: get: consumes: - application/json description: | Get infra segment cross site forwarder placement and HA statuss. operationId: GlobalInfraGetInfraSegmentCsSpanInfo parameters: - in: path name: segment-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Policy path of edge node in: query name: edge_path type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentL2ForwarderSiteSpanInfo' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get infra segment cross site forwarder placement and HA status tags: - Federation - Inter-Sites x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/segments/{segment-id}/inter-site-forwarder/status: get: consumes: - application/json description: | Get infra segment cross site traffic statistics. operationId: GlobalInfraGetInfraSegmentCsTrafficStats parameters: - in: path name: segment-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Policy path of edge node in: query name: edge_path type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentCrossSiteTrafficStats' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get infra segment cross site traffic statistics tags: - Federation - Inter-Sites x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/segments/{segment-id}/mac-table: get: consumes: - application/json description: | Returns MAC table for a segment operationId: GlobalInfraGetInfraSegmentMacTable parameters: - in: path name: segment-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string - description: Data source type. enum: - realtime - cached in: query name: source required: false type: string - description: TransportNode Id in: query name: transport_node_id required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentMacAddressListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get infra segment MAC table tags: - Policy - Networking - Connectivity - Segments - MAC Table x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/segments/{segment-id}/mac-table?format=csv: get: consumes: - application/json description: | Returns MAC table for a segment operationId: GlobalInfraGetInfraSegmentMacTableInCsv parameters: - in: path name: segment-id required: true type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - description: Data source type. enum: - realtime - cached in: query name: source required: false type: string - description: TransportNode Id in: query name: transport_node_id required: false type: string produces: - text/csv responses: '200': description: OK schema: $ref: '#/definitions/MacAddressCsvListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get infra segment MAC table in CSV tags: - Policy - Networking - Connectivity - Segments - MAC Table x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/segments/{segment-id}/ports: get: consumes: - application/json description: | List all the ports for an infra. operationId: GlobalInfraListInfraSegmentPorts parameters: - in: path name: segment-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentPortListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List infra segment ports tags: - Policy - Networking - Connectivity - Segments - Ports x-vmw-nsx-module: PolicyConnectivity /global-infra/segments/{segment-id}/ports/{port-id}: delete: consumes: - application/json description: | Delete an infra segment port by giving ID. operationId: GlobalInfraDeleteInfraSegmentPort parameters: - in: path name: segment-id required: true type: string - in: path name: port-id required: true type: string responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete an infra segment port tags: - Policy - Networking - Connectivity - Segments - Ports x-vmw-nsx-module: PolicyConnectivity get: consumes: - application/json description: | Get detail information on an infra segment port by giving ID. operationId: GlobalInfraGetInfraSegmentPort parameters: - in: path name: segment-id required: true type: string - in: path name: port-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentPort' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get infra segment port by ID tags: - Policy - Networking - Connectivity - Segments - Ports x-vmw-nsx-module: PolicyConnectivity patch: consumes: - application/json description: | Create an infra segment port if it does not exist based on the IDs, or update existing port information by replacing the port object fields which presents in the request body. operationId: GlobalInfraPatchInfraSegmentPort parameters: - in: path name: segment-id required: true type: string - in: path name: port-id required: true type: string - in: body name: SegmentPort required: true schema: $ref: '#/definitions/SegmentPort' responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Patch an infra segment port tags: - Policy - Networking - Connectivity - Segments - Ports x-vmw-nsx-module: PolicyConnectivity put: consumes: - application/json description: | Create an infra segment port if it does not exist based on the IDs, or update existing port information by replacing the port object already exists. operationId: GlobalInfraCreateOrReplaceInfraSegmentPort parameters: - in: path name: segment-id required: true type: string - in: path name: port-id required: true type: string - in: body name: SegmentPort required: true schema: $ref: '#/definitions/SegmentPort' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentPort' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or update an infra segment port tags: - Policy - Networking - Connectivity - Segments - Ports x-vmw-nsx-module: PolicyConnectivity /global-infra/segments/{segment-id}/ports/{port-id}/mac-table: get: consumes: - application/json description: | Returns MAC table for a segment port operationId: GlobalInfraGetInfraSegmentPortMacTable parameters: - in: path name: segment-id required: true type: string - in: path name: port-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string - description: Data source type. enum: - realtime - cached in: query name: source required: false type: string - description: TransportNode Id in: query name: transport_node_id required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentPortMacAddressListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get MAC table for infra segment port tags: - Policy - Networking - Connectivity - Segments - Ports - MAC Table x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/segments/{segment-id}/ports/{port-id}/mac-table?format=csv: get: consumes: - application/json description: | Returns MAC table for a segment port operationId: GlobalInfraGetInfraSegmentPortMacTableInCsv parameters: - in: path name: segment-id required: true type: string - in: path name: port-id required: true type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - description: Data source type. enum: - realtime - cached in: query name: source required: false type: string - description: TransportNode Id in: query name: transport_node_id required: false type: string produces: - text/csv responses: '200': description: OK schema: $ref: '#/definitions/SegmentPortMacAddressCsvListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get infra segment port MAC table in CSV tags: - Policy - Networking - Connectivity - Segments - Ports - MAC Table x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps: get: consumes: - application/json description: | API will list all Port QoS Profile Binding Maps in current port id. operationId: GlobalInfraListInfraPortQoSBindings parameters: - in: path name: segment-id required: true type: string - in: path name: port-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PortQoSProfileBindingMapListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Port QoS Profile Binding Maps tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - QOS Profile Binding x-vmw-nsx-module: PolicyQoSProfileBinding /global-infra/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}: delete: consumes: - application/json description: |- API will delete Port QoS Profile Binding Profile. operationId: GlobalInfraDeleteInfraPortQoSBinding parameters: - description: |- Segment ID in: path name: segment-id required: true type: string - description: |- Port ID in: path name: port-id required: true type: string - description: |- Port QoS Profile Binding Map ID in: path name: port-qos-profile-binding-map-id required: true type: string responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete Port QoS Profile Binding Profile tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - QOS Profile Binding x-vmw-nsx-module: PolicyQoSProfileBinding get: consumes: - application/json description: | API will get Port QoS Profile Binding Map. operationId: GlobalInfraGetInfraPortQoSBinding parameters: - description: |- Segment ID in: path name: segment-id required: true type: string - description: |- Port ID in: path name: port-id required: true type: string - description: |- Port QoS Profile Binding Map ID in: path name: port-qos-profile-binding-map-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PortQoSProfileBindingMap' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Port QoS Profile Binding Map tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - QOS Profile Binding x-vmw-nsx-module: PolicyQoSProfileBinding patch: consumes: - application/json description: |- API will create Port QoS Profile Binding Map. For objects with no binding maps, default profile is applied. operationId: GlobalInfraPatchInfraPortQoSBinding parameters: - description: |- Segment ID in: path name: segment-id required: true type: string - description: |- Port ID in: path name: port-id required: true type: string - description: |- Port QoS Profile Binding Map ID in: path name: port-qos-profile-binding-map-id required: true type: string - in: body name: PortQoSProfileBindingMap required: true schema: $ref: '#/definitions/PortQoSProfileBindingMap' responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create Port QoS Profile Binding Map tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - QOS Profile Binding x-vmw-nsx-module: PolicyQoSProfileBinding put: consumes: - application/json description: |- API will update Port QoS Profile Binding Map. For objects with no binding maps, default profile is applied. operationId: GlobalInfraUpdateInfraPortQoSBinding parameters: - description: |- Segment ID in: path name: segment-id required: true type: string - description: |- Port ID in: path name: port-id required: true type: string - description: |- Port QoS Profile Binding Map ID in: path name: port-qos-profile-binding-map-id required: true type: string - in: body name: PortQoSProfileBindingMap required: true schema: $ref: '#/definitions/PortQoSProfileBindingMap' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PortQoSProfileBindingMap' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Update Port QoS Profile Binding Map tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - QOS Profile Binding x-vmw-nsx-module: PolicyQoSProfileBinding /global-infra/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps: get: consumes: - application/json description: | API will list all port security profile binding maps. operationId: GlobalInfraListInfraSegmentPortSecurityProfileBindings parameters: - description: |- segment id in: path name: segment-id required: true type: string - description: |- port id in: path name: port-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PortSecurityProfileBindingMapListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List infra segment port security profile binding maps tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Segment Security Profile Binding x-vmw-nsx-module: PolicySecurityProfileBinding ? /global-infra/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id} : delete: consumes: - application/json description: | API will delete the port security profile binding map. operationId: GlobalInfraDeleteInfraSegmentPortSecurityProfileBinding parameters: - description: |- segment id in: path name: segment-id required: true type: string - description: |- port id in: path name: port-id required: true type: string - description: |- port security profile binding map id in: path name: port-security-profile-binding-map-id required: true type: string responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete the infra segment port security profile binding map tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Segment Security Profile Binding x-vmw-nsx-module: PolicySecurityProfileBinding get: consumes: - application/json description: | API will return details of the port security profile binding map. If the security profile binding map does not exist, it will return 404. operationId: GlobalInfraGetInfraSegmentPortSecurityProfileBinding parameters: - description: |- segment id in: path name: segment-id required: true type: string - description: |- port id in: path name: port-id required: true type: string - description: |- port security profile binding map id in: path name: port-security-profile-binding-map-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PortSecurityProfileBindingMap' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get infra segment port security profile binding map tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Segment Security Profile Binding x-vmw-nsx-module: PolicySecurityProfileBinding patch: consumes: - application/json description: | Create a new port security profile binding map if the given security profile binding map does not exist. Otherwise, patch the existing port security profile binding map. For objects with no binding maps, default profile is applied. operationId: GlobalInfraPatchInfraSegmentPortSecurityProfileBinding parameters: - description: |- segment id in: path name: segment-id required: true type: string - description: |- port id in: path name: port-id required: true type: string - description: |- port security profile binding map id in: path name: port-security-profile-binding-map-id required: true type: string - in: body name: PortSecurityProfileBindingMap required: true schema: $ref: '#/definitions/PortSecurityProfileBindingMap' responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Patch infra segment port security profile binding map tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Segment Security Profile Binding x-vmw-nsx-module: PolicySecurityProfileBinding put: consumes: - application/json description: | API will create or replace the port security profile binding map. For objects with no binding maps, default profile is applied. operationId: GlobalInfraCreateOrUpdateInfraSegmentPortSecurityProfileBinding parameters: - description: |- segment id in: path name: segment-id required: true type: string - description: |- port id in: path name: port-id required: true type: string - description: |- port security profile binding map id in: path name: port-security-profile-binding-map-id required: true type: string - in: body name: PortSecurityProfileBindingMap required: true schema: $ref: '#/definitions/PortSecurityProfileBindingMap' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PortSecurityProfileBindingMap' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or replace the infra segment port security profile binding map tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Segment Security Profile Binding x-vmw-nsx-module: PolicySecurityProfileBinding /global-infra/segments/{segment-id}/ports/{port-id}/state: get: consumes: - application/json description: | Returns infra segment port state on enforcement point operationId: GlobalInfraGetInfraSegmentPortState parameters: - in: path name: segment-id required: true type: string - in: path name: port-id required: true type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string - description: Data source type. enum: - realtime - cached in: query name: source required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentPortState' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get infra segment port state tags: - Policy - Networking - Connectivity - Segments - Ports - State x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/segments/{segment-id}/segment-qos-profile-binding-maps: get: consumes: - application/json description: | API will list all Segment QoS Profile Binding Maps in current segment id. operationId: GlobalInfraListInfraSegmentQoSBindings parameters: - in: path name: segment-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentQoSProfileBindingMapListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Segment QoS Profile Binding Maps tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - QOS Profile Binding x-vmw-nsx-module: PolicyQoSProfileBinding /global-infra/segments/{segment-id}/segment-qos-profile-binding-maps/{segment-qos-profile-binding-map-id}: get: consumes: - application/json description: | API will get Segment QoS Profile Binding Map. operationId: GlobalInfraGetInfraSegmentQoSBinding parameters: - description: |- Segment ID in: path name: segment-id required: true type: string - description: |- Segment QoS Profile Binding Map ID in: path name: segment-qos-profile-binding-map-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentQoSProfileBindingMap' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Segment QoS Profile Binding Map tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - QOS Profile Binding x-vmw-nsx-module: PolicyQoSProfileBinding /global-infra/segments/{segment-id}/segment-security-profile-binding-maps: get: consumes: - application/json description: | API will list all segment security profile binding maps. operationId: GlobalInfraListInfraSegmentSecurityProfileBindings parameters: - description: |- segment id in: path name: segment-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentSecurityProfileBindingMapListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List infra segment security profile binding maps tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Segment Security Profile Binding x-vmw-nsx-module: PolicySecurityProfileBinding /global-infra/segments/{segment-id}/segment-security-profile-binding-maps/{segment-security-profile-binding-map-id}: get: consumes: - application/json description: | API will return details of the segment security profile binding map. If the binding map does not exist, it will return 404. operationId: GlobalInfraGetInfraSegmentSecurityProfileBinding parameters: - description: |- segment id in: path name: segment-id required: true type: string - description: |- segment security profile binding map id in: path name: segment-security-profile-binding-map-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentSecurityProfileBindingMap' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get infra segment security profile binding map tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Segment Security Profile Binding x-vmw-nsx-module: PolicySecurityProfileBinding /global-infra/segments/{segment-id}/tep-table: get: consumes: - application/json description: | Returns TEP table for a segment operationId: GlobalInfraGetInfraSegmentTepTable parameters: - in: path name: segment-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string - description: Data source type. enum: - realtime - cached in: query name: source required: false type: string - description: TransportNode Id in: query name: transport_node_id required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyTepListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get infra segment TEP table tags: - Policy - Networking - Connectivity - Segments - TEP Table x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/segments/{segment-id}/tep-table?format=csv: get: consumes: - application/json description: | Returns TEP table for a segment in CSV operationId: GlobalInfraGetInfraSegmentTepTableInCsv parameters: - in: path name: segment-id required: true type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - description: Data source type. enum: - realtime - cached in: query name: source required: false type: string - description: TransportNode Id in: query name: transport_node_id required: false type: string produces: - text/csv responses: '200': description: OK schema: $ref: '#/definitions/PolicyTepCsvListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get tier-1 segment TEP table in CSV tags: - Policy - Networking - Connectivity - Segments - TEP Table x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/segments/{segments-id}/ports/{port-id}/statistics: get: consumes: - application/json description: | Get infra segment port statistics information. operationId: GlobalInfraGetInfraSegmentPortStatistics parameters: - in: path name: segments-id required: true type: string - in: path name: port-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Policy path of edge node in: query name: edge_path type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentPortStatistics' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get infra segment port statistics information tags: - Policy - Networking - Connectivity - Segments - Statistics x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/segments/{segments-id}/ports/{port-id}/status: get: consumes: - application/json description: | Get infra segment port status information. operationId: GlobalInfraGetInfraSegmentPortStatus parameters: - in: path name: segments-id required: true type: string - in: path name: port-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Policy path of edge node in: query name: edge_path type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentPortStatus' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get infra segment port status information tags: - Policy - Networking - Connectivity - Segments - Status x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/segments/{segments-id}/state: get: consumes: - application/json description: | Get infra segment state information. operationId: GlobalInfraGetInfraSegmentState parameters: - in: path name: segments-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Policy path of edge node in: query name: edge_path type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentConfigurationState' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get infra segment state information tags: - Policy - Networking - Connectivity - Segments - State x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/segments/{segments-id}/statistics: get: consumes: - application/json description: | Get infra segment statistics information. operationId: GlobalInfraGetInfraSegmentStatistics parameters: - in: path name: segments-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Policy path of edge node in: query name: edge_path type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentStatistics' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get infra segment statistics information tags: - Policy - Networking - Connectivity - Segments - Statistics x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/services: get: consumes: - application/json description: | Paginated list of Services for infra. operationId: GlobalInfraListServicesForTenant parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Fetch all default services in: query name: default_service type: boolean - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ServiceListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Services for infra tags: - Policy - Inventory - Services x-vmw-nsx-module: Policy /global-infra/services/{service-id}: get: consumes: - application/json description: |- Read a service operationId: GlobalInfraReadServiceForTenant parameters: - description: |- Service ID in: path name: service-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/Service' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read a service tags: - Policy - Inventory - Services x-vmw-nsx-module: Policy /global-infra/services/{service-id}/service-entries: get: consumes: - application/json description: | Paginated list of Service entries for the given service operationId: GlobalInfraListServiceEntries parameters: - description: |- Service ID in: path name: service-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ServiceEntryListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Service entries for the given service tags: - Policy - Inventory - Services x-vmw-nsx-module: Policy /global-infra/services/{service-id}/service-entries/{service-entry-id}: get: consumes: - application/json description: |- Service entry operationId: GlobalInfraReadServiceEntry parameters: - description: |- Service ID in: path name: service-id required: true type: string - description: |- Service entry ID in: path name: service-entry-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ServiceEntry' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Service entry tags: - Policy - Inventory - Services x-vmw-nsx-module: Policy /global-infra/session-timer-profiles/{session-timer-profile-id}/bindings: get: consumes: - application/json description: |- API will list all Session Timer Profiles bindings. operationId: GlobalInfraListSessionTimerProfileBindings parameters: - in: path name: session-timer-profile-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SessionTimerProfileBindingListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Session Timer Profiles tags: - Policy - Security - Security Profiles - Session Timer Profiles x-vmw-nsx-module: PolicyProfile /global-infra/settings/firewall/cpu-mem-thresholds-profile-binding-maps: get: consumes: - application/json description: | API will list all Firewall CPU Memory Thresholds Profile Binding Maps. operationId: GlobalInfraListPolicyFirewallCPUMemThresholdsProfileBindingMaps parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyFirewallCPUMemThresholdsProfileBindingMapListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Firewall CPU Memory Thresholds Profile Binding Maps tags: - Policy - Security - Security Profiles - Cpu Memory Thresholds Profiles x-vmw-nsx-module: PolicyFirewallCPUMemThresholdsProfileBinding /global-infra/settings/firewall/cpu-mem-thresholds-profiles: get: consumes: - application/json description: |- List all CPU and memory thresholds profiles. operationId: GlobalInfraListCPUMemThresholdsProfiles parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyFirewallCpuMemThresholdsProfileListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List all CPU and memory thresholds profiles tags: - Policy - Security - Security Profiles - Cpu Memory Thresholds Profiles x-vmw-nsx-module: PolicyProfile /global-infra/settings/firewall/cpu-mem-thresholds-profiles/{profile-id}: delete: consumes: - application/json description: |- Delete CPU and memory thresholds profile. operationId: GlobalInfraDeleteCPUMemThresholdsProfile parameters: - in: path name: profile-id required: true type: string - default: false description: Locally override the global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete CPU and memory thresholds profile tags: - Policy - Security - Security Profiles - Cpu Memory Thresholds Profiles x-vmw-nsx-module: PolicyProfile get: consumes: - application/json description: |- Read the CPU and memory thresholds profile. operationId: GlobalInfraReadCPUMemThresholdsProfile parameters: - in: path name: profile-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyFirewallCpuMemThresholdsProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read the CPU and memory thresholds profile tags: - Policy - Security - Security Profiles - Cpu Memory Thresholds Profiles x-vmw-nsx-module: PolicyProfile patch: consumes: - application/json description: |- Create or update CPU and memory thresholds profile. operationId: GlobalInfraPatchCPUMemThresholdsProfile parameters: - in: path name: profile-id required: true type: string - in: body name: PolicyFirewallCpuMemThresholdsProfile required: true schema: $ref: '#/definitions/PolicyFirewallCpuMemThresholdsProfile' - default: false description: Locally override the global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or update CPU and memory thresholds profile tags: - Policy - Security - Security Profiles - Cpu Memory Thresholds Profiles x-vmw-nsx-module: PolicyProfile put: consumes: - application/json description: |- Create or update CPU and memory thresholds profile. operationId: GlobalInfraUpdateCPUMemThresholdsProfile parameters: - in: path name: profile-id required: true type: string - in: body name: PolicyFirewallCpuMemThresholdsProfile required: true schema: $ref: '#/definitions/PolicyFirewallCpuMemThresholdsProfile' - default: false description: Locally override the global object in: query name: override required: false type: boolean produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyFirewallCpuMemThresholdsProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or update CPU and memory thresholds profile tags: - Policy - Security - Security Profiles - Cpu Memory Thresholds Profiles x-vmw-nsx-module: PolicyProfile /global-infra/settings/firewall/stats?action=reset: post: consumes: - application/json description: | Sets firewall rule statistics counter to zero. This operation is supported for given category, for example: DFW i.e. for all layer3 firewall (transport nodes only) rules or EDGE i.e. for all layer3 edge firewall (edge nodes only) rules. - no enforcement point path specified: On global manager, it is mandatory to give an enforcement point path. On local manager, reset of stats will be executed for each enforcement point. - {enforcement_point_path}: Reset of stats will be executed only for the given enforcement point. operationId: GlobalInfraResetRuleStats parameters: - description: Aggregation statistic category enum: - DFW - EDGE in: query name: category required: true type: string - description: String Path of the Container Cluster entity in: query name: container_cluster_path required: false type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Reset firewall rule statistics tags: - Policy - Security - East West Security - Distributed Firewall - Statistics x-vmw-nsx-module: DfwSecurityPolicy /global-infra/sha/dynamic-plugins: get: consumes: - application/json description: | API will provide list of Sha dynamic plugins. operationId: GlobalInfraListShaDynamicPlugins parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ShaDynamicPluginListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- API will provide list of Sha dynamic plugin list. tags: - Policy - Monitoring - System Health Agent - Profile x-vmw-nsx-module: PolicySha /global-infra/sha/dynamic-plugins/{plugin-id}: get: consumes: - application/json description: | Read Sha dynamic plugin. operationId: GlobalInfraReadShaDynamicPlugin parameters: - description: |- Plugin filename in: path name: plugin-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ShaDynamicPlugin' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read Sha dynamic plugin tags: - Policy - Monitoring - System Health Agent - Profile x-vmw-nsx-module: PolicySha /global-infra/sha/plugin-profiles: get: consumes: - application/json description: | API will provide list of SHA profile. operationId: GlobalInfraListShaPluginProfiles parameters: - description: String Path of the Policy group path in: query name: applied_to_group_path required: false type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - description: String Path of the sha plugin in: query name: plugin_path required: false type: string - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ShaPluginProfileListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- API will provide list of SHA profile. tags: - Policy - Monitoring - System Health Agent - Profile x-vmw-nsx-module: PolicySha /global-infra/sha/plugin-profiles/{sha-profile-id}: get: consumes: - application/json description: | API will return Sha profile. operationId: GlobalInfraReadShaPluginProfile parameters: - description: |- Sha profile id in: path name: sha-profile-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ShaPluginProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- API will return Sha profile tags: - Policy - Monitoring - System Health Agent - Profile x-vmw-nsx-module: PolicySha /global-infra/sha/plugin-status/{node-id}: get: consumes: - application/json description: | Show all the installed system health plugins on given node operationId: GlobalInfraShowPluginStatusOnNode parameters: - description: | The TN node id. in: path name: node-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PerNodeShaPluginStatusListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Show the plugins status on given node. tags: - Policy - Monitoring - System Health Agent - Profile x-vmw-nsx-module: PolicySha /global-infra/sha/pre-defined-plugins: get: consumes: - application/json description: | API will provide list of Sha dynamic plugins. operationId: GlobalInfraListShaPredefinedPlugins parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ShaPreDefinedPluginListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- API will provide list of Sha pre-defined list. tags: - Policy - Monitoring - System Health Agent - Profile x-vmw-nsx-module: PolicySha /global-infra/sha/pre-defined-plugins/{plugin-id}: get: consumes: - application/json description: | Read SHA dynamic plugin. operationId: GlobalInfraReadShaPredefinedPlugin parameters: - description: |- Sha pre-defined plugin in: path name: plugin-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ShaPredefinedPlugin' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read Sha pre-defined plugin tags: - Policy - Monitoring - System Health Agent - Profile x-vmw-nsx-module: PolicySha /global-infra/sites: get: consumes: - application/json description: | List Sites under Infra. operationId: GlobalInfraListSites parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SiteListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Sites tags: - Federation - Sites x-vmw-nsx-module: PolicyEnforcementPointManagement /global-infra/sites/listener_certificate: get: consumes: - application/json description: | Connects to the given IP and port, and, if an SSL listener is present, returns the certificate of the listener. Intent of this API is "Do you trust this certificate?". operationId: GlobalInfraGetInfraSiteListenerCertificate parameters: - description: Host name or IP address of TLS listener format: hostname-or-ip in: query name: address required: true type: string - description: TCP port number of the TLS listener format: int32 in: query maximum: 65535 minimum: 0 name: port required: true type: integer produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/TlsListenerCertificate' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Returns the certificate of the listener tags: - Federation - Sites x-vmw-nsx-module: PolicySiteGM /global-infra/sites/{site-id}: get: consumes: - application/json description: | Read a site under Infra. operationId: GlobalInfraReadSite parameters: - in: path name: site-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/Site' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read a site tags: - Federation - Sites x-vmw-nsx-module: PolicyEnforcementPointManagement /global-infra/sites/{site-id}/enforcement-points: get: consumes: - application/json description: | Paginated list of all enforcementpoints under Site. operationId: GlobalInfraListEnforcementPointForSite parameters: - in: path name: site-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/EnforcementPointListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List enforcementpoints under Site tags: - Policy - Infra - Enforcement Points x-vmw-nsx-module: PolicyEnforcementPointManagement /global-infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}: get: consumes: - application/json description: | Read an Enforcement Point under Infra/Site operationId: GlobalInfraReadEnforcementPointForSite parameters: - in: path name: site-id required: true type: string - in: path name: enforcementpoint-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/EnforcementPoint' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read an Enforcement Point under Infra/Site tags: - Policy - Infra - Enforcement Points x-vmw-nsx-module: PolicyEnforcementPointManagement /global-infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-clusters: get: consumes: - application/json description: | Paginated list of all Edge Clusters under an Enforcement Point operationId: GlobalInfraListEdgeClustersForEnforcementPoint parameters: - in: path name: site-id required: true type: string - in: path name: enforcementpoint-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyEdgeClusterListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Edge Clusters under an Enforcement Point tags: - Policy - Infra - Enforcement Points x-vmw-nsx-module: PolicyEnforcementPointManagement /global-infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-clusters/{edge-cluster-id}: get: consumes: - application/json description: | Read a Edge Cluster under an Enforcement Point operationId: GlobalInfraReadEdgeClusterForEnforcementPoint parameters: - in: path name: site-id required: true type: string - in: path name: enforcementpoint-id required: true type: string - in: path name: edge-cluster-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyEdgeCluster' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read a Edge Cluster under an Enforcement Point tags: - Policy - Infra - Enforcement Points x-vmw-nsx-module: PolicyEnforcementPointManagement /global-infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-clusters/{edge-cluster-id}/edge-nodes: get: consumes: - application/json description: | Paginated list of all Edge Nodes under an Enforcement Point, Edge Cluster operationId: GlobalInfraListEdgeNodesUnderEdgeClusterForEnforcementPoint parameters: - in: path name: site-id required: true type: string - in: path name: enforcementpoint-id required: true type: string - in: path name: edge-cluster-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyEdgeNodeListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Edge Nodes under an Enforcement Point, Edge Cluster tags: - Policy - Infra - Enforcement Points x-vmw-nsx-module: PolicyEnforcementPointManagement ? /global-infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-clusters/{edge-cluster-id}/edge-nodes/{edge-node-id} : get: consumes: - application/json description: | Read a Edge Node under an Enforcement Point, Edge Cluster operationId: GlobalInfraReadEdgeNodeUnderEdgeClusterForEnforcementPoint parameters: - in: path name: site-id required: true type: string - in: path name: enforcementpoint-id required: true type: string - in: path name: edge-cluster-id required: true type: string - in: path name: edge-node-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyEdgeNode' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read a Edge Node under an Enforcement Point, Edge Cluster tags: - Policy - Infra - Enforcement Points x-vmw-nsx-module: PolicyEnforcementPointManagement /global-infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/transport-zones: get: consumes: - application/json description: | Paginated list of all Transport Zones under an Enforcement Point operationId: GlobalInfraListTransportZonesForEnforcementPoint parameters: - in: path name: site-id required: true type: string - in: path name: enforcementpoint-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyTransportZoneListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Transport Zones under an Enforcement Point tags: - Policy - Infra - Enforcement Points x-vmw-nsx-module: PolicyTransportZone /global-infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/transport-zones/{transport-zone-id}: get: consumes: - application/json description: | Read a Transport Zone under an Enforcement Point operationId: GlobalInfraReadTransportZoneForEnforcementPoint parameters: - in: path name: site-id required: true type: string - in: path name: enforcementpoint-id required: true type: string - in: path name: transport-zone-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyTransportZone' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read a Transport Zone under an Enforcement Point tags: - Policy - Infra - Enforcement Points x-vmw-nsx-module: PolicyTransportZone /global-infra/span: get: consumes: - application/json description: |- Get span for an entity with specified path. operationId: GlobalInfraGetSpan parameters: - description: String Path of the intent object in: query name: intent_path required: true type: string - description: Policy Path of the site in: query name: site_path required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/Span' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get span for an entity with specified path tags: - Federation - Sites x-vmw-nsx-module: PolicySitesSpan /global-infra/spoofguard-profiles: get: consumes: - application/json description: | API will list all SpoofGuard profiles. operationId: GlobalInfraListSpoofGuardProfiles parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SpoofGuardProfileListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List SpoofGuard profiles tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Spoofguard Profiles x-vmw-nsx-module: PolicySpoofGuard /global-infra/spoofguard-profiles/{spoofguard-profile-id}: delete: consumes: - application/json description: | API will delete SpoofGuard profile with the given id. operationId: GlobalInfraDeleteSpoofGuardProfile parameters: - description: |- SpoofGuard profile id in: path name: spoofguard-profile-id required: true type: string - default: false description: Locally override the global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete SpoofGuard profile tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Spoofguard Profiles x-vmw-nsx-module: PolicySpoofGuard get: consumes: - application/json description: | API will return details of the SpoofGuard profile with given id. If the profile does not exist, it will return 404. operationId: GlobalInfraGetSpoofGuardProfile parameters: - description: |- SpoofGuard profile id in: path name: spoofguard-profile-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SpoofGuardProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get SpoofGuard profile tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Spoofguard Profiles x-vmw-nsx-module: PolicySpoofGuard patch: consumes: - application/json description: | Create a new SpoofGuard profile if the SpoofGuard profile with the given id does not exist. Otherwise, patch with the existing SpoofGuard profile. operationId: GlobalInfraPatchSpoofGuardProfile parameters: - description: |- SpoofGuard profile id in: path name: spoofguard-profile-id required: true type: string - in: body name: SpoofGuardProfile required: true schema: $ref: '#/definitions/SpoofGuardProfile' - default: false description: Locally override the global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Patch SpoofGuard profile tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Spoofguard Profiles x-vmw-nsx-module: PolicySpoofGuard put: consumes: - application/json description: | API will create or replace SpoofGuard profile. operationId: GlobalInfraCreateOrUpdateSpoofGuardProfile parameters: - description: |- SpoofGuard profile id in: path name: spoofguard-profile-id required: true type: string - in: body name: SpoofGuardProfile required: true schema: $ref: '#/definitions/SpoofGuardProfile' - default: false description: Locally override the global object in: query name: override required: false type: boolean produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SpoofGuardProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or replace SpoofGuard profile tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Spoofguard Profiles x-vmw-nsx-module: PolicySpoofGuard /global-infra/tier-0s: get: consumes: - application/json description: | Paginated list of all Tier-0s operationId: GlobalInfraListTier0s parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/Tier0ListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Tier-0s tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Tier-0 Gateways x-vmw-nsx-module: PolicyConnectivity /global-infra/tier-0s/{tier-0-id}: get: consumes: - application/json description: |- Read Tier-0 operationId: GlobalInfraReadTier0 parameters: - in: path name: tier-0-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/Tier0' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read Tier-0 tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Tier-0 Gateways x-vmw-nsx-module: PolicyConnectivity /global-infra/tier-0s/{tier-0-id}/arp-proxies: get: consumes: - application/json description: | Returns ARP proxy table for a tier-0 operationId: GlobalInfraGetTier0GatewayArpProxies parameters: - in: path name: tier-0-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string - description: Data source type. enum: - realtime - cached in: query name: source required: false type: string - description: TransportNode Id in: query name: transport_node_id required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyArpProxyTableListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Tier-0 Address Resolution Protocol Proxies tags: - Policy - Networking - Connectivity - Tier-0 Gateways - ARP Proxies x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-0s/{tier-0-id}/arp-proxies?format=csv: get: consumes: - application/json description: | Returns ARP proxy table for a tier-0 in CSV format operationId: GlobalInfraGetTier0GatewayArpProxiesInCsv parameters: - in: path name: tier-0-id required: true type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - description: Data source type. enum: - realtime - cached in: query name: source required: false type: string - description: TransportNode Id in: query name: transport_node_id required: false type: string produces: - text/csv responses: '200': description: OK schema: $ref: '#/definitions/PolicyArpProxyTableCsvListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Tier-0 Address Resolution Protocol Proxies in CSV format tags: - Policy - Networking - Connectivity - Tier-0 Gateways - ARP Proxies x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-0s/{tier-0-id}/community-lists: get: consumes: - application/json description: | Paginated list of all community lists under a tier-0 operationId: GlobalInfraListCommunityList parameters: - in: path name: tier-0-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/CommunityListListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List BGP community lists tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Routing - Community Lists x-vmw-nsx-module: PolicyConnectivity /global-infra/tier-0s/{tier-0-id}/community-lists/{community-list-id}: get: consumes: - application/json description: |- Read a BGP community list operationId: GlobalInfraReadCommunityList parameters: - in: path name: tier-0-id required: true type: string - in: path name: community-list-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/CommunityList' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read a BGP community list tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Routing - Community Lists x-vmw-nsx-module: PolicyConnectivity /global-infra/tier-0s/{tier-0-id}/dns-forwarder: get: consumes: - application/json description: |- Read the DNS Forwarder for the given tier-0 instance operationId: GlobalInfraReadPolicyDnsForwarderOnTier0 parameters: - description: |- Tier-0 ID in: path name: tier-0-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyDnsForwarder' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read the DNS Forwarder for the given tier-0 instance tags: - Policy - Networking - IP Management - DNS - DNS Forwarder - Tier-0 Gateways x-vmw-nsx-module: PolicyDnsForwarder post: consumes: - application/json description: | Perform the specified action for Tier0 DNS forwarder on specified enforcement point. operationId: GlobalInfraPerformEPActionForDnsForwarderAtTier0 parameters: - in: path name: tier-0-id required: true type: string - description: An action to be performed for DNS forwarder on EP enum: - clear_cache in: query name: action required: true type: string - default: /infra/sites/default/enforcement-points/default description: An enforcement point path, on which the action is to be performed in: query name: enforcement_point_path required: false type: string responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Perform the specified DNS forwarder action tags: - Policy - Networking - IP Management - DNS - DNS Forwarder - Tier-0 Gateways x-vmw-nsx-module: PolicyDnsForwarder /global-infra/tier-0s/{tier-0-id}/dns-forwarder/nslookup: get: consumes: - application/json description: | Query the nameserver for an ip-address or a FQDN of the given an address optionally using an specified DNS server. If the address is a fqdn, nslookup will resolve ip-address with it. If the address is an ip-address, do a reverse lookup and answer fqdn(s). If enforcement point is specified, then DNS forwarder nslookup answer will get fetched from specified enforcement point. Otherwise from all enforcement points. operationId: GlobalInfraLookupAddressViaTier0DNSForwarder parameters: - in: path name: tier-0-id required: true type: string - description: IP address or FQDN for nslookup in: query name: address required: false type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/AggregatePolicyDnsAnswer' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Resolve a given address via the dns forwarder at Tier0 tags: - Policy - Networking - IP Management - DNS - DNS Forwarder - Tier-0 Gateways x-vmw-nsx-module: PolicyDnsForwarder /global-infra/tier-0s/{tier-0-id}/dns-forwarder/statistics: get: consumes: - application/json description: | Get statistics of tier-0 DNS forwarder. - no enforcement point path specified: Statistics will be evaluated on each enforcement point. - {enforcement_point_path}: Statistics are evaluated only on the given enforcement point. operationId: GlobalInfraGetTier0DNSForwarderStatistics parameters: - description: |- Tier-0 id in: path name: tier-0-id required: true type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/AggregateDNSForwarderStatistics' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get tier-0 DNS forwarder statistics tags: - Policy - Networking - IP Management - DNS - DNS Forwarder - Tier-0 Gateways x-vmw-nsx-module: PolicyDNSStatistics /global-infra/tier-0s/{tier-0-id}/dns-forwarder/status: get: consumes: - application/json description: | Get current status of tier-0 DNS forwarder. - no enforcement point path specified: Status will be evaluated on each enforcement point. - {enforcement_point_path}: Status will be evaluated only on the given enforcement point. operationId: GlobalInfraGetTier0DNSForwarderStatus parameters: - description: |- Tier-0 id in: path name: tier-0-id required: true type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/AggregateDNSForwarderStatus' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get current status of tier-0 DNS forwarder tags: - Policy - Networking - IP Management - DNS - DNS Forwarder - Tier-0 Gateways x-vmw-nsx-module: PolicyDNSStatistics /global-infra/tier-0s/{tier-0-id}/forwarding-table: get: consumes: - application/json description: | Get forwarding table from tier-0 operationId: GlobalInfraGetTier0ForwardingTable parameters: - in: path name: tier-0-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: UUID of edge node in: query name: edge_id type: string - description: Policy path of edge node in: query name: edge_path type: string - description: Enforcement point path in: query name: enforcement_point_path type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - description: IPAddress or CIDR Block format: address-or-cidr-block in: query name: network_prefix type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - description: Filter routes based on the source from which route is learned enum: - BGP - STATIC - CONNECTED - OSPF in: query name: route_source type: string - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/RoutingTableListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get forwarding table from tier-0 tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Routing - Forwarding Table x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-0s/{tier-0-id}/forwarding-table?format=csv: get: consumes: - application/json description: | Get forwarding table from tier-0 gateway in CSV format. operationId: GlobalInfraGetTier0ForwardingTableCsv parameters: - in: path name: tier-0-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: UUID of edge node in: query name: edge_id type: string - description: Policy path of edge node in: query name: edge_path type: string - description: Enforcement point path in: query name: enforcement_point_path type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - description: IPAddress or CIDR Block format: address-or-cidr-block in: query name: network_prefix type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - description: Filter routes based on the source from which route is learned enum: - BGP - STATIC - CONNECTED - OSPF in: query name: route_source type: string - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - text/csv responses: '200': description: OK schema: $ref: '#/definitions/GatewayRouteTableInCsvFormat' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get forwarding table from tier-0 in CSV format tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Routing - Forwarding Table x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-0s/{tier-0-id}/gateway-firewall: get: consumes: - application/json description: | Get filtered view of gateway rules associated with the Tier-0. The gateay policies are returned in the order of category and precedence. operationId: GlobalInfraViewTier0GatewayFirewall parameters: - in: path name: tier-0-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/GatewayPolicyListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: | Get list of gateway policies with rules that belong to the specific Tier-0 logical router. tags: - Policy - Security - North South Security - Gateway Firewall - Tier-0 Gateways x-vmw-nsx-module: PolicyEdgeFirewall /global-infra/tier-0s/{tier-0-id}/groups: get: consumes: - application/json description: | Paginated list of all Groups for Tier-0. operationId: GlobalInfraListTier0Group parameters: - in: path name: tier-0-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - description: Comma Seperated Member types in: query name: member_types required: false type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/GroupListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Groups for Tier-0 tags: - Policy - Inventory - Groups - Gateway Firewall Groups x-vmw-nsx-module: PolicyEdgeFirewall /global-infra/tier-0s/{tier-0-id}/groups/{group-id}: get: consumes: - application/json description: |- Read Tier-0 Group operationId: GlobalInfraReadTier0Group parameters: - in: path name: tier-0-id required: true type: string - in: path name: group-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/Group' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read Tier-0 Group tags: - Policy - Inventory - Groups - Gateway Firewall Groups x-vmw-nsx-module: PolicyEdgeFirewall /global-infra/tier-0s/{tier-0-id}/groups/{group-id}/members/ip-addresses: get: consumes: - application/json description: | 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 operationId: GlobalInfraGetProviderGroupIPMembers parameters: - description: |- Tier-0 id in: path name: tier-0-id required: true type: string - description: |- Group Id in: path name: group-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyGroupIPMembersListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get IP addresses that belong to this Tier-0 Group tags: - Policy - Inventory - Groups - Group Members x-vmw-nsx-module: PolicyGroupRealization /global-infra/tier-0s/{tier-0-id}/groups/{group-id}/members/virtual-machines: get: consumes: - application/json description: | 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. operationId: GlobalInfraGetProviderGroupVMMembers parameters: - description: |- Tier-0 id in: path name: tier-0-id required: true type: string - description: |- Group Id in: path name: group-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/RealizedVirtualMachineListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Virtual machines that belong to this Tier-0 Group tags: - Policy - Inventory - Groups - Group Members x-vmw-nsx-module: PolicyGroupRealization /global-infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/statistics: post: consumes: - application/json description: | Resets the statistics of the given VPN session. Since source of data is enforcement point, data is reset there. operationId: GlobalInfraResetTier0VpnIPSecVpnSessionStatistics parameters: - in: path name: tier-0-id required: true type: string - in: path name: service-id required: true type: string - in: path name: session-id required: true type: string - description: Action on statistics enum: - reset in: query name: action required: true type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Reset the statistics of the given VPN session tags: - Policy - Networking - Network Services - VPN - IPSEC - Statistics x-vmw-nsx-module: PolicyVPNStatistics /global-infra/tier-0s/{tier-0-id}/locale-services: get: consumes: - application/json description: | Paginated list of all Tier-0 locale-services operationId: GlobalInfraListTier0LocaleServices parameters: - in: path name: tier-0-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/LocaleServicesListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Tier-0 locale-services tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Tier-0 Locale Services x-vmw-nsx-module: PolicyConnectivity /global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/arp-proxies: get: consumes: - application/json description: | This API is deprecated. Please use /infra/tier-0s/<tier-0-id>/arp-proxies Returns ARP proxy table for a tier-0 operationId: GlobalInfraGetTier0ArpProxies parameters: - in: path name: tier-0-id required: true type: string - in: path name: locale-service-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string - description: Data source type. enum: - realtime - cached in: query name: source required: false type: string - description: TransportNode Id in: query name: transport_node_id required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyArpProxyTableListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Tier-0 Address Resolution Protocol Proxies tags: - Policy - Networking - Connectivity - Tier-0 Gateways - ARP Proxies x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp: delete: consumes: - application/json description: | Deletes the specified overridden BgpRoutingConfig. If the BgpRoutingConfig is not overridden, it won't get deleted. operationId: GlobalInfraDeleteOverriddenBgpRoutingConfig parameters: - in: path name: tier-0-id required: true type: string - in: path name: locale-service-id required: true type: string - default: false description: Locally override the global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete overridden BGP routing config tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Routing - BGP x-vmw-nsx-module: PolicyConnectivity get: consumes: - application/json description: |- Read BGP routing config operationId: GlobalInfraReadBgpRoutingConfig parameters: - in: path name: tier-0-id required: true type: string - in: path name: locale-service-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/BgpRoutingConfig' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read BGP routing config tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Routing - BGP x-vmw-nsx-module: PolicyConnectivity patch: consumes: - application/json description: | If an BGP routing config not present, create BGP routing config. If it already exists, update the routing config. operationId: GlobalInfraPatchBgpRoutingConfig parameters: - in: path name: tier-0-id required: true type: string - in: path name: locale-service-id required: true type: string - in: body name: BgpRoutingConfig required: true schema: $ref: '#/definitions/BgpRoutingConfig' - default: false description: Locally override the global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or update BGP routing config tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Routing - BGP x-vmw-nsx-module: PolicyConnectivity put: consumes: - application/json description: | If BGP routing config is not already present, create BGP routing config. If it already exists, replace the BGP routing config with this object. operationId: GlobalInfraCreateOrReplaceBgpRoutingConfig parameters: - in: path name: tier-0-id required: true type: string - in: path name: locale-service-id required: true type: string - in: body name: BgpRoutingConfig required: true schema: $ref: '#/definitions/BgpRoutingConfig' - default: false description: Locally override the global object in: query name: override required: false type: boolean produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/BgpRoutingConfig' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or update a BGP routing config tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Routing - BGP x-vmw-nsx-module: PolicyConnectivity /global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors: get: consumes: - application/json description: | Paginated list of all BGP neighbor configurations operationId: GlobalInfraListBgpNeighborConfigs parameters: - in: path name: tier-0-id required: true type: string - in: path name: locale-service-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/BgpNeighborConfigListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List BGP neighbor configurations tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Routing - BGP x-vmw-nsx-module: PolicyConnectivity /global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/status: get: consumes: - application/json description: | Returns the status of all the BGP neighbors for the given Tier0. To get BGP neighbor status for a particular enforcement point, parameter "enforcement_point_path=<enforcement_point_path>" needs to be specified. If an enforcement_point is unspecified, then bgp neighbor status for all enforcement points is fetched. To get BGP neighbors status for the logical router from particular edge node, parameter "edge_path=<edge_path>" needs to be specified. If an edge_path is unspecified, then bgp neighbor status for all edges is fetched. operationId: GlobalInfraGetTier0BgpNeighborsStatus parameters: - in: path name: tier-0-id required: true type: string - in: path name: locale-service-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Policy path of edge node in: query name: edge_path type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyBgpNeighborsStatusListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get BGP neighbor status for the Tier0 tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Routing - BGP x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}: delete: consumes: - application/json description: |- Delete BGP neighbor config operationId: GlobalInfraDeleteBgpNeighborConfig parameters: - in: path name: tier-0-id required: true type: string - in: path name: locale-service-id required: true type: string - in: path name: neighbor-id required: true type: string - default: false description: Locally override the global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete BGP neighbor config tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Routing - BGP x-vmw-nsx-module: PolicyConnectivity get: consumes: - application/json description: |- Read BGP neighbor config operationId: GlobalInfraReadBgpNeighborConfig parameters: - in: path name: tier-0-id required: true type: string - in: path name: locale-service-id required: true type: string - in: path name: neighbor-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/BgpNeighborConfig' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read BGP neighbor config tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Routing - BGP x-vmw-nsx-module: PolicyConnectivity patch: consumes: - application/json description: | If BGP neighbor config with the neighbor-id is not already present, create a new neighbor config. If it already exists, replace the BGP neighbor config with this object. operationId: GlobalInfraPatchBgpNeighborConfig parameters: - in: path name: tier-0-id required: true type: string - in: path name: locale-service-id required: true type: string - in: path name: neighbor-id required: true type: string - in: body name: BgpNeighborConfig required: true schema: $ref: '#/definitions/BgpNeighborConfig' - default: false description: Locally override the global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or update a BGP neighbor config tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Routing - BGP x-vmw-nsx-module: PolicyConnectivity put: consumes: - application/json description: | If BGP neighbor config with the neighbor-id is not already present, create a new neighbor config. If it already exists, replace the BGP neighbor config with this object. operationId: GlobalInfraCreateOrReplaceBgpNeighborConfig parameters: - in: path name: tier-0-id required: true type: string - in: path name: locale-service-id required: true type: string - in: path name: neighbor-id required: true type: string - in: body name: BgpNeighborConfig required: true schema: $ref: '#/definitions/BgpNeighborConfig' - default: false description: Locally override the global object in: query name: override required: false type: boolean produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/BgpNeighborConfig' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or update a BGP neighbor config tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Routing - BGP x-vmw-nsx-module: PolicyConnectivity /global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}/advertised-routes: get: consumes: - application/json description: | Returns routes advertised by BGP neighbor from all edge transport nodes on which this neighbor is currently enabled. The query parameter "source=cached" is not supported. operationId: GlobalInfraGetTier0BgpNeighborAdvertisedRoutes parameters: - in: path name: tier-0-id required: true type: string - in: path name: locale-service-id required: true type: string - in: path name: neighbor-id required: true type: string - default: 1000 description: Number of routes to retrieve format: int32 in: query minimum: 1 name: count type: integer - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Enforcement point path in: query name: enforcement_point_path type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/BgpNeighborRoutesListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get BGP neighbor advertised routes tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Routing - BGP x-vmw-nsx-module: PolicyConnectivityStatistics ? /global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}/advertised-routes?format=csv : get: consumes: - application/json description: | Returns routes advertised by BGP neighbor from all edge transport nodes on which this neighbor is currently enabled in CSV format. Routes from all enforcement points are returned. operationId: GlobalInfraGetTier0BgpNeighborAdvertisedRoutesInCsvFormat parameters: - in: path name: tier-0-id required: true type: string - in: path name: locale-service-id required: true type: string - in: path name: neighbor-id required: true type: string - default: 1000 description: Number of routes to retrieve format: int32 in: query minimum: 1 name: count type: integer - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Enforcement point path in: query name: enforcement_point_path type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - text/csv responses: '200': description: OK schema: $ref: '#/definitions/BgpNeighborRouteDetailsInCsvFormat' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get BGP neighbor advertised routes in CSV format tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Routing - BGP x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}/routes: get: consumes: - application/json description: | Returns routes learned by BGP neighbor from all edge nodes on which this neighbor is currently enabled. operationId: GlobalInfraGetTier0BgpNeighborRoutes parameters: - in: path name: tier-0-id required: true type: string - in: path name: locale-service-id required: true type: string - in: path name: neighbor-id required: true type: string - default: 1000 description: Number of routes to retrieve format: int32 in: query minimum: 1 name: count type: integer - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Enforcement point path in: query name: enforcement_point_path type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/BgpNeighborRoutesListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get routes learned by BGP neighbor tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Routing - BGP x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}/routes?format=csv: get: consumes: - application/json description: | Returns routes learned by BGP neighbor from all edge nodes on which this neighbor is currently enabled. Routes from all enforcement points are returned. operationId: GlobalInfraGetTier0BgpNeighborRoutesInCsvFormat parameters: - in: path name: tier-0-id required: true type: string - in: path name: locale-service-id required: true type: string - in: path name: neighbor-id required: true type: string - default: 1000 description: Number of routes to retrieve format: int32 in: query minimum: 1 name: count type: integer - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Enforcement point path in: query name: enforcement_point_path type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - text/csv responses: '200': description: OK schema: $ref: '#/definitions/BgpNeighborRouteDetailsInCsvFormat' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get routes learned by BGP neighbor in CSV format tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Routing - BGP x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces: get: consumes: - application/json description: | Paginated list of all Tier-0 Interfaces operationId: GlobalInfraListTier0Interfaces parameters: - in: path name: tier-0-id required: true type: string - in: path name: locale-service-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/Tier0InterfaceListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Tier-0 Interfaces tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Interfaces - Interfaces x-vmw-nsx-module: PolicyConnectivity /global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}: delete: consumes: - application/json description: |- Delete Tier-0 interface operationId: GlobalInfraDeleteTier0Interface parameters: - in: path name: tier-0-id required: true type: string - in: path name: locale-service-id required: true type: string - in: path name: interface-id required: true type: string - default: false description: Locally override the global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete Tier-0 interface tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Interfaces - Interfaces x-vmw-nsx-module: PolicyConnectivity get: consumes: - application/json description: |- Read Tier-0 interface operationId: GlobalInfraReadTier0Interface parameters: - in: path name: tier-0-id required: true type: string - in: path name: locale-service-id required: true type: string - in: path name: interface-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/Tier0Interface' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read Tier-0 interface tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Interfaces - Interfaces x-vmw-nsx-module: PolicyConnectivity patch: consumes: - application/json description: | If an interface with the interface-id is not already present, create a new interface. If it already exists, update the interface for specified attributes. operationId: GlobalInfraPatchTier0Interface parameters: - in: path name: tier-0-id required: true type: string - in: path name: locale-service-id required: true type: string - in: path name: interface-id required: true type: string - in: body name: Tier0Interface required: true schema: $ref: '#/definitions/Tier0Interface' - default: false description: Locally override the global object in: query name: override required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or update a Tier-0 interface tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Interfaces - Interfaces x-vmw-nsx-module: PolicyConnectivity put: consumes: - application/json description: | If an interface with the interface-id is not already present, create a new interface. If it already exists, replace the interface with this object. operationId: GlobalInfraCreateOrReplaceTier0Interface parameters: - in: path name: tier-0-id required: true type: string - in: path name: locale-service-id required: true type: string - in: path name: interface-id required: true type: string - in: body name: Tier0Interface required: true schema: $ref: '#/definitions/Tier0Interface' - default: false description: Locally override the global object in: query name: override required: false type: boolean produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/Tier0Interface' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or update a Tier-0 interface tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Interfaces - Interfaces x-vmw-nsx-module: PolicyConnectivity /global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-proxy: get: consumes: - application/json description: | Returns ARP proxy table for a tier-0 interface. Interfaces can be of types - EXTERNAL and SERVICE. Interfaces of type LOOBACK and downlink are not supported. operationId: GlobalInfraGetTier0InterfaceArpProxies parameters: - in: path name: tier-0-id required: true type: string - in: path name: locale-service-id required: true type: string - in: path name: interface-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string - description: Data source type. enum: - realtime - cached in: query name: source required: false type: string - description: TransportNode Id in: query name: transport_node_id required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyArpProxyTableListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Tier-0 Interface Address Resolution Protocol Proxies tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Interfaces - ARP Proxies x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-proxy?format=csv: get: consumes: - application/json description: | Returns ARP proxy table for a tier-0 interface in CSV format. Interfaces can be of types - EXTERNAL and SERVICE. Interfaces of type LOOBACK and downlink are not supported. operationId: GlobalInfraGetTier0InterfaceArpProxiesInCsv parameters: - in: path name: tier-0-id required: true type: string - in: path name: locale-service-id required: true type: string - in: path name: interface-id required: true type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - description: Data source type. enum: - realtime - cached in: query name: source required: false type: string - description: TransportNode Id in: query name: transport_node_id required: false type: string produces: - text/csv responses: '200': description: OK schema: $ref: '#/definitions/PolicyArpProxyTableCsvListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Tier-0 Interface Address Resolution Protocol Proxies in CSV format tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Interfaces - ARP Proxies x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-table: get: consumes: - application/json description: | Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) for the tier-0 interface, on a edge node if a query parameter "edge_path=<policy-edge-path>" is given. The edge_path parameter is mandatory if the interface type is not EXTERNAL. operationId: GlobalInfraGetTier0InterfaceArpTable parameters: - in: path name: tier-0-id required: true type: string - in: path name: locale-service-id required: true type: string - in: path name: interface-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Policy path of edge node in: query name: edge_path type: string - description: Enforcement point path in: query name: enforcement_point_path type: string - description: Policy path of host transport node in: query name: host_transport_node_path type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/InterfaceArpTable' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get ARP table from tier-0 interface tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Interfaces - ARP Table x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-table?format=csv: get: consumes: - application/json description: | Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) in CSV format for the tier-0 interface, on a edge node if a query parameter "edge_path=<policy-edge-path>" is given. The edge_path parameter is mandatory if the interface type is not EXTERNAL. operationId: GlobalInfraGetTier0InterfaceArpTableCsv parameters: - in: path name: tier-0-id required: true type: string - in: path name: locale-service-id required: true type: string - in: path name: interface-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Policy path of edge node in: query name: edge_path type: string - description: Enforcement point path in: query name: enforcement_point_path type: string - description: Policy path of host transport node in: query name: host_transport_node_path type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - text/csv responses: '200': description: OK schema: $ref: '#/definitions/InterfaceArpTableInCsvFormat' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get ARP table from tier-0 interface in CSV format tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Interfaces - ARP Table x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/dad-state: get: consumes: - application/json description: | Get tier-0 interface DAD state information. operationId: GlobalInfraGetTier0InterfaceDADState parameters: - in: path name: tier-0-id required: true type: string - in: path name: locale-service-id required: true type: string - in: path name: interface-id required: true type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/InterfaceDADState' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get DAD status by interface tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Interfaces - DAD State x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/statistics: get: consumes: - application/json description: | Get tier-0 interface statistics information. operationId: GlobalInfraGetTier0InterfaceStatistics parameters: - in: path name: tier-0-id required: true type: string - in: path name: locale-service-id required: true type: string - in: path name: interface-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Policy path of edge node in: query name: edge_path type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyInterfaceStatistics' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get tier-0 interface statistics information tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Interfaces - Statistics x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/statistics/summary: get: consumes: - application/json description: | Get tier-0 interface statistics summary information. operationId: GlobalInfraGetTier0InterfaceStatisticsSummary parameters: - in: path name: tier-0-id required: true type: string - in: path name: locale-service-id required: true type: string - in: path name: interface-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Enforcement point path in: query name: enforcement_point_path type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyInterfaceStatisticsSummary' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get tier-0 interface statistics summary information tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Interfaces - Statistics x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/service-interfaces: get: consumes: - application/json description: | Paginated list of all Service Interfaces operationId: GlobalInfraListServiceInterfaces parameters: - in: path name: tier-0-id required: true type: string - in: path name: locale-service-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ServiceInterfaceListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Service Interfaces tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Interfaces - Interfaces x-vmw-nsx-module: PolicyConnectivity /global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/service-interfaces/{interface-id}: get: consumes: - application/json description: |- Read service interface operationId: GlobalInfraReadServiceInterface parameters: - in: path name: tier-0-id required: true type: string - in: path name: locale-service-id required: true type: string - in: path name: interface-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ServiceInterface' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read service interface tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Interfaces - Interfaces x-vmw-nsx-module: PolicyConnectivity /global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/tier-0-deployment-maps: get: consumes: - application/json description: | Paginated list of all Tier-0 Deployment Entries. operationId: GlobalInfraListTier0DeploymentMaps parameters: - in: path name: tier-0-id required: true type: string - in: path name: locale-service-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/Tier0DeploymentMapListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Tier-0 Deployment maps tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Tier-0 Deployment Maps x-vmw-nsx-module: PolicyEnforcementPointManagement /global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/tier-0-deployment-maps/{tier-0-deployment-map-id}: get: consumes: - application/json description: | Read a Tier-0 Deployment Map operationId: GlobalInfraReadTier0DeploymentMap parameters: - in: path name: tier-0-id required: true type: string - in: path name: locale-service-id required: true type: string - in: path name: tier-0-deployment-map-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/Tier0DeploymentMap' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read a Tier-0 Deployment Map tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Tier-0 Deployment Maps x-vmw-nsx-module: PolicyEnforcementPointManagement /global-infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}: get: consumes: - application/json description: |- Read Tier-0 locale-services operationId: GlobalInfraReadTier0LocaleServices parameters: - in: path name: tier-0-id required: true type: string - in: path name: locale-services-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/LocaleServices' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read Tier-0 locale-services tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Tier-0 Locale Services x-vmw-nsx-module: PolicyConnectivity /global-infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}/gateway-firewall: get: consumes: - application/json description: | Get filtered view of Gateway Firewall rules associated with the Tier-0 Locale Services. The gateway policies are returned in the order of category and sequence number. operationId: GlobalInfraViewTier0LocaleServicesGatewayFirewall parameters: - in: path name: tier-0-id required: true type: string - in: path name: locale-services-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/GatewayPolicyListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: | Get list of gateway policies with rules that belong to the specific Tier-0 LocalServices. tags: - Policy - Security - North South Security - Gateway Firewall - Tier-0 Gateways x-vmw-nsx-module: PolicyEdgeFirewall /global-infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}/inter-site/bgp-summary: get: consumes: - application/json description: | Get RTEP span and mac address-table. operationId: GlobalInfraGetPolicyInterSiteBgpSummary parameters: - in: path name: tier-0-id required: true type: string - in: path name: locale-services-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Transport node in: query name: edge_path required: false type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyEdgeClusterInterSiteBgpSummary' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get RTEP span and mac address-table tags: - Federation - Inter-Sites x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}/inter-site/status: get: consumes: - application/json description: | Get RTEP mesh connectivity status. operationId: GlobalInfraGetPolicyInterSiteStatus parameters: - in: path name: tier-0-id required: true type: string - in: path name: locale-services-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Transport node in: query name: edge_path required: false type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyEdgeClusterInterSiteStatus' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get RTEP mesh connectivity status tags: - Federation - Inter-Sites x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-0s/{tier-0-id}/nat: get: consumes: - application/json description: | List all NAT sections under the given Tier-0 ID. For more details related to NAT section please refer to PolicyNAT schema. operationId: GlobalInfraListPolicyNatOnTier0 parameters: - description: |- Tier-0 ID in: path name: tier-0-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyNatListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Policy NAT types. tags: - Policy - Networking - Network Services - NAT - Rules - Tier-0 Gateways x-vmw-nsx-module: PolicyNAT /global-infra/tier-0s/{tier-0-id}/nat/statistics: get: consumes: - application/json description: |- List NAT Rules Statistics from Tier-0 denoted by Tier-0 ID. operationId: GlobalInfraListPolicyNatRulesStatisticsFromTier0 parameters: - description: |- Tier-0 ID in: path name: tier-0-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyNatRuleStatisticsPerLogicalRouterListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List NAT Rules Statistics tags: - Policy - Networking - Network Services - NAT - Statistics x-vmw-nsx-module: PolicyNAT /global-infra/tier-0s/{tier-0-id}/nat/{nat-id}/nat-rules: get: consumes: - application/json description: | List NAT Rules from Tier-0 denoted by Tier-0 ID, under NAT section denoted by <nat-id>. Under tier-0 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT) For more details related to NAT section please refer to PolicyNAT schema. Note: IPSecVpnSession as Scope: Please note that old IPSecVpnSession policy path deprecated. If user specifiy old IPSecVpnSession path in the scope property in the PATCH/PUT API, the path returned in the GET response payload will be a new path instead of the deprecated IPSecVpnSession path Both old and new IPSecVpnSession path refer to same resource. there is no functional impact. operationId: GlobalInfraListPolicyNatRulesFromTier0 parameters: - description: |- Tier-0 ID in: path name: tier-0-id required: true type: string - description: |- NAT id in: path name: nat-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyNatRuleListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List NAT Rules tags: - Policy - Networking - Network Services - NAT - Rules - Tier-0 Gateways x-vmw-nsx-module: PolicyNAT /global-infra/tier-0s/{tier-0-id}/nat/{nat-id}/nat-rules/{nat-rule-id}: get: consumes: - application/json description: | Get NAT Rule from Tier-0 denoted by Tier-0 ID, under NAT section denoted by <nat-id>. Under tier-0 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT) For more details related to NAT section please refer to PolicyNAT schema. Note: IPSecVpnSession as Scope: Please note that old IPSecVpnSession policy path deprecated. If user specifiy old IPSecVpnSession path in the scope property in the PUT/PATCH API, the path returned in the GET response payload will be a new path instead of the deprecated IPSecVpnSession path Both old and new IPSecVpnSession path refer to same resource. there is no functional impact. operationId: GlobalInfraGetPolicyNatRuleFromTier0 parameters: - description: |- Tier-0 ID in: path name: tier-0-id required: true type: string - description: |- NAT id in: path name: nat-id required: true type: string - description: |- Rule ID in: path name: nat-rule-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyNatRule' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get NAT Rule tags: - Policy - Networking - Network Services - NAT - Rules - Tier-0 Gateways x-vmw-nsx-module: PolicyNAT /global-infra/tier-0s/{tier-0-id}/nat/{nat-id}/nat-rules/{nat-rule-id}/statistics: get: consumes: - application/json description: | Get NAT Rule Statistics from Tier-0 denoted by Tier-0 ID, under NAT section denoted by <nat-id>. Under tier-0 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT) For more details related to NAT section please refer to PolicyNAT schema. operationId: GlobalInfraGetPolicyNatRuleStatisticsFromTier0 parameters: - description: |- Tier-0 ID in: path name: tier-0-id required: true type: string - description: |- NAT id in: path name: nat-id required: true type: string - description: |- Rule ID in: path name: nat-rule-id required: true type: string - description: Action on statistics enum: - aggregate in: query name: action required: false type: string - description: String Path of the Container Cluster entity in: query name: container_cluster_path required: false type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyNatRuleStatisticsListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get NAT Rule Statistics tags: - Policy - Networking - Network Services - NAT - Statistics x-vmw-nsx-module: PolicyNAT /global-infra/tier-0s/{tier-0-id}/prefix-lists: get: consumes: - application/json description: | Paginated list of all prefix lists operationId: GlobalInfraListPrefixLists parameters: - in: path name: tier-0-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PrefixListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List prefix lists tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Routing - Prefix List x-vmw-nsx-module: PolicyConnectivity /global-infra/tier-0s/{tier-0-id}/prefix-lists/{prefix-list-id}: get: consumes: - application/json description: |- Read a prefix list operationId: GlobalInfraReadPrefixList parameters: - in: path name: tier-0-id required: true type: string - in: path name: prefix-list-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PrefixList' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read a prefix list tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Routing - Prefix List x-vmw-nsx-module: PolicyConnectivity /global-infra/tier-0s/{tier-0-id}/route-maps: get: consumes: - application/json description: | Paginated list of all route maps under a tier-0 operationId: GlobalInfraListAllRouteMaps parameters: - in: path name: tier-0-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/Tier0RouteMapListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List route maps tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Routing - Route Maps x-vmw-nsx-module: PolicyConnectivity /global-infra/tier-0s/{tier-0-id}/route-maps/{route-map-id}: get: consumes: - application/json description: |- Read a route map operationId: GlobalInfraGetRouteMap parameters: - in: path name: tier-0-id required: true type: string - in: path name: route-map-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/Tier0RouteMap' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read a route map tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Routing - Route Maps x-vmw-nsx-module: PolicyConnectivity /global-infra/tier-0s/{tier-0-id}/routing-table: get: consumes: - application/json description: | Get routing table from tier-0 operationId: GlobalInfraGetTier0Routes parameters: - in: path name: tier-0-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: UUID of edge node in: query name: edge_id type: string - description: Policy path of edge node in: query name: edge_path type: string - description: Enforcement point path in: query name: enforcement_point_path type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - description: IPAddress or CIDR Block format: address-or-cidr-block in: query name: network_prefix type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - description: Filter routes based on the source from which route is learned enum: - BGP - STATIC - CONNECTED - OSPF in: query name: route_source type: string - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/RoutingTableListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get routing table from tier-0 tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Routing - Routing Table x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-0s/{tier-0-id}/routing-table?format=csv: get: consumes: - application/json description: | Get routing table from tier-0 gateway in CSV format. operationId: GlobalInfraGetTier0RoutesCsv parameters: - in: path name: tier-0-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: UUID of edge node in: query name: edge_id type: string - description: Policy path of edge node in: query name: edge_path type: string - description: Enforcement point path in: query name: enforcement_point_path type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - description: IPAddress or CIDR Block format: address-or-cidr-block in: query name: network_prefix type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - description: Filter routes based on the source from which route is learned enum: - BGP - STATIC - CONNECTED - OSPF in: query name: route_source type: string - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - text/csv responses: '200': description: OK schema: $ref: '#/definitions/GatewayRouteTableInCsvFormat' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get routing table from tier-0 in CSV format tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Routing - Routing Table x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-0s/{tier-0-id}/state: get: consumes: - application/json description: | Returns operationId: GlobalInfraGetTier0State parameters: - in: path name: tier-0-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Enforcement point path in: query name: enforcement_point_path type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - description: Interface path for interface specific state such as IPv6 DAD state in: query name: interface_path type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string - description: Returns specific information based on the value specified. enum: - GATEWAY_STATE - GATEWAY_STATUS - IPV6_STATUS in: query name: type type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/Tier0GatewayState' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Tier0 state tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Routing - State x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-0s/{tier-0-id}/static-routes: get: consumes: - application/json description: | Paginated list of all Tier-0 Static Routes operationId: GlobalInfraListTier0StaticRoutes parameters: - in: path name: tier-0-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/StaticRoutesListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Tier-0 Static Routes tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Routing - Static Routes x-vmw-nsx-module: PolicyConnectivity /global-infra/tier-0s/{tier-0-id}/static-routes/bfd-peers: get: consumes: - application/json description: | Paginated list of all StaticRouteBfdPeers. operationId: GlobalInfraListStaticRouteBfdPeer parameters: - in: path name: tier-0-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/StaticRouteBfdPeerListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List StaticRouteBfdPeers tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Routing - Static Routes BFD Peers x-vmw-nsx-module: PolicyConnectivity /global-infra/tier-0s/{tier-0-id}/static-routes/bfd-peers/{bfd-peer-id}: get: consumes: - application/json description: | Read a StaticRouteBfdPeer with the bfd-peer-id. operationId: GlobalInfraReadStaticRouteBfdPeer parameters: - description: |- Tier-0 ID in: path name: tier-0-id required: true type: string - description: |- BFD peer ID in: path name: bfd-peer-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/StaticRouteBfdPeer' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read a StaticRouteBfdPeer tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Routing - Static Routes BFD Peers x-vmw-nsx-module: PolicyConnectivity /global-infra/tier-0s/{tier-0-id}/static-routes/{route-id}: get: consumes: - application/json description: |- Read Tier-0 static routes operationId: GlobalInfraReadTier0StaticRoutes parameters: - in: path name: tier-0-id required: true type: string - in: path name: route-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/StaticRoutes' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read Tier-0 static routes tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Routing - Static Routes x-vmw-nsx-module: PolicyConnectivity put: consumes: - application/json description: | If static routes for route-id are not already present, create static routes. If it already exists, replace the static routes for route-id. operationId: GlobalInfraCreateOrReplaceTier0StaticRoutes parameters: - in: path name: tier-0-id required: true type: string - in: path name: route-id required: true type: string - in: body name: StaticRoutes required: true schema: $ref: '#/definitions/StaticRoutes' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/StaticRoutes' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or update a Tier-0 static routes tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Routing - Static Routes x-vmw-nsx-module: PolicyConnectivity /global-infra/tier-0s/{tier-0-id}/tier-1-interface/arp-table: get: consumes: - application/json description: | Get tier-0 interface arp information. operationId: GlobalInfraGetTier0RouterLinkArpTable parameters: - in: path name: tier-0-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Policy path of edge node in: query name: edge_path type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string - description: Policy path of tier1 in: query name: tier1_path required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/InterfaceArpTable' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get tier-0 router link arp information tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Interfaces - ARP Table x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-0s/{tier-0-id}/tier-1-interface/arp-table?format=csv: get: consumes: - application/json description: | Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) in CSV format for the tier-0 router link interface, on a edge node. The edge_path parameter is mandatory if the interface type is not EXTERNAL. operationId: GlobalInfraGetTier0RouterLinkArpTableCsv parameters: - in: path name: tier-0-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Policy path of edge node in: query name: edge_path type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string - description: Policy path of tier1 in: query name: tier1_path required: true type: string produces: - text/csv responses: '200': description: OK schema: $ref: '#/definitions/InterfaceArpTableInCsvFormat' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get ARP table from tier-0 router link interface in CSV format tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Interfaces - ARP Table x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-0s/{tier-0-id}/tier-1-interface/statistics: get: consumes: - application/json description: | Get tier-0 interface statistics information. operationId: GlobalInfraGetTier0RouterLinkStatistics parameters: - in: path name: tier-0-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Policy path of edge node in: query name: edge_path type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string - description: Policy path of tier1 in: query name: tier1_path required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyInterfaceStatistics' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get tier-0 router link statistics information tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Interfaces - Statistics x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-0s/{tier-0-id}/tier-1-interface/statistics/summary: get: consumes: - application/json description: | Get tier-0 interface statistics summary information. operationId: GlobalInfraGetTier0RouterLinkSummaryStatistics parameters: - in: path name: tier-0-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Policy path of edge node in: query name: edge_path type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string - description: Policy path of tier1 in: query name: tier1_path required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyInterfaceStatisticsSummary' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get tier-0 router link statistics summary information tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Interfaces - Statistics x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-0s/{tier0-id}/flood-protection-profile-bindings/{flood-protection-profile-binding-id}: get: consumes: - application/json description: | API will get Flood Protection Profile Binding Map for Tier-0 Logical Router. operationId: GlobalInfraGetTier0FloodProtectionProfileBinding parameters: - in: path name: tier0-id required: true type: string - in: path name: flood-protection-profile-binding-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/FloodProtectionProfileBindingMap' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Flood Protection Profile Binding Map for Tier-0 Logical Router tags: - Policy - Security - Security Profiles - Flood Protection Profile Binding x-vmw-nsx-module: PolicyGatewayProfileBinding ? /global-infra/tier-0s/{tier0-id}/locale-services/{locale-services-id}/flood-protection-profile-bindings/{flood-protection-profile-binding-id} : get: consumes: - application/json description: | API will get Flood Protection Profile Binding Map for Tier-0 Logical Router LocaleServices. operationId: GlobalInfraGetTier0LocaleServicesFloodProtectionProfileBinding parameters: - in: path name: tier0-id required: true type: string - in: path name: locale-services-id required: true type: string - in: path name: flood-protection-profile-binding-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/FloodProtectionProfileBindingMap' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Flood Protection Profile Binding Map for Tier-0 Logical Router LocaleServices tags: - Policy - Security - Security Profiles - Flood Protection Profile Binding x-vmw-nsx-module: PolicyGatewayProfileBinding ? /global-infra/tier-0s/{tier0-id}/locale-services/{locale-services-id}/session-timer-profile-bindings/{session-timer-profile-binding-id} : get: consumes: - application/json description: | API will get Session Timer Profile Binding Map for Tier-0 Logical Router LocaleServices. operationId: GlobalInfraGetTier0LocaleServicesSessionTimerProfileBinding parameters: - in: path name: tier0-id required: true type: string - in: path name: locale-services-id required: true type: string - in: path name: session-timer-profile-binding-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SessionTimerProfileBindingMap' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Session Timer Profile Binding Map for Tier-0 Logical Router LocaleServices tags: - Policy - Security - Security Profiles - Session Timer Profile Binding x-vmw-nsx-module: PolicyGatewayProfileBinding /global-infra/tier-0s/{tier0-id}/session-timer-profile-bindings/{session-timer-profile-binding-id}: get: consumes: - application/json description: | API will get Session Timer Profile Binding Map for Tier-0 Logical Router. operationId: GlobalInfraGetTier0SessionTimerProfileBinding parameters: - in: path name: tier0-id required: true type: string - in: path name: session-timer-profile-binding-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SessionTimerProfileBindingMap' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Session Timer Profile Binding Map for Tier-0 Logical Router tags: - Policy - Security - Security Profiles - Session Timer Profile Binding x-vmw-nsx-module: PolicyGatewayProfileBinding /global-infra/tier-1s: get: consumes: - application/json description: | Paginated list of all Tier-1 instances operationId: GlobalInfraListTier1 parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/Tier1ListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Tier-1 instances tags: - Policy - Networking - Connectivity - Tier-1 Gateways - Tier-1 Gateways x-vmw-nsx-module: PolicyConnectivity /global-infra/tier-1s/{tier-1-id}: get: consumes: - application/json description: |- Read Tier-1 configuration operationId: GlobalInfraReadTier1 parameters: - in: path name: tier-1-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/Tier1' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read Tier-1 configuration tags: - Policy - Networking - Connectivity - Tier-1 Gateways - Tier-1 Gateways x-vmw-nsx-module: PolicyConnectivity /global-infra/tier-1s/{tier-1-id}/arp-proxies: get: consumes: - application/json description: | Returns ARP proxy table for a tier-1 operationId: GlobalInfraGetTier1GatewayArpProxies parameters: - in: path name: tier-1-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string - description: Data source type. enum: - realtime - cached in: query name: source required: false type: string - description: TransportNode Id in: query name: transport_node_id required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyArpProxyTableListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Tier-1 Address Resolution Protocol Proxies tags: - Policy - Networking - Connectivity - Tier-1 Gateways - ARP Proxies x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-1s/{tier-1-id}/arp-proxies?format=csv: get: consumes: - application/json description: | Returns ARP proxy table for a tier-1 in CSV format operationId: GlobalInfraGetTier1GatewayArpProxiesInCsv parameters: - in: path name: tier-1-id required: true type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - description: Data source type. enum: - realtime - cached in: query name: source required: false type: string - description: TransportNode Id in: query name: transport_node_id required: false type: string produces: - text/csv responses: '200': description: OK schema: $ref: '#/definitions/PolicyArpProxyTableCsvListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Tier-1 Address Resolution Protocol Proxies in CSV format tags: - Policy - Networking - Connectivity - Tier-1 Gateways - ARP Proxies x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-1s/{tier-1-id}/dns-forwarder: get: consumes: - application/json description: |- Read the DNS Forwarder for the given tier-1 instance operationId: GlobalInfraReadPolicyDnsForwarderOnTier1 parameters: - description: |- Tier-1 ID in: path name: tier-1-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyDnsForwarder' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read the DNS Forwarder for the given tier-1 instance tags: - Policy - Networking - IP Management - DNS - DNS Forwarder - Tier-1 Gateways x-vmw-nsx-module: PolicyDnsForwarder post: consumes: - application/json description: | Perform the specified action for Tier0 DNS forwarder on specified enforcement point. operationId: GlobalInfraPerformEPActionForDnsForwarderAtTier1 parameters: - in: path name: tier-1-id required: true type: string - description: An action to be performed for DNS forwarder on EP enum: - clear_cache in: query name: action required: true type: string - default: /infra/sites/default/enforcement-points/default description: An enforcement point path, on which the action is to be performed in: query name: enforcement_point_path required: false type: string responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Perform the specified DNS forwarder action tags: - Policy - Networking - IP Management - DNS - DNS Forwarder - Tier-1 Gateways x-vmw-nsx-module: PolicyDnsForwarder /global-infra/tier-1s/{tier-1-id}/dns-forwarder/nslookup: get: consumes: - application/json description: | Query the nameserver for an ip-address or a FQDN of the given an address optionally using an specified DNS server. If the address is a fqdn, nslookup will resolve ip-address with it. If the address is an ip-address, do a reverse lookup and answer fqdn(s). If enforcement point is specified, then DNS forwarder nslookup answer will get fetched from specified enforcement point. Otherwise from all enforcement points. operationId: GlobalInfraLookupAddressViaTier1DNSForwarder parameters: - in: path name: tier-1-id required: true type: string - description: IP address or FQDN for nslookup in: query name: address required: false type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/AggregatePolicyDnsAnswer' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Resolve a given address via the dns forwarder at Tier1 tags: - Policy - Networking - IP Management - DNS - DNS Forwarder - Tier-1 Gateways x-vmw-nsx-module: PolicyDnsForwarder /global-infra/tier-1s/{tier-1-id}/dns-forwarder/statistics: get: consumes: - application/json description: | Get statistics of tier-1 DNS forwarder. - no enforcement point path specified: Statistics will be evaluated on each enforcement point. - {enforcement_point_path}: Statistics are evaluated only on the given enforcement point. operationId: GlobalInfraGetTier1DNSForwarderStatistics parameters: - description: |- Tier-1 id in: path name: tier-1-id required: true type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/AggregateDNSForwarderStatistics' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get tier-1 DNS forwarder statistics tags: - Policy - Networking - IP Management - DNS - DNS Forwarder - Tier-1 Gateways x-vmw-nsx-module: PolicyDNSStatistics /global-infra/tier-1s/{tier-1-id}/dns-forwarder/status: get: consumes: - application/json description: | Get current status of tier-1 DNS forwarder. - no enforcement point path specified: Status will be evaluated on each enforcement point. - {enforcement_point_path}: Status will be evaluated only on the given enforcement point. operationId: GlobalInfraGetTier1DNSForwarderStatus parameters: - description: |- Tier-1 id in: path name: tier-1-id required: true type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/AggregateDNSForwarderStatus' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get current status of tier-1 DNS forwarder tags: - Policy - Networking - IP Management - DNS - DNS Forwarder - Tier-1 Gateways x-vmw-nsx-module: PolicyDNSStatistics /global-infra/tier-1s/{tier-1-id}/forwarding-table: get: consumes: - application/json description: | Get forwarding table from tier-1 operationId: GlobalInfraGetTier1ForwardingTable parameters: - in: path name: tier-1-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: UUID of edge node in: query name: edge_id type: string - description: Policy path of edge node in: query name: edge_path type: string - description: Enforcement point path in: query name: enforcement_point_path type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - description: IPAddress or CIDR Block format: address-or-cidr-block in: query name: network_prefix type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - description: Filter routes based on the source from which route is learned enum: - BGP - STATIC - CONNECTED - OSPF in: query name: route_source type: string - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/RoutingTableListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get forwarding table from tier-1 tags: - Policy - Networking - Connectivity - Tier-1 Gateways - Routing - Forwarding Table x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-1s/{tier-1-id}/forwarding-table?format=csv: get: consumes: - application/json description: | Get forwarding table from tier-1 gateway in CSV format. operationId: GlobalInfraGetTier1ForwardingTableCsv parameters: - in: path name: tier-1-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: UUID of edge node in: query name: edge_id type: string - description: Policy path of edge node in: query name: edge_path type: string - description: Enforcement point path in: query name: enforcement_point_path type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - description: IPAddress or CIDR Block format: address-or-cidr-block in: query name: network_prefix type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - description: Filter routes based on the source from which route is learned enum: - BGP - STATIC - CONNECTED - OSPF in: query name: route_source type: string - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - text/csv responses: '200': description: OK schema: $ref: '#/definitions/GatewayRouteTableInCsvFormat' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get forwarding table from tier-1 in CSV format tags: - Policy - Networking - Connectivity - Tier-1 Gateways - Routing - Forwarding Table x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-1s/{tier-1-id}/gateway-firewall: get: consumes: - application/json description: | Get filtered view of Gateway Firewall rules associated with the Tier-1. The gateway policies are returned in the order of category and sequence number. operationId: GlobalInfraViewTier1GatewayFirewall parameters: - in: path name: tier-1-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/GatewayPolicyListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: | Get list of gateway policies with rules that belong to the specific Tier-1. tags: - Policy - Security - North South Security - Gateway Firewall - Tier-1 Gateways x-vmw-nsx-module: PolicyEdgeFirewall /global-infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/statistics: post: consumes: - application/json description: | Resets the statistics of the given VPN session. Since source of data is enforcement point, data is reset there. operationId: GlobalInfraResetTier1VpnIPSecVpnSessionStatistics parameters: - in: path name: tier-1-id required: true type: string - in: path name: service-id required: true type: string - in: path name: session-id required: true type: string - description: Action on statistics enum: - reset in: query name: action required: true type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Reset the statistics of the given VPN session tags: - Policy - Networking - Network Services - VPN - IPSEC - Statistics x-vmw-nsx-module: PolicyVPNStatistics /global-infra/tier-1s/{tier-1-id}/locale-services: get: consumes: - application/json description: | Paginated list of all Tier-1 locale-services operationId: GlobalInfraListTier1LocaleServices parameters: - in: path name: tier-1-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/LocaleServicesListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Tier-1 locale-services tags: - Policy - Networking - Connectivity - Tier-1 Gateways - Tier-1 Locale Services x-vmw-nsx-module: PolicyConnectivity /global-infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/arp-proxies: get: consumes: - application/json description: | This API is deprecated. Please use /infra/tier-1s/<tier-1-id>/arp-proxies Returns ARP proxy table for a tier-1 operationId: GlobalInfraGetTier1ArpProxies parameters: - in: path name: tier-1-id required: true type: string - in: path name: locale-service-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string - description: Data source type. enum: - realtime - cached in: query name: source required: false type: string - description: TransportNode Id in: query name: transport_node_id required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyArpProxyTableListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Tier-1 Address Resolution Protocol Proxies tags: - Policy - Networking - Connectivity - Tier-1 Gateways - ARP Proxies x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-proxy: get: consumes: - application/json description: | Returns ARP proxy table for a tier-1 interface operationId: GlobalInfraGetTier1InterfaceArpProxies parameters: - in: path name: tier-1-id required: true type: string - in: path name: locale-service-id required: true type: string - in: path name: interface-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string - description: Data source type. enum: - realtime - cached in: query name: source required: false type: string - description: TransportNode Id in: query name: transport_node_id required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyArpProxyTableListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Tier-1 Interface Address Resolution Protocol Proxies tags: - Policy - Networking - Connectivity - Tier-1 Gateways - Interfaces - ARP Proxies x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-proxy?format=csv: get: consumes: - application/json description: | Returns ARP proxy table for a tier-1 interface in CSV format operationId: GlobalInfraGetTier1InterfaceArpProxiesInCsv parameters: - in: path name: tier-1-id required: true type: string - in: path name: locale-service-id required: true type: string - in: path name: interface-id required: true type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - description: Data source type. enum: - realtime - cached in: query name: source required: false type: string - description: TransportNode Id in: query name: transport_node_id required: false type: string produces: - text/csv responses: '200': description: OK schema: $ref: '#/definitions/PolicyArpProxyTableCsvListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Tier-1 Interface Address Resolution Protocol Proxies in CSV format tags: - Policy - Networking - Connectivity - Tier-1 Gateways - Interfaces - ARP Proxies x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-table: get: consumes: - application/json description: | Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) for the tier-1 interface, on a edge node specified in edge_path parameter. The edge_path parameter is mandatory. operationId: GlobalInfraGetTier1InterfaceArpTable parameters: - in: path name: tier-1-id required: true type: string - in: path name: locale-service-id required: true type: string - in: path name: interface-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Policy path of edge node in: query name: edge_path type: string - description: Enforcement point path in: query name: enforcement_point_path type: string - description: Policy path of host transport node in: query name: host_transport_node_path type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/InterfaceArpTable' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get ARP table from tier-1 interface tags: - Policy - Networking - Connectivity - Tier-1 Gateways - Interfaces - ARP Table x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-table?format=csv: get: consumes: - application/json description: | Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) in CSV format for the tier-1 interface, on a edge node specified in edge_path parameter. The edge_path parameter is mandatory. operationId: GlobalInfraGetTier1InterfaceArpTableCsv parameters: - in: path name: tier-1-id required: true type: string - in: path name: locale-service-id required: true type: string - in: path name: interface-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Policy path of edge node in: query name: edge_path type: string - description: Enforcement point path in: query name: enforcement_point_path type: string - description: Policy path of host transport node in: query name: host_transport_node_path type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - text/csv responses: '200': description: OK schema: $ref: '#/definitions/InterfaceArpTableInCsvFormat' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get ARP table from tier-1 interface in CSV format tags: - Policy - Networking - Connectivity - Tier-1 Gateways - Interfaces - ARP Table x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/dad-state: get: consumes: - application/json description: | Get tier-1 interface DAD state information. operationId: GlobalInfraGetTier1InterfaceDADState parameters: - in: path name: tier-1-id required: true type: string - in: path name: locale-service-id required: true type: string - in: path name: interface-id required: true type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/InterfaceDADState' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get DAD status by interface tags: - Policy - Networking - Connectivity - Tier-0 Gateways - Interfaces - DAD State x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/statistics: get: consumes: - application/json description: | Get tier-1 interface statistics information. operationId: GlobalInfraGetTier1InterfaceStatistics parameters: - in: path name: tier-1-id required: true type: string - in: path name: locale-service-id required: true type: string - in: path name: interface-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Policy path of edge node in: query name: edge_path type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyInterfaceStatistics' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get tier-1 interface statistics information tags: - Policy - Networking - Connectivity - Tier-1 Gateways - Interfaces - Statistics x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/statistics/summary: get: consumes: - application/json description: | Get tier-1 interface statistics information. operationId: GlobalInfraGetTier1InterfaceStatisticsSummary parameters: - in: path name: tier-1-id required: true type: string - in: path name: locale-service-id required: true type: string - in: path name: interface-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Enforcement point path in: query name: enforcement_point_path type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyInterfaceStatisticsSummary' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get tier-1 interface statistics summary information tags: - Policy - Networking - Connectivity - Tier-1 Gateways - Interfaces - Statistics x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/service-interfaces: get: consumes: - application/json description: | Paginated list of all Tier 1 Service Interfaces operationId: GlobalInfraListTier1ServiceInterfaces parameters: - in: path name: tier-1-id required: true type: string - in: path name: locale-service-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ServiceInterfaceListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Tier 1 Service Interfaces tags: - Policy - Networking - Connectivity - Tier-1 Gateways - Interfaces - Interfaces x-vmw-nsx-module: PolicyConnectivity /global-infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/service-interfaces/{interface-id}: get: consumes: - application/json description: |- Read Tier 1 service interface operationId: GlobalInfraReadTier1ServiceInterface parameters: - in: path name: tier-1-id required: true type: string - in: path name: locale-service-id required: true type: string - in: path name: interface-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ServiceInterface' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read Tier 1 service interface tags: - Policy - Networking - Connectivity - Tier-1 Gateways - Interfaces - Interfaces x-vmw-nsx-module: PolicyConnectivity /global-infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}: get: consumes: - application/json description: |- Read Tier-1 locale-services operationId: GlobalInfraReadTier1LocaleServices parameters: - in: path name: tier-1-id required: true type: string - in: path name: locale-services-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/LocaleServices' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read Tier-1 locale-services tags: - Policy - Networking - Connectivity - Tier-1 Gateways - Tier-1 Locale Services x-vmw-nsx-module: PolicyConnectivity /global-infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}/gateway-firewall: get: consumes: - application/json description: | Get filtered view of Gateway Firewall rules associated with the Tier-1 Locale Services. The gateway policies are returned in the order of category and sequence number. operationId: GlobalInfraViewTier1LocaleServicesGatewayFirewall parameters: - in: path name: tier-1-id required: true type: string - in: path name: locale-services-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/GatewayPolicyListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: | Get list of gateway policies with rules that belong to the specific Tier-1 LocalServices. tags: - Policy - Security - North South Security - Gateway Firewall - Tier-1 Gateways x-vmw-nsx-module: PolicyEdgeFirewall /global-infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}/interfaces: get: consumes: - application/json description: | Paginated list of all Tier-1 interfaces operationId: GlobalInfraListTier1Interfaces parameters: - in: path name: tier-1-id required: true type: string - in: path name: locale-services-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/Tier1InterfaceListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Tier-1 interfaces tags: - Policy - Networking - Connectivity - Tier-1 Gateways - Interfaces - Interfaces x-vmw-nsx-module: PolicyConnectivity /global-infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}/interfaces/{interface-id}: get: consumes: - application/json description: |- Read Tier-1 interface operationId: GlobalInfraReadTier1Interface parameters: - in: path name: tier-1-id required: true type: string - in: path name: locale-services-id required: true type: string - in: path name: interface-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/Tier1Interface' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read Tier-1 interface tags: - Policy - Networking - Connectivity - Tier-1 Gateways - Interfaces - Interfaces x-vmw-nsx-module: PolicyConnectivity /global-infra/tier-1s/{tier-1-id}/nat: get: consumes: - application/json description: | List all NAT sections under the given Tier-1 ID. For more details related to NAT section please refer to PolicyNAT schema. operationId: GlobalInfraListPolicyNatOnTier1 parameters: - description: |- Tier-1 ID in: path name: tier-1-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyNatListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Policy NAT types. tags: - Policy - Networking - Network Services - NAT - Rules - Tier-1 Gateways x-vmw-nsx-module: PolicyNAT /global-infra/tier-1s/{tier-1-id}/nat/statistics: get: consumes: - application/json description: |- List NAT Rules Statistics from Tier-1 denoted by Tier-1 ID. operationId: GlobalInfraListPolicyNatRulesStatisticsFromTier1 parameters: - description: |- Tier-1 ID in: path name: tier-1-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyNatRuleStatisticsPerLogicalRouterListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List NAT Rules Statistics tags: - Policy - Networking - Network Services - NAT - Statistics x-vmw-nsx-module: PolicyNAT /global-infra/tier-1s/{tier-1-id}/nat/{nat-id}/nat-rules: get: consumes: - application/json description: | List NAT Rules from Tier-1 denoted by Tier-1 ID, under NAT section denoted by <nat-id>. Under tier-1 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT) For more details related to NAT section please refer to PolicyNAT schema. Note: IPSecVpnSession as Scope: Please note that old IPSecVpnSession policy path deprecated. If user specifiy old IPSecVpnSession path in the scope property in the PATCH/PUT PoliycNatRule API, the path returned in the GET response payload will be a new path instead of the deprecated IPSecVpnSession path Both old and new IPSecVpnSession path refer to same resource. there is no functional impact. operationId: GlobalInfraListPolicyNatRules parameters: - description: |- Tier-1 ID in: path name: tier-1-id required: true type: string - description: |- NAT id in: path name: nat-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyNatRuleListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List NAT Rules tags: - Policy - Networking - Network Services - NAT - Rules - Tier-1 Gateways x-vmw-nsx-module: PolicyNAT /global-infra/tier-1s/{tier-1-id}/nat/{nat-id}/nat-rules/{nat-rule-id}: get: consumes: - application/json description: | Get NAT Rule from Tier-1 denoted by Tier-1 ID, under NAT section denoted by <nat-id>. Under tier-1 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT) For more details related to NAT section please refer to PolicyNAT schema. Note: IPSecVpnSession as Scope: Please note that old IPSecVpnSession policy path deprecated. If user specifiy old IPSecVpnSession path in the scope property in the PATCH/PUT PoliycNatRule API, the path returned in the GET response payload will be a new path instead of the deprecated IPSecVpnSession path Both old and new IPSecVpnSession path refer to same resource. there is no functional impact. operationId: GlobalInfraGetPolicyNatRule parameters: - description: |- Tier-1 ID in: path name: tier-1-id required: true type: string - description: |- NAT id in: path name: nat-id required: true type: string - description: |- Rule ID in: path name: nat-rule-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyNatRule' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get NAT Rule tags: - Policy - Networking - Network Services - NAT - Rules - Tier-1 Gateways x-vmw-nsx-module: PolicyNAT /global-infra/tier-1s/{tier-1-id}/nat/{nat-id}/nat-rules/{nat-rule-id}/statistics: get: consumes: - application/json description: | Get NAT Rule Statistics from Tier-1 denoted by Tier-1 ID, under NAT section denoted by <nat-id>. Under tier-1 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT) For more details related to NAT section please refer to PolicyNAT schema. operationId: GlobalInfraGetPolicyNatRuleStatisticsFromTier1 parameters: - description: |- Tier-1 ID in: path name: tier-1-id required: true type: string - description: |- NAT id in: path name: nat-id required: true type: string - description: |- Rule ID in: path name: nat-rule-id required: true type: string - description: Action on statistics enum: - aggregate in: query name: action required: false type: string - description: String Path of the Container Cluster entity in: query name: container_cluster_path required: false type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyNatRuleStatisticsListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get NAT Rule Statistics tags: - Policy - Networking - Network Services - NAT - Statistics x-vmw-nsx-module: PolicyNAT /global-infra/tier-1s/{tier-1-id}/segments: get: consumes: - application/json description: "Paginated list of all fixed segments (identified as /policy/api/v1/infra/tier-1s//segments/)\ \ under Tier-1 instance.\nThis API call does not return flexible segments\ \ (identified as /policy/api/v1/infra/segments/) connected to\ \ the Tier-1.\nTo return all segments connected as a downlink to a Tier-1\ \ one possibility is to use the search API with: https://{{nsx-mgr}}/policy/api/v1/search?query=resource_type:Segment%20AND%20connectivity_path:\u201C\ /infra/tier-1s/\nExtended Segment: Please note that old vpn path deprecated.\ \ If user specify old l2vpn path in the\n\"l2_extension\" object in the PUT/PATCH\ \ API payload, the path returned in the GET response payload may include the\ \ new path\ninstead of the deprecated l2vpn path. Both old and new l2vpn path\ \ refer to same resource. there is no functional impact.\nAlso note that l2vpn\ \ path included in the error messages returned from validation may include\ \ the new VPN path\ninstead of the deprecated l2vpn path. Both new path and\ \ old vpn path refer to same resource.\n" operationId: GlobalInfraListSegments parameters: - in: path name: tier-1-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - description: Segment type enum: - DVPortgroup - ALL in: query name: segment_type type: string - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Paginated list of all fixed segments (identified as /policy/api/v1/infra/tier-1s//segments/) under Tier-1 instance. tags: - Policy - Networking - Connectivity - Segments - Segments (Fixed) x-vmw-nsx-module: PolicyConnectivity /global-infra/tier-1s/{tier-1-id}/segments/state: get: consumes: - application/json description: | Returns all tier-1 segments with configuration state on the enforcement point specified in the request operationId: GlobalInfraGetTier1SegmentsByState parameters: - in: path name: tier-1-id required: true type: string - description: Configuration state of the segment on enforcement point enum: - pending - in_progress - success - failed - partial_success - orphaned - unknown in: query name: configuration_state required: false type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string - description: Data source type. enum: - realtime - cached in: query name: source required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentConfigurationStateListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get tier-1 segments by configuration state tags: - Policy - Networking - Connectivity - Segments - State x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}: get: consumes: - application/json description: | Read segment Note: Extended Segment: Please note that old vpn path deprecated. If user specify old l2vpn path in the "l2_extension" object in the PUT/PATCH API payload, the path returned in the GET response payload may include the new path instead of the deprecated l2vpn path. Both old and new l2vpn path refer to same resource. there is no functional impact. Also note that l2vpn path included in the error messages returned from validation may include the new VPN path instead of the deprecated l2vpn path. Both new path and old vpn path refer to same resource. operationId: GlobalInfraReadSegment parameters: - in: path name: tier-1-id required: true type: string - in: path name: segment-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/Segment' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read segment tags: - Policy - Networking - Connectivity - Segments - Segments (Fixed) x-vmw-nsx-module: PolicyConnectivity /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/arp-proxy: get: consumes: - application/json description: | Returns ARP proxy table for downlink port on connected to the segment operationId: GlobalInfraGetDownlinkPortArpProxiesForTier1Segment parameters: - in: path name: tier-1-id required: true type: string - in: path name: segment-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string - description: Data source type. enum: - realtime - cached in: query name: source required: false type: string - description: TransportNode Id in: query name: transport_node_id required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyArpProxyTableListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get downlink port Address Resolution Protocol Proxies for tier-1 segment tags: - Policy - Networking - Connectivity - Segments x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/arp-proxy?format=csv: get: consumes: - application/json description: | Returns ARP proxy table for downlink port on connected to the segment in CSV operationId: GlobalInfraGetDownlinkPortArpProxiesForTier1SegmentInCsv parameters: - in: path name: tier-1-id required: true type: string - in: path name: segment-id required: true type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - description: Data source type. enum: - realtime - cached in: query name: source required: false type: string - description: TransportNode Id in: query name: transport_node_id required: false type: string produces: - text/csv responses: '200': description: OK schema: $ref: '#/definitions/PolicyArpProxyTableCsvListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get downlink port Address Resolution Protocol Proxies for tier-1 segment in CSV tags: - Policy - Networking - Connectivity - Segments x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/arp-table: get: consumes: - application/json description: | Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) for the interface (downlink) attaching segment to tier-1 gateway, on a edge node specified in edge_path parameter. The edge_path parameter is mandatory. operationId: GlobalInfraGetSegmentInterfaceArpTable parameters: - in: path name: tier-1-id required: true type: string - in: path name: segment-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Policy path of edge node in: query name: edge_path type: string - description: Enforcement point path in: query name: enforcement_point_path type: string - description: Policy path of host transport node in: query name: host_transport_node_path type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/InterfaceArpTable' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get ARP table from segment interface (downlink) tags: - Policy - Networking - Connectivity - Tier-1 Gateways - Interfaces - ARP Table x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/arp-table?format=csv: get: consumes: - application/json description: | Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) in CSV format for the interface (downlink) attaching segment to tier1 gateway, on a edge node specified in edge_path parameter. The edge_path parameter is mandatory. operationId: GlobalInfraGetSegmentInterfaceArpTableCsv parameters: - in: path name: tier-1-id required: true type: string - in: path name: segment-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Policy path of edge node in: query name: edge_path type: string - description: Enforcement point path in: query name: enforcement_point_path type: string - description: Policy path of host transport node in: query name: host_transport_node_path type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - text/csv responses: '200': description: OK schema: $ref: '#/definitions/InterfaceArpTableInCsvFormat' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get ARP table from segment interface (downlink) in CSV format tags: - Policy - Networking - Connectivity - Tier-1 Gateways - Interfaces - ARP Table x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/bep-statistics: get: consumes: - application/json description: | Get detailed information on Tier-1 segment bridge end point statistics using segment ID and profile path. operationId: GlobalInfraTier1SegmentBridgeEndpointStatistics parameters: - in: path name: tier-1-id required: true type: string - in: path name: segment-id required: true type: string - description: Bridge profile path in: query name: bridge_profile_path required: true type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/BridgeEndpointStatistics' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Tier-1 segment bridge end point statistics using segment ID and profile path. tags: - Policy - Networking - Connectivity - Segments - Bridge Endpoints - Statistics x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/bep-status: get: consumes: - application/json description: | Get detailed information on Tier-1 segment bridge end point status using segment ID and profile path. operationId: GlobalInfraTier1SegmentBridgeEndpointStatus parameters: - in: path name: tier-1-id required: true type: string - in: path name: segment-id required: true type: string - description: Bridge profile path in: query name: bridge_profile_path required: true type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/BridgeEndpointStatus' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Tier-1 segment bridge end point status using segment ID and profile path. tags: - Policy - Networking - Connectivity - Segments - Bridge Endpoints - Statistics x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/dhcp-static-binding-configs: get: consumes: - application/json description: | Paginated list of all DHCP static binding instances operationId: GlobalInfraListSegmentDhcpStaticBinding parameters: - in: path name: tier-1-id required: true type: string - in: path name: segment-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/DhcpStaticBindingConfigListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List all DHCP static bindings tags: - Policy - Networking - IP Management - DHCP - DHCP Static Bindings - Segments Bindings (Fixed) x-vmw-nsx-module: PolicyConnectivity /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/dhcp-static-binding-configs/{binding-id}: get: consumes: - application/json description: |- Read DHCP static binding operationId: GlobalInfraReadSegmentDhcpStaticBinding parameters: - in: path name: tier-1-id required: true type: string - in: path name: segment-id required: true type: string - in: path name: binding-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/DhcpStaticBindingConfig' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read DHCP static binding tags: - Policy - Networking - IP Management - DHCP - DHCP Static Bindings - Segments Bindings (Fixed) x-vmw-nsx-module: PolicyConnectivity /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/dhcp-static-bindings/{binding-id}/state: get: consumes: - application/json description: |- Read DHCP static binding state operationId: GlobalInfraReadSegmentDhcpStaticBindingState parameters: - in: path name: tier-1-id required: true type: string - in: path name: segment-id required: true type: string - in: path name: binding-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/DhcpStaticBindingState' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read DHCP static binding state tags: - Policy - Networking - IP Management - DHCP - DHCP Static Bindings x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/gateway-interface-arp-table: get: consumes: - application/json description: | This API is deprecated because it is duplicate. Please use /infra/tier-1s/<tier-1-id>/segments/<segment-id>/arp-table Segment ID is the ID of the segment that is connected to the the tier-1 operationId: GlobalInfraGetDownlinkPortArpTableForTier1Segment parameters: - in: path name: tier-1-id required: true type: string - in: path name: segment-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Policy path of edge node in: query name: edge_path type: string - description: Enforcement point path in: query name: enforcement_point_path type: string - description: Policy path of host transport node in: query name: host_transport_node_path type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/InterfaceArpTable' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get ARP table for downlink router port on tier-1 router tags: - Policy - Networking - Connectivity - Tier-1 Gateways - Interfaces - ARP Table x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/gateway-interface-arp-table?format=csv: get: consumes: - application/json description: | This API is deprecated because it is duplicate. Please use /infra/tier-1s/<tier-1-id>/segments/<segment-id>/arp-table?format=csv Segment ID is the ID of the segment that is connected to the the tier-1 operationId: GlobalInfraGetDownlinkPortArpTableForTier1SegmentInCsv parameters: - in: path name: tier-1-id required: true type: string - in: path name: segment-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Policy path of edge node in: query name: edge_path type: string - description: Enforcement point path in: query name: enforcement_point_path type: string - description: Policy path of host transport node in: query name: host_transport_node_path type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - text/csv responses: '200': description: OK schema: $ref: '#/definitions/InterfaceArpTableInCsvFormat' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get ARP table for downlink router port on tier-1 router in CSV tags: - Policy - Networking - Connectivity - Tier-1 Gateways - Interfaces - ARP Table x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/gateway-interface-dad-state: get: consumes: - application/json description: | Segment ID is the ID of the segment that is connected to the the tier-1 operationId: GlobalInfraGetDownlinkPortDadStateForTier1Segment parameters: - in: path name: tier-1-id required: true type: string - in: path name: segment-id required: true type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string - description: Data source type. enum: - realtime - cached in: query name: source required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/InterfaceDADState' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get DAD state for downlink router port on tier-1 router tags: - Policy - Networking - Connectivity - Tier-1 Gateways - Interfaces - DAD State x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/gateway-interface-statistics: get: consumes: - application/json description: | Segment ID is the ID of the segment that is connected to the the tier-1 operationId: GlobalInfraGetDownlinkPortStatisticsForTier1Segment parameters: - in: path name: tier-1-id required: true type: string - in: path name: segment-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Policy path of edge node in: query name: edge_path type: string - description: Enforcement point path in: query name: enforcement_point_path type: string - description: Policy path of host transport node in: query name: host_transport_node_path type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyInterfaceStatistics' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get statistics for downlink router port on tier-1 router tags: - Policy - Networking - Connectivity - Tier-1 Gateways - Interfaces - Statistics x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/gateway-interface-statistics/summary: get: consumes: - application/json description: | Segment ID is the ID of the segment that is connected to the the tier-1 operationId: GlobalInfraGetDownlinkPortStatisticsSummaryForTier1Segment parameters: - in: path name: tier-1-id required: true type: string - in: path name: segment-id required: true type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string - description: Data source type. enum: - realtime - cached in: query name: source required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyInterfaceStatisticsSummary' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get statistics for downlink router port on tier-1 router tags: - Policy - Networking - Connectivity - Tier-1 Gateways - Interfaces - Statistics x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/inter-site-forwarder/site-span-info: get: consumes: - application/json description: | Get segment cross site forwarder placement and HA statuss. operationId: GlobalInfraGetSegmentCsSpanInfo parameters: - in: path name: tier-1-id required: true type: string - in: path name: segment-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Policy path of edge node in: query name: edge_path type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentL2ForwarderSiteSpanInfo' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get segment cross site forwarder placement and HA status tags: - Federation - Inter-Sites x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/inter-site-forwarder/status: get: consumes: - application/json description: | Get segment cross site traffic statistics. operationId: GlobalInfraGetSegmentCsTrafficStats parameters: - in: path name: tier-1-id required: true type: string - in: path name: segment-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Policy path of edge node in: query name: edge_path type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentCrossSiteTrafficStats' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get segment cross site traffic statistics tags: - Federation - Inter-Sites x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/mac-table: get: consumes: - application/json description: | Returns MAC table for a segment operationId: GlobalInfraGetTier1SegmentMacTable parameters: - in: path name: tier-1-id required: true type: string - in: path name: segment-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string - description: Data source type. enum: - realtime - cached in: query name: source required: false type: string - description: TransportNode Id in: query name: transport_node_id required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentMacAddressListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Tier-1 segment MAC table tags: - Policy - Networking - Connectivity - Segments - MAC Table x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/mac-table?format=csv: get: consumes: - application/json description: | Returns MAC table for a segment operationId: GlobalInfraGetTier1SegmentMacTableInCsv parameters: - in: path name: tier-1-id required: true type: string - in: path name: segment-id required: true type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - description: Data source type. enum: - realtime - cached in: query name: source required: false type: string - description: TransportNode Id in: query name: transport_node_id required: false type: string produces: - text/csv responses: '200': description: OK schema: $ref: '#/definitions/MacAddressCsvListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Tier-1 segment MAC table in CSV tags: - Policy - Networking - Connectivity - Segments - MAC Table x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports: get: consumes: - application/json description: | List all the ports for a Tier-1 segment. operationId: GlobalInfraListTier1SegmentPorts parameters: - in: path name: tier-1-id required: true type: string - in: path name: segment-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentPortListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Tier-1 segment ports tags: - Policy - Networking - Connectivity - Segments - Ports x-vmw-nsx-module: PolicyConnectivity /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}: delete: consumes: - application/json description: | Delete a Tier-1 segment port by giving ID. operationId: GlobalInfraDeleteTier1SegmentPort parameters: - in: path name: tier-1-id required: true type: string - in: path name: segment-id required: true type: string - in: path name: port-id required: true type: string responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete a Tier-1 segment port tags: - Policy - Networking - Connectivity - Segments - Ports x-vmw-nsx-module: PolicyConnectivity get: consumes: - application/json description: | Get detail information on a Tier-1 segment port by giving ID. operationId: GlobalInfraGetTier1SegmentPort parameters: - in: path name: tier-1-id required: true type: string - in: path name: segment-id required: true type: string - in: path name: port-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentPort' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Tier-1 segment port by ID tags: - Policy - Networking - Connectivity - Segments - Ports x-vmw-nsx-module: PolicyConnectivity patch: consumes: - application/json description: | Create a Tier-1 segment port if it does not exist based on the IDs, or update existing port information by replacing the port object fields which presents in the request body. operationId: GlobalInfraPatchTier1SegmentPort parameters: - in: path name: tier-1-id required: true type: string - in: path name: segment-id required: true type: string - in: path name: port-id required: true type: string - in: body name: SegmentPort required: true schema: $ref: '#/definitions/SegmentPort' responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Patch a Tier-1 segment port tags: - Policy - Networking - Connectivity - Segments - Ports x-vmw-nsx-module: PolicyConnectivity put: consumes: - application/json description: | Create a Tier-1 segment port if it does not exist based on the IDs, or update existing port information by replacing the port object already exists. operationId: GlobalInfraCreateOrReplaceTier1SegmentPort parameters: - in: path name: tier-1-id required: true type: string - in: path name: segment-id required: true type: string - in: path name: port-id required: true type: string - in: body name: SegmentPort required: true schema: $ref: '#/definitions/SegmentPort' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentPort' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or update a Tier-1 segment port tags: - Policy - Networking - Connectivity - Segments - Ports x-vmw-nsx-module: PolicyConnectivity /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/mac-table: get: consumes: - application/json description: | Returns MAC table for a segment port operationId: GlobalInfraGetTier1SegmentPortMacTable parameters: - in: path name: tier-1-id required: true type: string - in: path name: segment-id required: true type: string - in: path name: port-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string - description: Data source type. enum: - realtime - cached in: query name: source required: false type: string - description: TransportNode Id in: query name: transport_node_id required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentPortMacAddressListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get MAC table for tier-1 segment port tags: - Policy - Networking - Connectivity - Segments - Ports - MAC Table x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/mac-table?format=csv: get: consumes: - application/json description: | Returns MAC table for a segment port operationId: GlobalInfraGetTier1SegmentPortMacTableInCsv parameters: - in: path name: tier-1-id required: true type: string - in: path name: segment-id required: true type: string - in: path name: port-id required: true type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - description: Data source type. enum: - realtime - cached in: query name: source required: false type: string - description: TransportNode Id in: query name: transport_node_id required: false type: string produces: - text/csv responses: '200': description: OK schema: $ref: '#/definitions/SegmentPortMacAddressCsvListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get tier-1 segment port MAC table in CSV tags: - Policy - Networking - Connectivity - Segments - Ports - MAC Table x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-discovery-profile-binding-maps: get: consumes: - application/json description: | API will list all Port Discovery Profile Binding Maps in current port id. operationId: GlobalInfraListPortDiscoveryBindings parameters: - in: path name: tier-1-id required: true type: string - in: path name: segment-id required: true type: string - in: path name: port-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PortDiscoveryProfileBindingMapListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Port Discovery Profile Binding Maps tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Discovery Profile Binding x-vmw-nsx-module: PolicyDiscoveryProfileBinding ? /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id} : delete: consumes: - application/json description: |- API will delete Port Discovery Profile Binding Profile operationId: GlobalInfraDeletePortDiscoveryBinding parameters: - description: |- Tier-1 ID in: path name: tier-1-id required: true type: string - description: |- Segment ID in: path name: segment-id required: true type: string - description: |- Port ID in: path name: port-id required: true type: string - description: |- Port Discovery Profile Binding Map ID in: path name: port-discovery-profile-binding-map-id required: true type: string responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete Port Discovery Profile Binding Profile tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Discovery Profile Binding x-vmw-nsx-module: PolicyDiscoveryProfileBinding get: consumes: - application/json description: | API will get Port Discovery Profile Binding Map operationId: GlobalInfraGetPortDiscoveryBinding parameters: - description: |- Tier-1 ID in: path name: tier-1-id required: true type: string - description: |- Segment ID in: path name: segment-id required: true type: string - description: |- Port ID in: path name: port-id required: true type: string - description: |- Port Discovery Profile Binding Map ID in: path name: port-discovery-profile-binding-map-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PortDiscoveryProfileBindingMap' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Port Discovery Profile Binding Map tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Discovery Profile Binding x-vmw-nsx-module: PolicyDiscoveryProfileBinding patch: consumes: - application/json description: |- API will create Port Discovery Profile Binding Map. For objects with no binding maps, default profile is applied. operationId: GlobalInfraPatchPortDiscoveryBinding parameters: - description: |- Tier-1 ID in: path name: tier-1-id required: true type: string - description: |- Segment ID in: path name: segment-id required: true type: string - description: |- Port ID in: path name: port-id required: true type: string - description: |- Port Discovery Profile Binding Map ID in: path name: port-discovery-profile-binding-map-id required: true type: string - in: body name: PortDiscoveryProfileBindingMap required: true schema: $ref: '#/definitions/PortDiscoveryProfileBindingMap' responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create Port Discovery Profile Binding Map tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Discovery Profile Binding x-vmw-nsx-module: PolicyDiscoveryProfileBinding put: consumes: - application/json description: |- API will update Port Discovery Profile Binding Map. For objects with no binding maps, default profile is applied. operationId: GlobalInfraUpdatePortDiscoveryBinding parameters: - description: |- Tier-1 ID in: path name: tier-1-id required: true type: string - description: |- Segment ID in: path name: segment-id required: true type: string - description: |- Port ID in: path name: port-id required: true type: string - description: |- Port Discovery Profile Binding Map ID in: path name: port-discovery-profile-binding-map-id required: true type: string - in: body name: PortDiscoveryProfileBindingMap required: true schema: $ref: '#/definitions/PortDiscoveryProfileBindingMap' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PortDiscoveryProfileBindingMap' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Update Port Discovery Profile Binding Map tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Discovery Profile Binding x-vmw-nsx-module: PolicyDiscoveryProfileBinding /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-monitoring-profile-binding-maps: get: consumes: - application/json description: | API will list all Port Monitoring Profile Binding Maps in current port id. operationId: GlobalInfraListPortMonitoringBindings parameters: - in: path name: tier-1-id required: true type: string - in: path name: segment-id required: true type: string - in: path name: port-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PortMonitoringProfileBindingMapListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Port Monitoring Profile Binding Maps tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Monitoring Profile Binding x-vmw-nsx-module: PolicyMonitoringProfileBinding ? /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-monitoring-profile-binding-maps/{port-monitoring-profile-binding-map-id} : delete: consumes: - application/json description: |- API will delete Port Monitoring Profile Binding Profile. operationId: GlobalInfraDeletePortMonitoringBinding parameters: - description: |- Tier-1 ID in: path name: tier-1-id required: true type: string - description: |- Segment ID in: path name: segment-id required: true type: string - description: |- Port ID in: path name: port-id required: true type: string - description: |- Port Monitoring Profile Binding Map ID in: path name: port-monitoring-profile-binding-map-id required: true type: string responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete Port Monitoring Profile Binding Profile tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Monitoring Profile Binding x-vmw-nsx-module: PolicyMonitoringProfileBinding get: consumes: - application/json description: | API will get Port Monitoring Profile Binding Map. operationId: GlobalInfraGetPortMonitoringBinding parameters: - description: |- Tier-1 ID in: path name: tier-1-id required: true type: string - description: |- Segment ID in: path name: segment-id required: true type: string - description: |- Port ID in: path name: port-id required: true type: string - description: |- Port Monitoring Profile Binding Map ID in: path name: port-monitoring-profile-binding-map-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PortMonitoringProfileBindingMap' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Port Monitoring Profile Binding Map tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Monitoring Profile Binding x-vmw-nsx-module: PolicyMonitoringProfileBinding patch: consumes: - application/json description: |- API will create Port Monitoring Profile Binding Map. operationId: GlobalInfraPatchPortMonitoringBinding parameters: - description: |- Tier-1 ID in: path name: tier-1-id required: true type: string - description: |- Segment ID in: path name: segment-id required: true type: string - description: |- Port ID in: path name: port-id required: true type: string - description: |- Port Monitoring Profile Binding Map ID in: path name: port-monitoring-profile-binding-map-id required: true type: string - in: body name: PortMonitoringProfileBindingMap required: true schema: $ref: '#/definitions/PortMonitoringProfileBindingMap' responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create Port Monitoring Profile Binding Map tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Monitoring Profile Binding x-vmw-nsx-module: PolicyMonitoringProfileBinding put: consumes: - application/json description: |- API will update Port Monitoring Profile Binding Map. operationId: GlobalInfraUpdatePortMonitoringBinding parameters: - description: |- Tier-1 ID in: path name: tier-1-id required: true type: string - description: |- Segment ID in: path name: segment-id required: true type: string - description: |- Port ID in: path name: port-id required: true type: string - description: |- Port Monitoring Profile Binding Map ID in: path name: port-monitoring-profile-binding-map-id required: true type: string - in: body name: PortMonitoringProfileBindingMap required: true schema: $ref: '#/definitions/PortMonitoringProfileBindingMap' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PortMonitoringProfileBindingMap' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Update Port Monitoring Profile Binding Map tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Monitoring Profile Binding x-vmw-nsx-module: PolicyMonitoringProfileBinding ? /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-monitoring-profile-binding-maps/{port-monitoring-profile-binding-map-id}/mirror-stack-status : get: consumes: - application/json description: | API will get mirror stack status by Port Monitoring Profile Binding Map. operationId: GlobalInfraGetPortMonitoringBindingMirrorStackStatus parameters: - in: path name: tier-1-id required: true type: string - in: path name: segment-id required: true type: string - in: path name: port-id required: true type: string - in: path name: port-monitoring-profile-binding-map-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Binding map path enforcemnt point path to remote L3 mirror session in: query name: enforcement_point_path required: false type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/MirrorStackStatusListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get mirror stack status for Port Monitoring Profile Binding Map tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Monitoring Profile Binding x-vmw-nsx-module: PolicyMonitoringProfileBinding /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps: get: consumes: - application/json description: | API will list all Port QoS Profile Binding Maps in current port id. operationId: GlobalInfraListPortQoSBindings parameters: - in: path name: tier-1-id required: true type: string - in: path name: segment-id required: true type: string - in: path name: port-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PortQoSProfileBindingMapListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Port QoS Profile Binding Maps tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - QOS Profile Binding x-vmw-nsx-module: PolicyQoSProfileBinding ? /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id} : delete: consumes: - application/json description: |- API will delete Port QoS Profile Binding Profile. operationId: GlobalInfraDeletePortQoSBinding parameters: - description: |- Tier-1 ID in: path name: tier-1-id required: true type: string - description: |- Segment ID in: path name: segment-id required: true type: string - description: |- Port ID in: path name: port-id required: true type: string - description: |- Port QoS Profile Binding Map ID in: path name: port-qos-profile-binding-map-id required: true type: string responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete Port QoS Profile Binding Profile tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - QOS Profile Binding x-vmw-nsx-module: PolicyQoSProfileBinding get: consumes: - application/json description: | API will get Port QoS Profile Binding Map. operationId: GlobalInfraGetPortQoSBinding parameters: - description: |- Tier-1 ID in: path name: tier-1-id required: true type: string - description: |- Segment ID in: path name: segment-id required: true type: string - description: |- Port ID in: path name: port-id required: true type: string - description: |- Port QoS Profile Binding Map ID in: path name: port-qos-profile-binding-map-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PortQoSProfileBindingMap' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Port QoS Profile Binding Map tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - QOS Profile Binding x-vmw-nsx-module: PolicyQoSProfileBinding patch: consumes: - application/json description: |- API will create Port QoS Profile Binding Map. For objects with no binding maps, default profile is applied. operationId: GlobalInfraPatchPortQoSBinding parameters: - description: |- Tier-1 ID in: path name: tier-1-id required: true type: string - description: |- Segment ID in: path name: segment-id required: true type: string - description: |- Port ID in: path name: port-id required: true type: string - description: |- Port QoS Profile Binding Map ID in: path name: port-qos-profile-binding-map-id required: true type: string - in: body name: PortQoSProfileBindingMap required: true schema: $ref: '#/definitions/PortQoSProfileBindingMap' responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create Port QoS Profile Binding Map tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - QOS Profile Binding x-vmw-nsx-module: PolicyQoSProfileBinding put: consumes: - application/json description: |- API will update Port QoS Profile Binding Map. For objects with no binding maps, default profile is applied. operationId: GlobalInfraUpdatePortQoSBinding parameters: - description: |- Tier-1 ID in: path name: tier-1-id required: true type: string - description: |- Segment ID in: path name: segment-id required: true type: string - description: |- Port ID in: path name: port-id required: true type: string - description: |- Port QoS Profile Binding Map ID in: path name: port-qos-profile-binding-map-id required: true type: string - in: body name: PortQoSProfileBindingMap required: true schema: $ref: '#/definitions/PortQoSProfileBindingMap' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PortQoSProfileBindingMap' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Update Port QoS Profile Binding Map tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - QOS Profile Binding x-vmw-nsx-module: PolicyQoSProfileBinding /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps: get: consumes: - application/json description: | API will list all port security profile binding maps. operationId: GlobalInfraListPortSecurityProfileBindings parameters: - description: |- tier-1 gateway id in: path name: tier-1-id required: true type: string - description: |- segment id in: path name: segment-id required: true type: string - description: |- port id in: path name: port-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PortSecurityProfileBindingMapListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List port security profile binding maps tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Segment Security Profile Binding x-vmw-nsx-module: PolicySecurityProfileBinding ? /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id} : delete: consumes: - application/json description: | API will delete the port security profile binding map. operationId: GlobalInfraDeletePortSecurityProfileBinding parameters: - description: |- tier-1 gateway id in: path name: tier-1-id required: true type: string - description: |- segment id in: path name: segment-id required: true type: string - description: |- port id in: path name: port-id required: true type: string - description: |- port security profile binding map id in: path name: port-security-profile-binding-map-id required: true type: string responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete the port security profile binding map tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Segment Security Profile Binding x-vmw-nsx-module: PolicySecurityProfileBinding get: consumes: - application/json description: | API will return details of the port security profile binding map. If the security profile binding map does not exist, it will return 404. operationId: GlobalInfraGetPortSecurityProfileBinding parameters: - description: |- tier-1 gateway id in: path name: tier-1-id required: true type: string - description: |- segment id in: path name: segment-id required: true type: string - description: |- port id in: path name: port-id required: true type: string - description: |- port security profile binding map id in: path name: port-security-profile-binding-map-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PortSecurityProfileBindingMap' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get port security profile binding map tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Segment Security Profile Binding x-vmw-nsx-module: PolicySecurityProfileBinding patch: consumes: - application/json description: | Create a new port security profile binding map if the given security profile binding map does not exist. Otherwise, patch the existing port security profile binding map. For objects with no binding maps, default profile is applied. operationId: GlobalInfraPatchPortSecurityProfileBinding parameters: - description: |- tier-1 gateway id in: path name: tier-1-id required: true type: string - description: |- segment id in: path name: segment-id required: true type: string - description: |- port id in: path name: port-id required: true type: string - description: |- port security profile binding map id in: path name: port-security-profile-binding-map-id required: true type: string - in: body name: PortSecurityProfileBindingMap required: true schema: $ref: '#/definitions/PortSecurityProfileBindingMap' responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Patch port security profile binding map tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Segment Security Profile Binding x-vmw-nsx-module: PolicySecurityProfileBinding put: consumes: - application/json description: | API will create or replace the port security profile binding map. For objects with no binding maps, default profile is applied. operationId: GlobalInfraCreateOrUpdatePortSecurityProfileBinding parameters: - description: |- tier-1 gateway id in: path name: tier-1-id required: true type: string - description: |- segment id in: path name: segment-id required: true type: string - description: |- port id in: path name: port-id required: true type: string - description: |- port security profile binding map id in: path name: port-security-profile-binding-map-id required: true type: string - in: body name: PortSecurityProfileBindingMap required: true schema: $ref: '#/definitions/PortSecurityProfileBindingMap' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PortSecurityProfileBindingMap' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or replace the port security profile binding map tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Segment Security Profile Binding x-vmw-nsx-module: PolicySecurityProfileBinding /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/state: get: consumes: - application/json description: | Returns tier-1 segment port state on enforcement point operationId: GlobalInfraGetTier1SegmentPortState parameters: - in: path name: tier-1-id required: true type: string - in: path name: segment-id required: true type: string - in: path name: port-id required: true type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string - description: Data source type. enum: - realtime - cached in: query name: source required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentPortState' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get tier-1 segment port state tags: - Policy - Networking - Connectivity - Segments - Ports - State x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-discovery-profile-binding-maps: get: consumes: - application/json description: | API will list all Segment Discovery Profile Binding Maps in current segment id. operationId: GlobalInfraListSegmentDiscoveryBindings parameters: - in: path name: tier-1-id required: true type: string - in: path name: segment-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentDiscoveryProfileBindingMapListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Segment Discovery Profile Binding Maps tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Discovery Profile Binding x-vmw-nsx-module: PolicyDiscoveryProfileBinding ? /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-discovery-profile-binding-maps/{segment-discovery-profile-binding-map-id} : get: consumes: - application/json description: | API will get Segment Discovery Profile Binding Map operationId: GlobalInfraGetSegmentDiscoveryBinding parameters: - description: |- Tier-1 ID in: path name: tier-1-id required: true type: string - description: |- Segment ID in: path name: segment-id required: true type: string - description: |- Segment Discovery Profile Binding Map ID in: path name: segment-discovery-profile-binding-map-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentDiscoveryProfileBindingMap' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Segment Discovery Profile Binding Map tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Discovery Profile Binding x-vmw-nsx-module: PolicyDiscoveryProfileBinding /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-monitoring-profile-binding-maps: get: consumes: - application/json description: | API will list all Segment Monitoring Profile Binding Maps in current segment id. operationId: GlobalInfraListSegmentMonitoringBindings parameters: - in: path name: tier-1-id required: true type: string - in: path name: segment-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentMonitoringProfileBindingMapListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Segment Monitoring Profile Binding Maps tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Monitoring Profile Binding x-vmw-nsx-module: PolicyMonitoringProfileBinding ? /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-monitoring-profile-binding-maps/{segment-monitoring-profile-binding-map-id} : get: consumes: - application/json description: | API will get Segment Monitoring Profile Binding Map. operationId: GlobalInfraGetSegmentMonitoringBinding parameters: - description: |- Tier-1 ID in: path name: tier-1-id required: true type: string - description: |- Segment ID in: path name: segment-id required: true type: string - description: |- Segment Monitoring Profile Binding Map ID in: path name: segment-monitoring-profile-binding-map-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentMonitoringProfileBindingMap' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Segment Monitoring Profile Binding Map tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Monitoring Profile Binding x-vmw-nsx-module: PolicyMonitoringProfileBinding ? /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-monitoring-profile-binding-maps/{segment-monitoring-profile-binding-map-id}/mirror-stack-status : get: consumes: - application/json description: | API will get mirror stack status by Segment Monitoring Profile Binding Map. operationId: GlobalInfraGetSegmentMonitoringBindingMirrorStackStatus parameters: - in: path name: tier-1-id required: true type: string - in: path name: segment-id required: true type: string - in: path name: segment-monitoring-profile-binding-map-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Binding map path enforcemnt point path to remote L3 mirror session in: query name: enforcement_point_path required: false type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/MirrorStackStatusListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get mirror stack status for Segment Monitoring Profile Binding Map tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Monitoring Profile Binding x-vmw-nsx-module: PolicyMonitoringProfileBinding /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-qos-profile-binding-maps: get: consumes: - application/json description: | API will list all Segment QoS Profile Binding Maps in current segment id. operationId: GlobalInfraListSegmentQoSBindings parameters: - in: path name: tier-1-id required: true type: string - in: path name: segment-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentQoSProfileBindingMapListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Segment QoS Profile Binding Maps tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - QOS Profile Binding x-vmw-nsx-module: PolicyQoSProfileBinding ? /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-qos-profile-binding-maps/{segment-qos-profile-binding-map-id} : get: consumes: - application/json description: | API will get Segment QoS Profile Binding Map. operationId: GlobalInfraGetSegmentQoSBinding parameters: - description: |- Tier-1 ID in: path name: tier-1-id required: true type: string - description: |- Segment ID in: path name: segment-id required: true type: string - description: |- Segment QoS Profile Binding Map ID in: path name: segment-qos-profile-binding-map-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentQoSProfileBindingMap' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Segment QoS Profile Binding Map tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - QOS Profile Binding x-vmw-nsx-module: PolicyQoSProfileBinding /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-security-profile-binding-maps: get: consumes: - application/json description: | API will list all segment security profile binding maps. operationId: GlobalInfraListSegmentSecurityProfileBindings parameters: - description: |- tier-1 gateway id in: path name: tier-1-id required: true type: string - description: |- segment id in: path name: segment-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentSecurityProfileBindingMapListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List segment security profile binding maps tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Segment Security Profile Binding x-vmw-nsx-module: PolicySecurityProfileBinding ? /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-security-profile-binding-maps/{segment-security-profile-binding-map-id} : get: consumes: - application/json description: | API will return details of the segment security profile binding map. If the binding map does not exist, it will return 404. operationId: GlobalInfraGetSegmentSecurityProfileBinding parameters: - description: |- tier-1 gateway id in: path name: tier-1-id required: true type: string - description: |- segment id in: path name: segment-id required: true type: string - description: |- segment security profile binding map id in: path name: segment-security-profile-binding-map-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentSecurityProfileBindingMap' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get segment security profile binding map tags: - Policy - Networking - Connectivity - Segments - Segment Profiles - Segment Security Profile Binding x-vmw-nsx-module: PolicySecurityProfileBinding /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/static-arp: get: consumes: - application/json description: |- Read static ARP config operationId: GlobalInfraReadStaticARPConfig parameters: - in: path name: tier-1-id required: true type: string - in: path name: segment-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/StaticARPConfig' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read static ARP config tags: - Policy - Networking - Connectivity - Segments - Segments (Fixed) x-vmw-nsx-module: PolicyConnectivity /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/tep-table: get: consumes: - application/json description: | Returns TEP table for a segment operationId: GlobalInfraGetTier1SegmentTepTable parameters: - in: path name: tier-1-id required: true type: string - in: path name: segment-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string - description: Data source type. enum: - realtime - cached in: query name: source required: false type: string - description: TransportNode Id in: query name: transport_node_id required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyTepListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get tier-1 segment TEP table tags: - Policy - Networking - Connectivity - Segments - TEP Table x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/tep-table?format=csv: get: consumes: - application/json description: | Returns TEP table for a segment in CSV operationId: GlobalInfraGetTier1SegmentTepTableInCsv parameters: - in: path name: tier-1-id required: true type: string - in: path name: segment-id required: true type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - description: Data source type. enum: - realtime - cached in: query name: source required: false type: string - description: TransportNode Id in: query name: transport_node_id required: false type: string produces: - text/csv responses: '200': description: OK schema: $ref: '#/definitions/PolicyTepCsvListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get tier-1 segment TEP table in CSV tags: - Policy - Networking - Connectivity - Segments - TEP Table x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-1s/{tier-1-id}/segments/{segments-id}/ports/{port-id}/statistics: get: consumes: - application/json description: | Get tier-1 segment port statistics information. operationId: GlobalInfraGetSegmentPortStatistics parameters: - in: path name: tier-1-id required: true type: string - in: path name: segments-id required: true type: string - in: path name: port-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Policy path of edge node in: query name: edge_path type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentPortStatistics' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get tier-1 segment port statistics information tags: - Policy - Networking - Connectivity - Segments - Statistics x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-1s/{tier-1-id}/segments/{segments-id}/ports/{port-id}/status: get: consumes: - application/json description: | Get tier1 segment port status information. operationId: GlobalInfraGetSegmentPortStatus parameters: - in: path name: tier-1-id required: true type: string - in: path name: segments-id required: true type: string - in: path name: port-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Policy path of edge node in: query name: edge_path type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentPortStatus' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get segment port status information tags: - Policy - Networking - Connectivity - Segments - Status x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-1s/{tier-1-id}/segments/{segments-id}/state: get: consumes: - application/json description: | Get tier1 segment state information. operationId: GlobalInfraGetSegmentState parameters: - in: path name: tier-1-id required: true type: string - in: path name: segments-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Policy path of edge node in: query name: edge_path type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentConfigurationState' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get segment state information tags: - Policy - Networking - Connectivity - Segments - State x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-1s/{tier-1-id}/segments/{segments-id}/statistics: get: consumes: - application/json description: | Get tier1 segment statistics information. operationId: GlobalInfraGetSegmentStatistics parameters: - in: path name: tier-1-id required: true type: string - in: path name: segments-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Policy path of edge node in: query name: edge_path type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentStatistics' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get segment statistics information tags: - Policy - Networking - Connectivity - Segments - Statistics x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-1s/{tier-1-id}/state: get: consumes: - application/json description: | Returns operationId: GlobalInfraGetTier1State parameters: - in: path name: tier-1-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Enforcement point path in: query name: enforcement_point_path type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - description: Interface path for interface specific state such as IPv6 DAD state in: query name: interface_path type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string - description: Returns specific information based on the value specified. enum: - GATEWAY_STATE - GATEWAY_STATUS - IPV6_STATUS in: query name: type type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/Tier1GatewayState' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Tier1 state tags: - Policy - Networking - Connectivity - Tier-1 Gateways - Routing - State x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-1s/{tier-1-id}/static-routes: get: consumes: - application/json description: | Paginated list of all Tier-1 Static Routes operationId: GlobalInfraListTier1StaticRoutes parameters: - in: path name: tier-1-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/StaticRoutesListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Tier-1 Static Routes tags: - Policy - Networking - Connectivity - Tier-1 Gateways - Routing - Static Routes x-vmw-nsx-module: PolicyConnectivity /global-infra/tier-1s/{tier-1-id}/static-routes/{route-id}: get: consumes: - application/json description: |- Read Tier-1 static routes operationId: GlobalInfraReadTier1StaticRoutes parameters: - in: path name: tier-1-id required: true type: string - in: path name: route-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/StaticRoutes' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read Tier-1 static routes tags: - Policy - Networking - Connectivity - Tier-1 Gateways - Routing - Static Routes x-vmw-nsx-module: PolicyConnectivity /global-infra/tier-1s/{tier-1-id}/tier-0-interface/arp-table: get: consumes: - application/json description: | Get tier-1 interface arp information. operationId: GlobalInfraGetTier1RouterLinkArpTable parameters: - in: path name: tier-1-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Policy path of edge node in: query name: edge_path type: string - description: Enforcement point path in: query name: enforcement_point_path type: string - description: Policy path of host transport node in: query name: host_transport_node_path type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/InterfaceArpTable' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get tier-1 router link arp information tags: - Policy - Networking - Connectivity - Tier-1 Gateways - Interfaces - ARP Table x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-1s/{tier-1-id}/tier-0-interface/arp-table?format=csv: get: consumes: - application/json description: | Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) in CSV format for the tier-1 router link interface. operationId: GlobalInfraGetTier1RouterLinkArpTableCsv parameters: - in: path name: tier-1-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Policy path of edge node in: query name: edge_path type: string - description: Enforcement point path in: query name: enforcement_point_path type: string - description: Policy path of host transport node in: query name: host_transport_node_path type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - text/csv responses: '200': description: OK schema: $ref: '#/definitions/InterfaceArpTableInCsvFormat' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get ARP table from tier-1 router link interface in CSV format tags: - Policy - Networking - Connectivity - Tier-1 Gateways - Interfaces - ARP Table x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-1s/{tier-1-id}/tier-0-interface/statistics: get: consumes: - application/json description: | Get tier-0 interface statistics information. operationId: GlobalInfraGetTier1RouterLinkStatistics parameters: - in: path name: tier-1-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Policy path of edge node in: query name: edge_path type: string - description: String Path of the enforcement point in: query name: enforcement_point_path type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyInterfaceStatistics' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get tier-1 router link statistics information tags: - Policy - Networking - Connectivity - Tier-1 Gateways - Interfaces - Statistics x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-1s/{tier-1-id}/tier-0-interface/statistics/summary: get: consumes: - application/json description: | Get tier-1 interface statistics summary information. operationId: GlobalInfraGetTier1RouterLinkSummaryStatistics parameters: - in: path name: tier-1-id required: true type: string - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: Enforcement point path in: query name: enforcement_point_path type: string - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyInterfaceStatisticsSummary' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get tier-1 router link statistics summary information tags: - Policy - Networking - Connectivity - Tier-1 Gateways - Interfaces - Statistics x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-1s/{tier1-id}/flood-protection-profile-bindings/{flood-protection-profile-binding-id}: get: consumes: - application/json description: | API will get Flood Protection Profile Binding Map for Tier-1 Logical Router. operationId: GlobalInfraGetTier1FloodProtectionProfileBinding parameters: - in: path name: tier1-id required: true type: string - in: path name: flood-protection-profile-binding-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/FloodProtectionProfileBindingMap' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Flood Protection Profile Binding Map for Tier-1 Logical Router tags: - Policy - Security - Security Profiles - Flood Protection Profile Binding x-vmw-nsx-module: PolicyGatewayProfileBinding ? /global-infra/tier-1s/{tier1-id}/locale-services/{locale-services-id}/flood-protection-profile-bindings/{flood-protection-profile-binding-id} : get: consumes: - application/json description: | API will get Flood Protection Profile Binding Map for Tier-1 Logical Router LocaleServices. operationId: GlobalInfraGetTier1LocaleServicesFloodProtectionProfileBinding parameters: - in: path name: tier1-id required: true type: string - in: path name: locale-services-id required: true type: string - in: path name: flood-protection-profile-binding-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/FloodProtectionProfileBindingMap' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Flood Protection Profile Binding Map for Tier-1 Logical Router LocaleServices tags: - Policy - Security - Security Profiles - Flood Protection Profile Binding x-vmw-nsx-module: PolicyGatewayProfileBinding ? /global-infra/tier-1s/{tier1-id}/locale-services/{locale-services-id}/session-timer-profile-bindings/{session-timer-profile-binding-id} : get: consumes: - application/json description: | API will get Session Timer Profile Binding Map for Tier-1 Logical Router LocaleServices. operationId: GlobalInfraGetTier1LocaleServicesSessionTimerProfileBinding parameters: - in: path name: tier1-id required: true type: string - in: path name: locale-services-id required: true type: string - in: path name: session-timer-profile-binding-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SessionTimerProfileBindingMap' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Session Timer Profile Binding Map for Tier-1 Logical Router LocaleServices tags: - Policy - Security - Security Profiles - Session Timer Profile Binding x-vmw-nsx-module: PolicyGatewayProfileBinding /global-infra/tier-1s/{tier1-id}/session-timer-profile-bindings/{session-timer-profile-binding-id}: get: consumes: - application/json description: | API will get Session Timer Profile Binding Map for Tier-1 Logical Router. operationId: GlobalInfraGetTier1SessionTimerProfileBinding parameters: - in: path name: tier1-id required: true type: string - in: path name: session-timer-profile-binding-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SessionTimerProfileBindingMap' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Session Timer Profile Binding Map for Tier-1 Logical Router tags: - Policy - Security - Security Profiles - Session Timer Profile Binding x-vmw-nsx-module: PolicyGatewayProfileBinding /global-infra/tier-1s/{tier1-id}/tls-inspection-config-profile-bindings/{tls-inspection-config-profile-binding-id}: get: consumes: - application/json description: | API will get TLS Config Profile Binding Map for Tier-1 Logical Router. operationId: GlobalInfraGetTier1TlsConfigProfileBindingMap parameters: - in: path name: tier1-id required: true type: string - in: path name: tls-inspection-config-profile-binding-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/TlsConfigProfileBindingMap' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get TLS Config Profile Binding Map for Tier-1 Logical Router tags: - Policy - Security - North South Security - Gateway Firewall - Tls Inspection - Tls Config x-vmw-nsx-module: PolicyGatewayProfileBinding /global-infra/transport-zone-profiles: get: consumes: - application/json description: | API will list all Policy Transport Zone Profiles. operationId: GlobalInfraGetPolicyTransportZoneProfiles parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyTransportZoneProfileListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List Policy Transport Zone Profiles tags: - Policy - Networking - Networking Profiles - Transport Zone Profiles x-vmw-nsx-module: PolicyTransportZoneProfile /global-infra/transport-zone-profiles/{tz-profile-id}: get: consumes: - application/json description: | API will fetch Policy Transport Zone Profile. operationId: GlobalInfraGetPolicyTransportZoneProfile parameters: - in: path name: tz-profile-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyTransportZoneProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get Policy Transport Zone Profile tags: - Policy - Networking - Networking Profiles - Transport Zone Profiles x-vmw-nsx-module: PolicyTransportZoneProfile /global-infra/virtual-machine-group-associations: get: consumes: - application/json description: | Get policy groups for which the given VM is a member. operationId: GlobalInfraGetGroupsForVM parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string - description: Virtual machine external ID in: query name: vm_external_id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyResourceReferenceForEPListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get groups for which the given VM is a member tags: - Policy - Inventory - Groups - Group Members x-vmw-nsx-module: PolicyGroupRealization /global-infra/virtual-network-interface-group-associations: get: consumes: - application/json description: | Get policy groups for which the given VIF is a member. operationId: GlobalInfraGetGroupsForVIF parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - description: String Path of the enforcement point in: query name: enforcement_point_path required: false type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string - description: Virtual network interface external ID in: query name: vif_external_id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyResourceReferenceForEPListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get groups for which the given VIF is a member tags: - Policy - Inventory - Groups - Group Members x-vmw-nsx-module: PolicyGroupRealization /global-infra/vm-tag-replication-policies: get: consumes: - application/json description: | List all VM tag replication policies. operationId: GlobalInfraListVMTagReplicationPolicies parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/VMTagReplicationPolicyListResult' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List all VM tag replication policies tags: - Policy - Inventory - Vm x-vmw-nsx-module: VMTagReplicationPolicy /global-infra/vm-tag-replication-policies/{id}: get: consumes: - application/json description: | Get the VM tag replication policy specified by id. operationId: GlobalInfraGetVMTagReplicationPolicy parameters: - description: |- ID of VM tag replication policy in: path name: id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/VMTagReplicationPolicy' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Get the VM tag replication policy specified by id tags: - Policy - Inventory - Vm x-vmw-nsx-module: VMTagReplicationPolicy /infra: get: consumes: - application/json description: | Read infra. Returns only the infra related properties. Inner object are not populated. operationId: ReadInfra parameters: - description: Base Path for retrieving hierarchical intent in: query name: base_path required: false type: string - description: Filter string as java regex in: query name: filter required: false type: string - description: Filter string to retrieve hierarchy. in: query name: type_filter required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/Infra' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read infra tags: - Policy - Infra - Hierarchical API x-vmw-nsx-module: Policy patch: consumes: - application/json description: | Patch API at infra level can be used in two flavours 1. Like a regular API to update Infra object 2. Hierarchical API: To create/update/delete entire or part of intent hierarchy Hierarchical API: Provides users a way to create entire or part of intent in single API invocation. Input is expressed in a tree format. Each node in tree can have multiple children of different types. System will resolve the dependecies of nodes within the intent tree and will create the model. Children for any node can be specified using ChildResourceReference or ChildPolicyConfigResource. If a resource is specified using ChildResourceReference then it will not be updated only its children will be updated. If Object is specified using ChildPolicyConfigResource, object along with its children will be updated. Hierarchical API can also be used to delete any sub-branch of entire tree. operationId: PatchInfra parameters: - in: body name: Infra required: true schema: $ref: '#/definitions/Infra' - default: false description: Force revision check in: query name: enforce_revision_check required: false type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Update the infra including all the nested entities tags: - Policy - Infra - Hierarchical API x-vmw-nsx-module: Policy put: consumes: - application/json description: | Updates only the single infra object. This does not allow hierarchical updates of entities. operationId: UpdateInfra parameters: - in: body name: Infra required: true schema: $ref: '#/definitions/Infra' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/Infra' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Update the infra object tags: - Policy - Infra - Hierarchical API x-vmw-nsx-module: Policy /infra/alb-analytics-profiles: get: consumes: - application/json description: | Paginated list of all ALBAnalyticsProfile for infra. operationId: ListALBAnalyticsProfile parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ALBAnalyticsProfileApiResponse' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List ALBAnalyticsProfile for infra tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Analytics Profiles x-vmw-nsx-module: PolicyAdvancedLoadBalancer /infra/alb-analytics-profiles/{alb-analyticsprofile-id}: delete: consumes: - application/json description: | Delete the ALBAnalyticsProfile along with all the entities contained by this ALBAnalyticsProfile. operationId: DeleteALBAnalyticsProfile parameters: - description: |- ALBAnalyticsProfile ID in: path name: alb-analyticsprofile-id required: true type: string - default: false description: 'Force delete the resource even if it is being used somewhere ' in: query name: force type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete ALBAnalyticsProfile and all the entities contained by this ALBAnalyticsProfile tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Analytics Profiles x-vmw-nsx-module: PolicyAdvancedLoadBalancer get: consumes: - application/json description: | Read a ALBAnalyticsProfile. operationId: ReadALBAnalyticsProfile parameters: - description: |- ALBAnalyticsProfile ID in: path name: alb-analyticsprofile-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ALBAnalyticsProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read ALBAnalyticsProfile tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Analytics Profiles x-vmw-nsx-module: PolicyAdvancedLoadBalancer patch: consumes: - application/json description: | If a ALBanalyticsprofile with the alb-analyticsprofile-id is not already present, create a new ALBanalyticsprofile. If it already exists, update the ALBanalyticsprofile. This is a full replace. operationId: PatchALBAnalyticsProfile parameters: - description: |- ALBanalyticsprofile ID in: path name: alb-analyticsprofile-id required: true type: string - in: body name: ALBAnalyticsProfile required: true schema: $ref: '#/definitions/ALBAnalyticsProfile' responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or update a ALBanalyticsprofile tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Analytics Profiles x-vmw-nsx-module: PolicyAdvancedLoadBalancer put: consumes: - application/json description: | If a ALBAnalyticsProfile with the alb-AnalyticsProfile-id is not already present, create a new ALBAnalyticsProfile. If it already exists, update the ALBAnalyticsProfile. This is a full replace. operationId: UpdateALBAnalyticsProfile parameters: - description: |- ALBAnalyticsProfile ID in: path name: alb-analyticsprofile-id required: true type: string - in: body name: ALBAnalyticsProfile required: true schema: $ref: '#/definitions/ALBAnalyticsProfile' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ALBAnalyticsProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or update a ALBAnalyticsProfile tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Analytics Profiles x-vmw-nsx-module: PolicyAdvancedLoadBalancer /infra/alb-application-persistence-profiles: get: consumes: - application/json description: | Paginated list of all ALBApplicationPersistenceProfile for infra. operationId: ListALBApplicationPersistenceProfile parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ALBApplicationPersistenceProfileApiResponse' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List ALBApplicationPersistenceProfile for infra tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Application Persistence Profiles x-vmw-nsx-module: PolicyAdvancedLoadBalancer /infra/alb-application-persistence-profiles/{alb-applicationpersistenceprofile-id}: delete: consumes: - application/json description: | Delete the ALBApplicationPersistenceProfile along with all the entities contained by this ALBApplicationPersistenceProfile. operationId: DeleteALBApplicationPersistenceProfile parameters: - description: |- ALBApplicationPersistenceProfile ID in: path name: alb-applicationpersistenceprofile-id required: true type: string - default: false description: 'Force delete the resource even if it is being used somewhere ' in: query name: force type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete ALBApplicationPersistenceProfile and all the entities contained by this ALBApplicationPersistenceProfile tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Application Persistence Profiles x-vmw-nsx-module: PolicyAdvancedLoadBalancer get: consumes: - application/json description: | Read a ALBApplicationPersistenceProfile. operationId: ReadALBApplicationPersistenceProfile parameters: - description: |- ALBApplicationPersistenceProfile ID in: path name: alb-applicationpersistenceprofile-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ALBApplicationPersistenceProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read ALBApplicationPersistenceProfile tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Application Persistence Profiles x-vmw-nsx-module: PolicyAdvancedLoadBalancer patch: consumes: - application/json description: | If a ALBapplicationpersistenceprofile with the alb-applicationpersistenceprofile-id is not already present, create a new ALBapplicationpersistenceprofile. If it already exists, update the ALBapplicationpersistenceprofile. This is a full replace. operationId: PatchALBApplicationPersistenceProfile parameters: - description: |- ALBapplicationpersistenceprofile ID in: path name: alb-applicationpersistenceprofile-id required: true type: string - in: body name: ALBApplicationPersistenceProfile required: true schema: $ref: '#/definitions/ALBApplicationPersistenceProfile' responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or update a ALBapplicationpersistenceprofile tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Application Persistence Profiles x-vmw-nsx-module: PolicyAdvancedLoadBalancer put: consumes: - application/json description: | If a ALBApplicationPersistenceProfile with the alb-ApplicationPersistenceProfile-id is not already present, create a new ALBApplicationPersistenceProfile. If it already exists, update the ALBApplicationPersistenceProfile. This is a full replace. operationId: UpdateALBApplicationPersistenceProfile parameters: - description: |- ALBApplicationPersistenceProfile ID in: path name: alb-applicationpersistenceprofile-id required: true type: string - in: body name: ALBApplicationPersistenceProfile required: true schema: $ref: '#/definitions/ALBApplicationPersistenceProfile' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ALBApplicationPersistenceProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or update a ALBApplicationPersistenceProfile tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Application Persistence Profiles x-vmw-nsx-module: PolicyAdvancedLoadBalancer /infra/alb-application-profiles: get: consumes: - application/json description: | Paginated list of all ALBApplicationProfile for infra. operationId: ListALBApplicationProfile parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ALBApplicationProfileApiResponse' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List ALBApplicationProfile for infra tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Application Profiles x-vmw-nsx-module: PolicyAdvancedLoadBalancer /infra/alb-application-profiles/{alb-applicationprofile-id}: delete: consumes: - application/json description: | Delete the ALBApplicationProfile along with all the entities contained by this ALBApplicationProfile. operationId: DeleteALBApplicationProfile parameters: - description: |- ALBApplicationProfile ID in: path name: alb-applicationprofile-id required: true type: string - default: false description: 'Force delete the resource even if it is being used somewhere ' in: query name: force type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete ALBApplicationProfile and all the entities contained by this ALBApplicationProfile tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Application Profiles x-vmw-nsx-module: PolicyAdvancedLoadBalancer get: consumes: - application/json description: | Read a ALBApplicationProfile. operationId: ReadALBApplicationProfile parameters: - description: |- ALBApplicationProfile ID in: path name: alb-applicationprofile-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ALBApplicationProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read ALBApplicationProfile tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Application Profiles x-vmw-nsx-module: PolicyAdvancedLoadBalancer patch: consumes: - application/json description: | If a ALBapplicationprofile with the alb-applicationprofile-id is not already present, create a new ALBapplicationprofile. If it already exists, update the ALBapplicationprofile. This is a full replace. operationId: PatchALBApplicationProfile parameters: - description: |- ALBapplicationprofile ID in: path name: alb-applicationprofile-id required: true type: string - in: body name: ALBApplicationProfile required: true schema: $ref: '#/definitions/ALBApplicationProfile' responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or update a ALBapplicationprofile tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Application Profiles x-vmw-nsx-module: PolicyAdvancedLoadBalancer put: consumes: - application/json description: | If a ALBApplicationProfile with the alb-ApplicationProfile-id is not already present, create a new ALBApplicationProfile. If it already exists, update the ALBApplicationProfile. This is a full replace. operationId: UpdateALBApplicationProfile parameters: - description: |- ALBApplicationProfile ID in: path name: alb-applicationprofile-id required: true type: string - in: body name: ALBApplicationProfile required: true schema: $ref: '#/definitions/ALBApplicationProfile' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ALBApplicationProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or update a ALBApplicationProfile tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Application Profiles x-vmw-nsx-module: PolicyAdvancedLoadBalancer /infra/alb-auth-profiles: get: consumes: - application/json description: | Paginated list of all ALBAuthProfile for infra. operationId: ListALBAuthProfile parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ALBAuthProfileApiResponse' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List ALBAuthProfile for infra tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Auth Profiles x-vmw-nsx-module: PolicyAdvancedLoadBalancer /infra/alb-auth-profiles/{alb-authprofile-id}: delete: consumes: - application/json description: | Delete the ALBAuthProfile along with all the entities contained by this ALBAuthProfile. operationId: DeleteALBAuthProfile parameters: - description: |- ALBAuthProfile ID in: path name: alb-authprofile-id required: true type: string - default: false description: 'Force delete the resource even if it is being used somewhere ' in: query name: force type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete ALBAuthProfile and all the entities contained by this ALBAuthProfile tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Auth Profiles x-vmw-nsx-module: PolicyAdvancedLoadBalancer get: consumes: - application/json description: | Read a ALBAuthProfile. operationId: ReadALBAuthProfile parameters: - description: |- ALBAuthProfile ID in: path name: alb-authprofile-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ALBAuthProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read ALBAuthProfile tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Auth Profiles x-vmw-nsx-module: PolicyAdvancedLoadBalancer patch: consumes: - application/json description: | If a ALBauthprofile with the alb-authprofile-id is not already present, create a new ALBauthprofile. If it already exists, update the ALBauthprofile. This is a full replace. operationId: PatchALBAuthProfile parameters: - description: |- ALBauthprofile ID in: path name: alb-authprofile-id required: true type: string - in: body name: ALBAuthProfile required: true schema: $ref: '#/definitions/ALBAuthProfile' responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or update a ALBauthprofile tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Auth Profiles x-vmw-nsx-module: PolicyAdvancedLoadBalancer put: consumes: - application/json description: | If a ALBAuthProfile with the alb-AuthProfile-id is not already present, create a new ALBAuthProfile. If it already exists, update the ALBAuthProfile. This is a full replace. operationId: UpdateALBAuthProfile parameters: - description: |- ALBAuthProfile ID in: path name: alb-authprofile-id required: true type: string - in: body name: ALBAuthProfile required: true schema: $ref: '#/definitions/ALBAuthProfile' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ALBAuthProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or update a ALBAuthProfile tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Auth Profiles x-vmw-nsx-module: PolicyAdvancedLoadBalancer /infra/alb-auth-token: put: consumes: - application/json description: | Passthorugh API calls to Avi controller using the Auth of policy API request send to this API will be passthrough to Avi controller and Avi controller response will be embedded for this API. operationId: GetALBAuthToken parameters: - in: body name: ALBAuthToken required: true schema: $ref: '#/definitions/ALBAuthToken' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ALBAuthToken' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Alb Auth Token API calls to Avi Controller. tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Auth Token x-vmw-nsx-module: PolicyAdvancedLoadBalancer /infra/alb-auto-scale-launch-configs: get: consumes: - application/json description: | Paginated list of all ALBAutoScaleLaunchConfig for infra. operationId: ListALBAutoScaleLaunchConfig parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ALBAutoScaleLaunchConfigApiResponse' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List ALBAutoScaleLaunchConfig for infra tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Auto Scale Launch Configs x-vmw-nsx-module: PolicyAdvancedLoadBalancer /infra/alb-auto-scale-launch-configs/{alb-autoscalelaunchconfig-id}: delete: consumes: - application/json description: | Delete the ALBAutoScaleLaunchConfig along with all the entities contained by this ALBAutoScaleLaunchConfig. operationId: DeleteALBAutoScaleLaunchConfig parameters: - description: |- ALBAutoScaleLaunchConfig ID in: path name: alb-autoscalelaunchconfig-id required: true type: string - default: false description: 'Force delete the resource even if it is being used somewhere ' in: query name: force type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete ALBAutoScaleLaunchConfig and all the entities contained by this ALBAutoScaleLaunchConfig tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Auto Scale Launch Configs x-vmw-nsx-module: PolicyAdvancedLoadBalancer get: consumes: - application/json description: | Read a ALBAutoScaleLaunchConfig. operationId: ReadALBAutoScaleLaunchConfig parameters: - description: |- ALBAutoScaleLaunchConfig ID in: path name: alb-autoscalelaunchconfig-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ALBAutoScaleLaunchConfig' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read ALBAutoScaleLaunchConfig tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Auto Scale Launch Configs x-vmw-nsx-module: PolicyAdvancedLoadBalancer patch: consumes: - application/json description: | If a ALBautoscalelaunchconfig with the alb-autoscalelaunchconfig-id is not already present, create a new ALBautoscalelaunchconfig. If it already exists, update the ALBautoscalelaunchconfig. This is a full replace. operationId: PatchALBAutoScaleLaunchConfig parameters: - description: |- ALBautoscalelaunchconfig ID in: path name: alb-autoscalelaunchconfig-id required: true type: string - in: body name: ALBAutoScaleLaunchConfig required: true schema: $ref: '#/definitions/ALBAutoScaleLaunchConfig' responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or update a ALBautoscalelaunchconfig tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Auto Scale Launch Configs x-vmw-nsx-module: PolicyAdvancedLoadBalancer put: consumes: - application/json description: | If a ALBAutoScaleLaunchConfig with the alb-AutoScaleLaunchConfig-id is not already present, create a new ALBAutoScaleLaunchConfig. If it already exists, update the ALBAutoScaleLaunchConfig. This is a full replace. operationId: UpdateALBAutoScaleLaunchConfig parameters: - description: |- ALBAutoScaleLaunchConfig ID in: path name: alb-autoscalelaunchconfig-id required: true type: string - in: body name: ALBAutoScaleLaunchConfig required: true schema: $ref: '#/definitions/ALBAutoScaleLaunchConfig' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ALBAutoScaleLaunchConfig' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or update a ALBAutoScaleLaunchConfig tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Auto Scale Launch Configs x-vmw-nsx-module: PolicyAdvancedLoadBalancer /infra/alb-controller-version: get: consumes: - application/json description: | Read an ALBControllerSupportVersion. operationId: ReadALBControllerSupportedVersion produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ALBControllerVersion' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read an ALBControllerSupportedVersion tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Controller Version x-vmw-nsx-module: PolicyAdvancedLoadBalancer /infra/alb-dns-policies: get: consumes: - application/json description: | Paginated list of all ALBDnsPolicy for infra. operationId: ListALBDnsPolicy parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ALBDnsPolicyApiResponse' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List ALBDnsPolicy for infra tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb DNS Policies x-vmw-nsx-module: PolicyAdvancedLoadBalancer /infra/alb-dns-policies/{alb-dnspolicy-id}: delete: consumes: - application/json description: | Delete the ALBDnsPolicy along with all the entities contained by this ALBDnsPolicy. operationId: DeleteALBDnsPolicy parameters: - description: |- ALBDnsPolicy ID in: path name: alb-dnspolicy-id required: true type: string - default: false description: 'Force delete the resource even if it is being used somewhere ' in: query name: force type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete ALBDnsPolicy and all the entities contained by this ALBDnsPolicy tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb DNS Policies x-vmw-nsx-module: PolicyAdvancedLoadBalancer get: consumes: - application/json description: | Read a ALBDnsPolicy. operationId: ReadALBDnsPolicy parameters: - description: |- ALBDnsPolicy ID in: path name: alb-dnspolicy-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ALBDnsPolicy' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read ALBDnsPolicy tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb DNS Policies x-vmw-nsx-module: PolicyAdvancedLoadBalancer patch: consumes: - application/json description: | If a ALBdnspolicy with the alb-dnspolicy-id is not already present, create a new ALBdnspolicy. If it already exists, update the ALBdnspolicy. This is a full replace. operationId: PatchALBDnsPolicy parameters: - description: |- ALBdnspolicy ID in: path name: alb-dnspolicy-id required: true type: string - in: body name: ALBDnsPolicy required: true schema: $ref: '#/definitions/ALBDnsPolicy' responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or update a ALBdnspolicy tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb DNS Policies x-vmw-nsx-module: PolicyAdvancedLoadBalancer put: consumes: - application/json description: | If a ALBDnsPolicy with the alb-DnsPolicy-id is not already present, create a new ALBDnsPolicy. If it already exists, update the ALBDnsPolicy. This is a full replace. operationId: UpdateALBDnsPolicy parameters: - description: |- ALBDnsPolicy ID in: path name: alb-dnspolicy-id required: true type: string - in: body name: ALBDnsPolicy required: true schema: $ref: '#/definitions/ALBDnsPolicy' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ALBDnsPolicy' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or update a ALBDnsPolicy tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb DNS Policies x-vmw-nsx-module: PolicyAdvancedLoadBalancer /infra/alb-error-page-bodies: get: consumes: - application/json description: | Paginated list of all ALBErrorPageBody for infra. operationId: ListALBErrorPageBody parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ALBErrorPageBodyApiResponse' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List ALBErrorPageBody for infra tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Error Page Bodies x-vmw-nsx-module: PolicyAdvancedLoadBalancer /infra/alb-error-page-bodies/{alb-errorpagebody-id}: delete: consumes: - application/json description: | Delete the ALBErrorPageBody along with all the entities contained by this ALBErrorPageBody. operationId: DeleteALBErrorPageBody parameters: - description: |- ALBErrorPageBody ID in: path name: alb-errorpagebody-id required: true type: string - default: false description: 'Force delete the resource even if it is being used somewhere ' in: query name: force type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete ALBErrorPageBody and all the entities contained by this ALBErrorPageBody tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Error Page Bodies x-vmw-nsx-module: PolicyAdvancedLoadBalancer get: consumes: - application/json description: | Read a ALBErrorPageBody. operationId: ReadALBErrorPageBody parameters: - description: |- ALBErrorPageBody ID in: path name: alb-errorpagebody-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ALBErrorPageBody' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read ALBErrorPageBody tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Error Page Bodies x-vmw-nsx-module: PolicyAdvancedLoadBalancer patch: consumes: - application/json description: | If a ALBerrorpagebody with the alb-errorpagebody-id is not already present, create a new ALBerrorpagebody. If it already exists, update the ALBerrorpagebody. This is a full replace. operationId: PatchALBErrorPageBody parameters: - description: |- ALBerrorpagebody ID in: path name: alb-errorpagebody-id required: true type: string - in: body name: ALBErrorPageBody required: true schema: $ref: '#/definitions/ALBErrorPageBody' responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or update a ALBerrorpagebody tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Error Page Bodies x-vmw-nsx-module: PolicyAdvancedLoadBalancer put: consumes: - application/json description: | If a ALBErrorPageBody with the alb-ErrorPageBody-id is not already present, create a new ALBErrorPageBody. If it already exists, update the ALBErrorPageBody. This is a full replace. operationId: UpdateALBErrorPageBody parameters: - description: |- ALBErrorPageBody ID in: path name: alb-errorpagebody-id required: true type: string - in: body name: ALBErrorPageBody required: true schema: $ref: '#/definitions/ALBErrorPageBody' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ALBErrorPageBody' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or update a ALBErrorPageBody tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Error Page Bodies x-vmw-nsx-module: PolicyAdvancedLoadBalancer /infra/alb-error-page-profiles: get: consumes: - application/json description: | Paginated list of all ALBErrorPageProfile for infra. operationId: ListALBErrorPageProfile parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ALBErrorPageProfileApiResponse' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List ALBErrorPageProfile for infra tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Error Page Profiles x-vmw-nsx-module: PolicyAdvancedLoadBalancer /infra/alb-error-page-profiles/{alb-errorpageprofile-id}: delete: consumes: - application/json description: | Delete the ALBErrorPageProfile along with all the entities contained by this ALBErrorPageProfile. operationId: DeleteALBErrorPageProfile parameters: - description: |- ALBErrorPageProfile ID in: path name: alb-errorpageprofile-id required: true type: string - default: false description: 'Force delete the resource even if it is being used somewhere ' in: query name: force type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete ALBErrorPageProfile and all the entities contained by this ALBErrorPageProfile tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Error Page Profiles x-vmw-nsx-module: PolicyAdvancedLoadBalancer get: consumes: - application/json description: | Read a ALBErrorPageProfile. operationId: ReadALBErrorPageProfile parameters: - description: |- ALBErrorPageProfile ID in: path name: alb-errorpageprofile-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ALBErrorPageProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read ALBErrorPageProfile tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Error Page Profiles x-vmw-nsx-module: PolicyAdvancedLoadBalancer patch: consumes: - application/json description: | If a ALBerrorpageprofile with the alb-errorpageprofile-id is not already present, create a new ALBerrorpageprofile. If it already exists, update the ALBerrorpageprofile. This is a full replace. operationId: PatchALBErrorPageProfile parameters: - description: |- ALBerrorpageprofile ID in: path name: alb-errorpageprofile-id required: true type: string - in: body name: ALBErrorPageProfile required: true schema: $ref: '#/definitions/ALBErrorPageProfile' responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or update a ALBerrorpageprofile tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Error Page Profiles x-vmw-nsx-module: PolicyAdvancedLoadBalancer put: consumes: - application/json description: | If a ALBErrorPageProfile with the alb-ErrorPageProfile-id is not already present, create a new ALBErrorPageProfile. If it already exists, update the ALBErrorPageProfile. This is a full replace. operationId: UpdateALBErrorPageProfile parameters: - description: |- ALBErrorPageProfile ID in: path name: alb-errorpageprofile-id required: true type: string - in: body name: ALBErrorPageProfile required: true schema: $ref: '#/definitions/ALBErrorPageProfile' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ALBErrorPageProfile' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or update a ALBErrorPageProfile tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Error Page Profiles x-vmw-nsx-module: PolicyAdvancedLoadBalancer /infra/alb-hardware-security-module-groups: get: consumes: - application/json description: | Paginated list of all ALBHardwareSecurityModuleGroup for infra. operationId: ListALBHardwareSecurityModuleGroup parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ALBHardwareSecurityModuleGroupApiResponse' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List ALBHardwareSecurityModuleGroup for infra tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Hardware Security Module Groups x-vmw-nsx-module: PolicyAdvancedLoadBalancer /infra/alb-hardware-security-module-groups/{alb-hardwaresecuritymodulegroup-id}: delete: consumes: - application/json description: | Delete the ALBHardwareSecurityModuleGroup along with all the entities contained by this ALBHardwareSecurityModuleGroup. operationId: DeleteALBHardwareSecurityModuleGroup parameters: - description: |- ALBHardwareSecurityModuleGroup ID in: path name: alb-hardwaresecuritymodulegroup-id required: true type: string - default: false description: 'Force delete the resource even if it is being used somewhere ' in: query name: force type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete ALBHardwareSecurityModuleGroup and all the entities contained by this ALBHardwareSecurityModuleGroup tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Hardware Security Module Groups x-vmw-nsx-module: PolicyAdvancedLoadBalancer get: consumes: - application/json description: | Read a ALBHardwareSecurityModuleGroup. operationId: ReadALBHardwareSecurityModuleGroup parameters: - description: |- ALBHardwareSecurityModuleGroup ID in: path name: alb-hardwaresecuritymodulegroup-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ALBHardwareSecurityModuleGroup' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read ALBHardwareSecurityModuleGroup tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Hardware Security Module Groups x-vmw-nsx-module: PolicyAdvancedLoadBalancer patch: consumes: - application/json description: | If a ALBhardwaresecuritymodulegroup with the alb-hardwaresecuritymodulegroup-id is not already present, create a new ALBhardwaresecuritymodulegroup. If it already exists, update the ALBhardwaresecuritymodulegroup. This is a full replace. operationId: PatchALBHardwareSecurityModuleGroup parameters: - description: |- ALBhardwaresecuritymodulegroup ID in: path name: alb-hardwaresecuritymodulegroup-id required: true type: string - in: body name: ALBHardwareSecurityModuleGroup required: true schema: $ref: '#/definitions/ALBHardwareSecurityModuleGroup' responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or update a ALBhardwaresecuritymodulegroup tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Hardware Security Module Groups x-vmw-nsx-module: PolicyAdvancedLoadBalancer put: consumes: - application/json description: | If a ALBHardwareSecurityModuleGroup with the alb-HardwareSecurityModuleGroup-id is not already present, create a new ALBHardwareSecurityModuleGroup. If it already exists, update the ALBHardwareSecurityModuleGroup. This is a full replace. operationId: UpdateALBHardwareSecurityModuleGroup parameters: - description: |- ALBHardwareSecurityModuleGroup ID in: path name: alb-hardwaresecuritymodulegroup-id required: true type: string - in: body name: ALBHardwareSecurityModuleGroup required: true schema: $ref: '#/definitions/ALBHardwareSecurityModuleGroup' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ALBHardwareSecurityModuleGroup' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or update a ALBHardwareSecurityModuleGroup tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Hardware Security Module Groups x-vmw-nsx-module: PolicyAdvancedLoadBalancer /infra/alb-health-monitors: get: consumes: - application/json description: | Paginated list of all ALBHealthMonitor for infra. operationId: ListALBHealthMonitor parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ALBHealthMonitorApiResponse' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List ALBHealthMonitor for infra tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Health Monitors x-vmw-nsx-module: PolicyAdvancedLoadBalancer /infra/alb-health-monitors/{alb-healthmonitor-id}: delete: consumes: - application/json description: | Delete the ALBHealthMonitor along with all the entities contained by this ALBHealthMonitor. operationId: DeleteALBHealthMonitor parameters: - description: |- ALBHealthMonitor ID in: path name: alb-healthmonitor-id required: true type: string - default: false description: 'Force delete the resource even if it is being used somewhere ' in: query name: force type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete ALBHealthMonitor and all the entities contained by this ALBHealthMonitor tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Health Monitors x-vmw-nsx-module: PolicyAdvancedLoadBalancer get: consumes: - application/json description: | Read a ALBHealthMonitor. operationId: ReadALBHealthMonitor parameters: - description: |- ALBHealthMonitor ID in: path name: alb-healthmonitor-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ALBHealthMonitor' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read ALBHealthMonitor tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Health Monitors x-vmw-nsx-module: PolicyAdvancedLoadBalancer patch: consumes: - application/json description: | If a ALBhealthmonitor with the alb-healthmonitor-id is not already present, create a new ALBhealthmonitor. If it already exists, update the ALBhealthmonitor. This is a full replace. operationId: PatchALBHealthMonitor parameters: - description: |- ALBhealthmonitor ID in: path name: alb-healthmonitor-id required: true type: string - in: body name: ALBHealthMonitor required: true schema: $ref: '#/definitions/ALBHealthMonitor' responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or update a ALBhealthmonitor tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Health Monitors x-vmw-nsx-module: PolicyAdvancedLoadBalancer put: consumes: - application/json description: | If a ALBHealthMonitor with the alb-HealthMonitor-id is not already present, create a new ALBHealthMonitor. If it already exists, update the ALBHealthMonitor. This is a full replace. operationId: UpdateALBHealthMonitor parameters: - description: |- ALBHealthMonitor ID in: path name: alb-healthmonitor-id required: true type: string - in: body name: ALBHealthMonitor required: true schema: $ref: '#/definitions/ALBHealthMonitor' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ALBHealthMonitor' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Create or update a ALBHealthMonitor tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb Health Monitors x-vmw-nsx-module: PolicyAdvancedLoadBalancer /infra/alb-http-policy-sets: get: consumes: - application/json description: | Paginated list of all ALBHTTPPolicySet for infra. operationId: ListALBHTTPPolicySet parameters: - description: Opaque cursor to be used for getting next page of records (supplied by current result page) in: query name: cursor type: string - default: false description: Include objects that are marked for deletion in results in: query name: include_mark_for_delete_objects required: false type: boolean - description: Comma separated list of fields that should be included in query result in: query name: included_fields type: string - default: 1000 description: Maximum number of results to return in this page (server may return fewer) format: int64 in: query maximum: 1000 minimum: 0 name: page_size type: integer - in: query name: sort_ascending type: boolean - description: Field by which records are sorted in: query name: sort_by type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ALBHTTPPolicySetApiResponse' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- List ALBHTTPPolicySet for infra tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb HTTP Policy Sets x-vmw-nsx-module: PolicyAdvancedLoadBalancer /infra/alb-http-policy-sets/{alb-httppolicyset-id}: delete: consumes: - application/json description: | Delete the ALBHTTPPolicySet along with all the entities contained by this ALBHTTPPolicySet. operationId: DeleteALBHTTPPolicySet parameters: - description: |- ALBHTTPPolicySet ID in: path name: alb-httppolicyset-id required: true type: string - default: false description: 'Force delete the resource even if it is being used somewhere ' in: query name: force type: boolean responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Delete ALBHTTPPolicySet and all the entities contained by this ALBHTTPPolicySet tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb HTTP Policy Sets x-vmw-nsx-module: PolicyAdvancedLoadBalancer get: consumes: - application/json description: | Read a ALBHTTPPolicySet. operationId: ReadALBHTTPPolicySet parameters: - description: |- ALBHTTPPolicySet ID in: path name: alb-httppolicyset-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ALBHTTPPolicySet' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Read ALBHTTPPolicySet tags: - Policy - Networking - Network Services - Advanced Load Balancing - Alb HTTP Policy Sets x-vmw-nsx-module: PolicyAdvancedLoadBalancer patch: consumes: - application/json description: | If a ALBhttppolicyset with the alb-httppolicyset-id is not already present, create a new ALBhttppolicyset. If it already exists, update the ALBhttppolicyset. This is a full replace. operationId: PatchALBHTTPPolicySet parameters: - description: |- ALBhttppolicyset ID in: path name: alb-httppolicyset-id required: true type: string - in: body name: ALBHTTPPolicySet required: true schema: $ref: '#/definitions/ALBHTTPPolicySet' responses: '200': description: OK '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/response