info: description: VMware NSX-T Data Center Global Policy REST REST API title: NSX-T Data Center Global Policy REST API version: 3.1.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: /global-manager/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: - Policy, 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. 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 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: ProbeConfiguredLdapIdentitySourceProbe 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: FetchIdentitySourceLdapServerCertificateFetch_certificate 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: ProbeUnconfiguredLdapIdentitySourceProbe_identity_source 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: ProbeIdentitySourceLdapServerProbe_ldap_server 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: - Policy, 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: - Policy, 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: - Policy, 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: | When assigning a user role, specify the user name with the same case as it appears in vIDM to access the NSX-T user interface. For example, if vIDM has the user name User1@example.com then the name attribute in the API call must be be User1@example.com and cannot be user1@example.com. 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 user/group's roles assignment operationId: DeleteRoleBinding parameters: - description: |- User/Group's id in: path name: binding-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 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 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: |- Update User or Group's roles 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: DeleteAllStaleRoleBindingsDelete_stale_bindings 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 if there does not exist any role with id , 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 is cloned and the new id, name and description are the ones provided in the request body. operationId: CloneRoleClone 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: ValidateAndRecommendPermissionsValidate 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). The permissions parameter of the NsxRole has been deprecated. operationId: GetCurrentUserInfo 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. 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. 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. 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. 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. 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. tags: - System Administration, Settings, User Management, Vidm Configuration x-vmw-nsx-module: AAA /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: transactional atomicity for the batch of requests embedded in the batch list 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: GetSshFingerprintOfServerRetrieve_ssh_fingerprint 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/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: AdvanceClusterRestoreAdvance 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: CancelClusterRestoreCancel 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: RetryClusterRestoreRetry 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: InitiateClusterRestoreStart 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: SuspendClusterRestoreSuspend 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: RequestOnetimeBackupBackup_to_remote 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: RequestOnetimeInventorySummarySummarize_inventory_to_remote 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, Operations, 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 /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: ResolveErrorResolve_error 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, Operations, 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: 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: |- Update the infra including all the nested 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 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: ListBfdProfile 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: DeleteBfdProfile 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: ReadBfdProfile 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: PatchBfdProfile 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: UpdateBfdProfile 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; resource_type (for example, certificate_self_signed, certificate_ca, or certificate_signed); 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: ListTlsCertificates 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}: delete: consumes: - application/json description: | Removes the specified certificate. The private key associated with the certificate is also deleted. operationId: DeleteTlsCertificate parameters: - description: |- ID of certificate to delete in: path name: certificate-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 Certificate for the Given Certificate ID tags: - Policy, Infra, Certificates, Certificates x-vmw-nsx-module: PolicyCertificate get: consumes: - application/json description: | Returns information for the specified certificate ID, including the certificate's id; resource_type (for example, certificate_self_signed, certificate_ca, or certificate_signed); 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: GetTlsCertificate 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 patch: consumes: - application/json description: | Adds a new private-public certificate and, optionally, a private key that can be applied to one of the user-facing components (appliance management or edge). The certificate and the key should be stored in PEM format. If no private key is provided, the certificate is used as a client certificate in the trust store. A certificate chain will not be expanded into separate certificate instances for reference, but would be pushed to the enforcement point as a single certificate. This patch method does not modify an existing certificate. operationId: PatchTlsCertificate parameters: - in: path name: certificate-id required: true type: string - in: body name: TlsTrustData required: true schema: $ref: '#/definitions/TlsTrustData' 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: |- Add a New Certificate tags: - Policy, Infra, Certificates, Certificates x-vmw-nsx-module: PolicyCertificate put: consumes: - application/json description: | Adds a new private-public certificate and, optionally, a private key that can be applied to one of the user-facing components (appliance management or edge). The certificate and the key should be stored in PEM format. If no private key is provided, the certificate is used as a client certificate in the trust store. A certificate chain will not be expanded into separate certificate instances for reference, but would be pushed to the enforcement point as a single certificate. operationId: AddTlsCertificate parameters: - in: path name: certificate-id required: true type: string - in: body name: TlsTrustData required: true schema: $ref: '#/definitions/TlsTrustData' 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: |- Add a New Certificate tags: - Policy, Infra, Certificates, Certificates x-vmw-nsx-module: PolicyCertificate /global-infra/constraints: get: consumes: - application/json description: |- List tenant constraints. operationId: ListTenantConstraints 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}: delete: consumes: - application/json description: |- Delete tenant constraint. operationId: DeleteTenantConstraint parameters: - in: path name: constraint-id required: true 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: |- Delete tenant Constraint. tags: - Policy, Infra, Constraints x-vmw-nsx-module: PolicyConstraints get: consumes: - application/json description: |- Read tenant constraint. operationId: ReadTenantConstraint 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 patch: consumes: - application/json description: | Create tenant constraint if not exists, otherwise update the existing constraint. operationId: PatchTenantConstraint parameters: - in: path name: constraint-id required: true type: string - in: body name: Constraint required: true schema: $ref: '#/definitions/Constraint' 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 tenant Constraint tags: - Policy, Infra, Constraints x-vmw-nsx-module: PolicyConstraints put: consumes: - application/json description: | Create tenant constraint if it does not exist, otherwise replace the existing constraint. operationId: CreateOrReplaceTenantConstraint parameters: - in: path name: constraint-id required: true type: string - in: body name: Constraint required: true schema: $ref: '#/definitions/Constraint' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/Constraint' '400': $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 tenant Constraint tags: - Policy, Infra, Constraints x-vmw-nsx-module: PolicyConstraints /global-infra/context-profiles: get: consumes: - application/json description: | Get all PolicyContextProfiles operationId: ListPolicyContextProfiles 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, 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: ListProfileSupportedAttributes 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, 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: PatchCustomAttributeList 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, 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: AddRemoveCustomAttributeValues 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, 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: DeletePolicyContextProfile 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, Context Profiles x-vmw-nsx-module: PolicyContextProfile get: consumes: - application/json description: | Get a single PolicyContextProfile by id operationId: GetPolicyContextProfile 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, 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: PatchCreateOrUpdatePolicyContextProfile 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, 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: PutCreateOrUpdatePolicyContextProfile 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, 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: ListTlsCrls 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}: delete: consumes: - application/json description: |- Deletes an existing CRL. operationId: DeleteTlsCrl parameters: - in: path name: crl-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 CRL tags: - Policy, Infra, Certificates, Certification Revocation List x-vmw-nsx-module: PolicyCertificate 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: GetTlsCrl 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 patch: consumes: - application/json description: | Create or patch a Certificate Revocation List for the given id. The CRL is used to verify the client certificate status against the revocation lists published by the CA. For this reason, the administrator needs to add the CRL in certificate repository as well. The CRL must contain PEM data for a single CRL. operationId: CreateOrPatchTlsCrl parameters: - in: path name: crl-id required: true type: string - in: body name: TlsCrl required: true schema: $ref: '#/definitions/TlsCrl' 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 patch a Certificate Revocation List tags: - Policy, Infra, Certificates, Certification Revocation List x-vmw-nsx-module: PolicyCertificate put: consumes: - application/json description: | Create or replace a Certificate Revocation List for the given id. The CRL is used to verify the client certificate status against the revocation lists published by the CA. For this reason, the administrator needs to add the CRL in certificate repository as well. The CRL must contain PEM data for a single CRL. Revision is required. operationId: CreateOrUpdateTlsCrl parameters: - in: path name: crl-id required: true type: string - in: body name: TlsCrl required: true schema: $ref: '#/definitions/TlsCrl' 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: |- Create or fully replace a Certificate Revocation List tags: - Policy, Infra, Certificates, Certification Revocation List x-vmw-nsx-module: PolicyCertificate /global-infra/crls/{crl-id}?action=import: post: consumes: - application/json description: | Adds a new certificate revocation list (CRLs). The CRL is used to verify the client certificate status against the revocation lists published by the CA. For this reason, the administrator needs to add the CRL in certificate repository as well. The CRL can contain a single CRL or multiple CRLs depending on the PEM data. - Single CRL: a single CRL is created with the given id. - Composite CRL: multiple CRLs are generated. Each of the CRL is created with an id generated based on the given id. First CRL is created with crl-id, second with crl-id-1, third with crl-id-2, etc. operationId: CreateTlsCrlImport parameters: - in: path name: crl-id required: true type: string - in: body name: TlsCrl required: true schema: $ref: '#/definitions/TlsCrl' produces: - application/json responses: '201': description: Created 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: |- Create a new Certificate Revocation List 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: ListDhcpRelayConfig 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}: delete: consumes: - application/json description: |- Delete DHCP relay configuration operationId: DeleteDhcpRelayConfig parameters: - description: |- DHCP relay config ID in: path name: dhcp-relay-config-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 DHCP relay configuration tags: - Policy, Networking, IP Management, DHCP, DHCP Relay Configs x-vmw-nsx-module: PolicyConnectivity get: consumes: - application/json description: |- Read DHCP relay configuration operationId: ReadDhcpRelayConfig 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 patch: consumes: - application/json description: | If DHCP relay config with the dhcp-relay-config-id is not already present, create a new DHCP relay config instance. If it already exists, update the DHCP relay config instance with specified attributes. operationId: PatchDhcpRelayConfig parameters: - description: |- DHCP relay config ID in: path name: dhcp-relay-config-id required: true type: string - in: body name: DhcpRelayConfig required: true schema: $ref: '#/definitions/DhcpRelayConfig' 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 DHCP relay configuration tags: - Policy, Networking, IP Management, DHCP, DHCP Relay Configs x-vmw-nsx-module: PolicyConnectivity put: consumes: - application/json description: | If DHCP relay config with the dhcp-relay-config-id is not already present, create a new DHCP relay config instance. If it already exists, replace the DHCP relay config instance with this object. operationId: CreateOrReplaceDhcpRelayConfig parameters: - description: |- DHCP relay config ID in: path name: dhcp-relay-config-id required: true type: string - in: body name: DhcpRelayConfig required: true schema: $ref: '#/definitions/DhcpRelayConfig' 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: |- Create or update 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: ListDhcpServerConfig 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: ReadDhcpServerLeases 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: ReadDhcpServerState 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: ReadDhcpServerStats 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: ReadDhcpServerStatus 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}: delete: consumes: - application/json description: |- Delete DHCP server configuration operationId: DeleteDhcpServerConfig parameters: - description: |- DHCP server config ID in: path name: dhcp-server-config-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 DHCP server configuration tags: - Policy, Networking, IP Management, DHCP, DHCP Server Configs x-vmw-nsx-module: PolicyConnectivity get: consumes: - application/json description: |- Read DHCP server configuration operationId: ReadDhcpServerConfig 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 patch: consumes: - application/json description: | If DHCP server config with the dhcp-server-config-id is not already present, create a new DHCP server config instance. If it already exists, update the DHCP server config instance with specified attributes. Realized entities of this API can be found using the path of Tier-0, Tier1, or Segment where this config is applied on. Modification of edge_cluster_path in DhcpServerConfig will lose all existing DHCP leases. If both the preferred_edge_paths in the DhcpServerConfig are changed in a same PATCH API, e.g. change from [a,b] to [x,y], the current DHCP server leases will be lost, which could cause network connectivity issues. It is recommended to change only one member index in an update call, e.g. from [a, b] to [a,y]. Clearing preferred_edge_paths will not reassign edge nodes from the edge cluster. Instead, the previously-allocated edge nodes will be retained to avoid loss of leases. operationId: PatchDhcpServerConfig parameters: - description: |- DHCP server config ID in: path name: dhcp-server-config-id required: true type: string - in: body name: DhcpServerConfig required: true schema: $ref: '#/definitions/DhcpServerConfig' 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 DHCP server configuration tags: - Policy, Networking, IP Management, DHCP, DHCP Server Configs x-vmw-nsx-module: PolicyConnectivity put: consumes: - application/json description: | If DHCP server config with the dhcp-server-config-id is not already present, create a new DHCP server config instance. If it already exists, replace the DHCP server config instance with this object. Realized entities of this API can be found using the path of Tier-0, Tier1, or Segment where this config is applied on. Modification of edge_cluster_path in DhcpServerConfig will lose all existing DHCP leases. If both the preferred_edge_paths in the DhcpServerConfig are changed in a same PUT API, e.g. change from [a,b] to [x,y], the current DHCP server leases will be lost, which could cause network connectivity issues. It is recommended to change only one member index in an update call, e.g. from [a, b] to [a,y]. Clearing preferred_edge_paths will not reassign edge nodes from the edge cluster. Instead, the previously-allocated edge nodes will be retained to avoid loss of leases. operationId: CreateOrReplaceDhcpServerConfig parameters: - description: |- DHCP server config ID in: path name: dhcp-server-config-id required: true type: string - in: body name: DhcpServerConfig required: true schema: $ref: '#/definitions/DhcpServerConfig' 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: |- Create or update 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: ListPolicyDnsForwarderZone 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}: delete: consumes: - application/json description: |- Delete the DNS Forwarder Zone operationId: DeletePolicyDnsForwarderZone parameters: - description: |- DNS Forwarder Zone ID in: path name: dns-forwarder-zone-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 DNS Forwarder Zone tags: - Policy, Networking, IP Management, DNS, DNS Forwarder, DNS Zones x-vmw-nsx-module: PolicyDnsForwarder get: consumes: - application/json description: |- Read the DNS Forwarder Zone operationId: ReadPolicyDnsForwarderZone 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 patch: consumes: - application/json description: |- Create or update the DNS Forwarder Zone operationId: PatchPolicyDnsForwarderZone parameters: - description: |- DNS Forwarder Zone ID in: path name: dns-forwarder-zone-id required: true type: string - in: body name: PolicyDnsForwarderZone required: true schema: $ref: '#/definitions/PolicyDnsForwarderZone' 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 the DNS Forwarder Zone tags: - Policy, Networking, IP Management, DNS, DNS Forwarder, DNS Zones x-vmw-nsx-module: PolicyDnsForwarder put: consumes: - application/json description: |- Create or update the DNS Forwarder Zone operationId: UpdatePolicyDnsForwarderZone parameters: - description: |- DNS Forwarder Zone ID in: path name: dns-forwarder-zone-id required: true type: string - in: body name: PolicyDnsForwarderZone required: true schema: $ref: '#/definitions/PolicyDnsForwarderZone' 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: |- Create or update 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: ListDnsSecurityProfiles 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: DeleteDnsSecurityProfile 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: ReadDnsSecurityProfile 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: PatchDnsSecurityProfile 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: UpdateDnsSecurityProfile 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: ListDomainForInfra 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-flood-protection-profile-binding-maps: get: consumes: - application/json description: | API will list all Firewall Flood Protection Profile Binding Maps across all domains. This API returns the binding maps order by the sequence number. operationId: ListFirewallFloodProtectionBindingsAcrossDomains 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/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 for all domains tags: - Policy, Security, Security Profiles, Flood Protection Profile Binding x-vmw-nsx-module: PolicyFirewallFloodProtectionProfileBinding /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: ListFirewallSessionTimerBindingsAcrossDomains 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}: delete: consumes: - application/json description: | Delete the domain along with all the entities contained by this domain. The groups that are a part of this domain are also deleted along with the domain. operationId: DeleteDomain parameters: - description: |- Domain ID in: path name: domain-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 Domain and all the entities contained by this domain tags: - Policy, Infra, Domains, Domain x-vmw-nsx-module: Policy get: consumes: - application/json description: | Read a domain. operationId: ReadDomainForInfra 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 patch: consumes: - application/json description: | If a domain with the domain-id is not already present, create a new domain. If it already exists, patch the domain operationId: PatchDomainForInfra parameters: - description: |- Domain ID in: path name: domain-id required: true type: string - in: body name: Domain required: true schema: $ref: '#/definitions/Domain' 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 a domain tags: - Policy, Infra, Domains, Domain x-vmw-nsx-module: Policy put: consumes: - application/json description: | If a domain with the domain-id is not already present, create a new domain. If it already exists, update the domain including the nested groups. This is a full replace operationId: UpdateDomainForInfra parameters: - description: |- Domain ID in: path name: domain-id required: true type: string - in: body name: Domain required: true schema: $ref: '#/definitions/Domain' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/Domain' '400': $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 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: ListDomainDeploymentMapsForInfra 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}: delete: consumes: - application/json description: |- Delete Domain Deployment Map operationId: DeleteDomainDeploymentMap parameters: - in: path name: domain-id required: true type: string - in: path name: domain-deployment-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 Domain Deployment Map tags: - Policy, Infra, Domains, Domain Deployment Maps x-vmw-nsx-module: PolicyEnforcementPointManagement get: consumes: - application/json description: | Read a Domain Deployment Map operationId: ReadDomainDeploymentMapForInfra 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 patch: consumes: - application/json description: | If the passed Domain Deployment Map does not already exist, create a new Domain Deployment Map. If it already exist, patch it. operationId: PatchDomainDeploymentMapForInfra parameters: - in: path name: domain-id required: true type: string - in: path name: domain-deployment-map-id required: true type: string - in: body name: DomainDeploymentMap required: true schema: $ref: '#/definitions/DomainDeploymentMap' 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 Domain Deployment Map under infra tags: - Policy, Infra, Domains, Domain Deployment Maps x-vmw-nsx-module: PolicyEnforcementPointManagement put: consumes: - application/json description: | If the passed Domain Deployment Map does not already exist, create a new Domain Deployment Map. If it already exist, replace it. operationId: CreateOrUpdateDomainDeploymentMapForInfra parameters: - in: path name: domain-id required: true type: string - in: path name: domain-deployment-map-id required: true type: string - in: body name: DomainDeploymentMap required: true schema: $ref: '#/definitions/DomainDeploymentMap' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/DomainDeploymentMap' '400': $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 new Domain Deployment Map under infra 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: ListForwardingPolicies 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: ReadForwardingPolicy 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: ListForwardingRule 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: ReadForwardingRule 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: ListGatewayPoliciesForDomain 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}: delete: consumes: - application/json description: |- Delete GatewayPolicy operationId: DeleteGatewayPolicy parameters: - in: path name: domain-id required: true type: string - in: path name: gateway-policy-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 GatewayPolicy tags: - Policy, Security, North South Security, Gateway Firewall, Rules x-vmw-nsx-module: PolicyEdgeFirewall get: consumes: - application/json description: | Read gateway policy for a domain. operationId: ReadGatewayPolicyForDomain 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 patch: consumes: - application/json description: | Update the gateway policy for a domain. This is a full replace. All the rules are replaced. Performance Note: If you want to edit several rules in a gateway policy use this API. It will perform better than several individual rule APIs. Just pass all the rules which you wish to edit as embedded rules to it. operationId: PatchGatewayPolicyForDomain parameters: - in: path name: domain-id required: true type: string - in: path name: gateway-policy-id required: true type: string - in: body name: GatewayPolicy required: true schema: $ref: '#/definitions/GatewayPolicy' 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 gateway policy tags: - Policy, Security, North South Security, Gateway Firewall, Rules x-vmw-nsx-module: PolicyEdgeFirewall put: consumes: - application/json description: | Update the gateway policy for a domain. This is a full replace. All the rules are replaced. Performance Note: If you want to edit several rules in a gateway policy, use this API. It will perform better than several individual rule APIs. Just pass all the rules which you wish to edit as embedded rules to it. operationId: CreateOrReplaceGatewayPolicyForDomain parameters: - in: path name: domain-id required: true type: string - in: path name: gateway-policy-id required: true type: string - in: body name: GatewayPolicy required: true schema: $ref: '#/definitions/GatewayPolicy' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/GatewayPolicy' '400': $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 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: ListGatewayRules 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}: delete: consumes: - application/json description: |- Delete rule operationId: DeleteGatewayRule 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 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 rule tags: - Policy, Security, North South Security, Gateway Firewall, Rules x-vmw-nsx-module: PolicyEdgeFirewall get: consumes: - application/json description: |- Read rule operationId: ReadGatewayRule 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 patch: consumes: - application/json description: | Update the gateway rule. Create new rule if a rule with the rule-id is not already present. Performance Note: If you want to edit several rules in a gateway policy, prefer below mentioned API for optimal performance. Pass all the rules which you wish to edit as embedded rules to it. Use this API - PATCH (or PUT) /infra/domains//gateway-policies/ operationId: PatchGatewayRule 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 - in: body name: Rule required: true schema: $ref: '#/definitions/Rule' 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 gateway rule tags: - Policy, Security, North South Security, Gateway Firewall, Rules x-vmw-nsx-module: PolicyEdgeFirewall put: consumes: - application/json description: | Update the gateway rule. Create new rule if a rule with the rule-id is not already present. Performance Note: If you want to edit several rules in a gateway policy, prefer below mentioned API for optimal performance. Pass all the rules which you wish to edit as embedded rules to it. Use this API - PATCH (or PUT) /infra/domains//gateway-policies/ operationId: CreateOrReplaceGatewayRule 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 - in: body name: Rule required: true schema: $ref: '#/definitions/Rule' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/Rule' '400': $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 gateway 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: GetGatewayRuleStatistics 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 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}/rules/{rule-id}?action=revise: post: consumes: - application/json description: | This is used to re-order a gateway rule within a gateway policy. operationId: ReviseGatewayRuleRevise 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 - in: body name: Rule required: true schema: $ref: '#/definitions/Rule' - description: 'The security policy/rule path if operation is ''insert_after'' or ''insert_before'' ' in: query name: anchor_path required: false type: string - default: insert_top description: Operation enum: - insert_top - insert_bottom - insert_after - insert_before in: query name: operation required: false 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: |- Revise the positioning of gateway 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}/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: GetGatewayPolicyStatistics 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 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}/gateway-policies/{gateway-policy-id}?action=revise: post: consumes: - application/json description: | This is used to set a precedence of a gateway policy w.r.t others. operationId: ReviseGatewayPolicyRevise parameters: - in: path name: domain-id required: true type: string - in: path name: gateway-policy-id required: true type: string - in: body name: GatewayPolicy required: true schema: $ref: '#/definitions/GatewayPolicy' - description: 'The security policy/rule path if operation is ''insert_after'' or ''insert_before'' ' in: query name: anchor_path required: false type: string - default: insert_top description: Operation enum: - insert_top - insert_bottom - insert_after - insert_before in: query name: operation required: false 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: |- Revise the positioning of gateway policy tags: - Policy, Security, North South Security, Gateway Firewall, Rules 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: ListGroupForDomain 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}: delete: consumes: - application/json description: |- Delete Group operationId: DeleteGroup 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 - default: false description: Do not delete if the group subtree has any entities in: query name: fail_if_subtree_exists type: boolean - 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 Group tags: - Policy, Inventory, Groups, Groups x-vmw-nsx-module: Policy get: consumes: - application/json description: |- Read group operationId: ReadGroupForDomain 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 patch: consumes: - application/json description: | If a group with the group-id is not already present, create a new group. If it already exists, patch the group. operationId: PatchGroupForDomain 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 - in: body name: Group required: true schema: $ref: '#/definitions/Group' 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 a group tags: - Policy, Inventory, Groups, Groups x-vmw-nsx-module: Policy put: consumes: - application/json description: | If a group with the group-id is not already present, create a new group. If it already exists, update the group. Avoid creating groups with multiple MACAddressExpression and IPAddressExpression. In future releases, group will be restricted to contain a single MACAddressExpression and IPAddressExpression along with other expressions. To group IPAddresses or MACAddresses, use nested groups instead of multiple IPAddressExpressions/MACAddressExpression. operationId: UpdateGroupForDomain 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 - in: body name: Group required: true schema: $ref: '#/definitions/Group' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/Group' '400': $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 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: ListGroupDiscoveryProfileBindings 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}: delete: consumes: - application/json description: |- API will delete Group discovery profile binding map operationId: DeleteGroupDiscoveryProfileBinding 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 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 Group discovery profile binding map tags: - Policy, Networking, Connectivity, Segments, Segment Profiles, Discovery Profile Binding x-vmw-nsx-module: PolicyDiscoveryProfileBinding get: consumes: - application/json description: |- API will get Group discovery profile binding map operationId: GetGroupDiscoveryProfileBinding 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 patch: consumes: - application/json description: |- API will create or update Group discovery profile binding map operationId: PatchGroupDiscoveryProfileBinding 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 - in: body name: GroupDiscoveryProfileBindingMap required: true schema: $ref: '#/definitions/GroupDiscoveryProfileBindingMap' 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 Group 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 Group discovery profile binding map operationId: UpdateGroupDiscoveryProfileBinding 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 - in: body name: GroupDiscoveryProfileBindingMap required: true schema: $ref: '#/definitions/GroupDiscoveryProfileBindingMap' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/GroupDiscoveryProfileBindingMap' '400': $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 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: ListDnsSecurityProfileBindings 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} : delete: consumes: - application/json description: |- API will delete DNS security profile binding map operationId: DeleteDnsSecurityProfileBinding 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 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 binding map tags: - Policy, Security, Security Profiles, DNS Security Profile Bindings x-vmw-nsx-module: PolicyFirewallDnsSecurityProfileBinding get: consumes: - application/json description: |- API will get DNS security profile binding map operationId: GetDnsSecurityProfileBinding 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 patch: consumes: - application/json description: |- API will create or update DNS security profile binding map operationId: PatchDnsSecurityProfileBinding 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 - in: body name: DnsSecurityProfileBindingMap required: true schema: $ref: '#/definitions/DnsSecurityProfileBindingMap' 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 binding map tags: - Policy, Security, Security Profiles, DNS Security Profile Bindings x-vmw-nsx-module: PolicyFirewallDnsSecurityProfileBinding put: consumes: - application/json description: |- API will update DNS security profile binding map operationId: UpdateDnsSecurityProfileBinding 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 - in: body name: DnsSecurityProfileBindingMap required: true schema: $ref: '#/definitions/DnsSecurityProfileBindingMap' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/DnsSecurityProfileBindingMap' '400': $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 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}/external-id-expressions/{expression-id}: delete: consumes: - application/json description: |- Delete Group External ID Expression operationId: DeleteGroupExternalIDExpression 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: |- ExternalIDExpression ID in: path name: expression-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 Group External ID Expression tags: - Policy, Inventory, Groups, Groups x-vmw-nsx-module: Policy patch: consumes: - application/json description: | If a group ExternalIDexpression with the expression-id is not already present, create a new ExternalIDexpresison. If it already exists, replace the existing ExternalIDexpression. operationId: PatchGroupExternalIDExpressionForDomain 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: |- ExternalIDExpression ID in: path name: expression-id required: true type: string - in: body name: ExternalIDExpression required: true schema: $ref: '#/definitions/ExternalIDExpression' 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 a group external ID expression tags: - Policy, Inventory, Groups, Groups x-vmw-nsx-module: Policy post: consumes: - application/json description: | It will add or remove the specified members having external ID for a given expression of a group. operationId: AddorRemoveGroupExternalIDMembers parameters: - in: path name: domain-id required: true type: string - in: path name: group-id required: true type: string - in: path name: expression-id required: true type: string - in: body name: GroupMemberList required: true schema: $ref: '#/definitions/GroupMemberList' - description: Add or Remove group members. enum: - add - remove in: query name: action required: true 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: | Add or Remove external id based members from/to a Group tags: - Policy, Inventory, Groups, Groups x-vmw-nsx-module: Policy /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: ListPolicyFirewallFloodProtectionBindings 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} : delete: consumes: - application/json description: |- API will delete Firewall Flood Protection Profile Binding operationId: DeletePolicyFirewallFloodProtectionBinding 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 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 Flood Protection Profile Binding tags: - Policy, Security, Security Profiles, Flood Protection Profile Binding x-vmw-nsx-module: PolicyFirewallFloodProtectionProfileBinding get: consumes: - application/json description: | API will get Firewall Flood Protection Profile Binding Map operationId: GetPolicyFirewallFloodProtectionBinding 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 patch: consumes: - application/json description: |- API will create or update Firewall Flood Protection profile binding map operationId: PatchPolicyFirewallFloodProtectionProfileBindingMap 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 - in: body name: PolicyFirewallFloodProtectionProfileBindingMap required: true schema: $ref: '#/definitions/PolicyFirewallFloodProtectionProfileBindingMap' 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 Flood Protection Profile Binding Map tags: - Policy, Security, Security Profiles, Flood Protection Profile Binding x-vmw-nsx-module: PolicyFirewallFloodProtectionProfileBinding put: consumes: - application/json description: |- API will update Firewall Flood Protection Profile Binding Map operationId: UpdatePolicyFirewallFloodProtectionBinding parameters: - description: |- DomainID 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 - in: body name: PolicyFirewallFloodProtectionProfileBindingMap required: true schema: $ref: '#/definitions/PolicyFirewallFloodProtectionProfileBindingMap' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyFirewallFloodProtectionProfileBindingMap' '400': $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 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: ListPolicyFirewallSessionTimerBindings 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} : delete: consumes: - application/json description: |- API will delete Firewall Session Timer Profile Binding operationId: DeletePolicyFirewallSessionTimerBinding 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 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 Binding tags: - Policy, Security, Security Profiles, Session Timer Profile Bindings x-vmw-nsx-module: PolicyFirewallSessionTimerProfileBinding get: consumes: - application/json description: | API will get Firewall Session Timer Profile Binding Map operationId: GetPolicyFirewallSessionTimerBinding 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 patch: consumes: - application/json description: |- API will create or update Firewall Session Timer profile binding map operationId: PatchPolicyFirewallSessionTimerProfileBindingMap 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 - in: body name: PolicyFirewallSessionTimerProfileBindingMap required: true schema: $ref: '#/definitions/PolicyFirewallSessionTimerProfileBindingMap' 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 Binding Map tags: - Policy, Security, Security Profiles, Session Timer Profile Bindings x-vmw-nsx-module: PolicyFirewallSessionTimerProfileBinding put: consumes: - application/json description: |- API will update Firewall Session Timer Profile Binding Map operationId: UpdatePolicyFirewallSessionTimerBinding parameters: - description: |- DomainID 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 - in: body name: PolicyFirewallSessionTimerProfileBindingMap required: true schema: $ref: '#/definitions/PolicyFirewallSessionTimerProfileBindingMap' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyFirewallSessionTimerProfileBindingMap' '400': $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 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: ListGroupMonitoringBindings 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} : delete: consumes: - application/json description: |- API will delete Group Monitoring Profile Binding operationId: DeleteGroupMonitoringBinding 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 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 Group Monitoring Profile Binding tags: - Policy, Security, Security Profiles, Monitoring Profile Binding x-vmw-nsx-module: PolicyMonitoringProfileBinding get: consumes: - application/json description: | API will get Group Monitoring Profile Binding Map operationId: GetGroupMonitoringBinding 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 patch: consumes: - application/json description: |- API will create group monitoring profile binding map operationId: PatchGroupMonitoringBinding 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 - in: body name: GroupMonitoringProfileBindingMap required: true schema: $ref: '#/definitions/GroupMonitoringProfileBindingMap' 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 Group Monitoring Profile Binding Map tags: - Policy, Security, Security Profiles, Monitoring Profile Binding x-vmw-nsx-module: PolicyMonitoringProfileBinding put: consumes: - application/json description: |- API will update Group Monitoring Profile Binding Map operationId: UpdateGroupMonitoringBinding parameters: - description: |- DomainID 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 - in: body name: GroupMonitoringProfileBindingMap required: true schema: $ref: '#/definitions/GroupMonitoringProfileBindingMap' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/GroupMonitoringProfileBindingMap' '400': $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 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: GetGroupMonitoringBindingMirrorStackStatus 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, Segment, Segment Profiles, Monitoring Profile Binding x-vmw-nsx-module: PolicyMonitoringProfileBinding /global-infra/domains/{domain-id}/groups/{group-id}/ip-address-expressions/{expression-id}: delete: consumes: - application/json description: |- Delete Group IPAddressExpression operationId: DeleteGroupIPAddressExpression 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: |- IPAddressExpression ID in: path name: expression-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 Group IPAddressExpression tags: - Policy, Inventory, Groups, Groups x-vmw-nsx-module: Policy patch: consumes: - application/json description: | If a group IPAddressExpression with the expression-id is not already present, create a new IPAddressExpression. If it already exists, replace the existing IPAddressExpression. operationId: PatchGroupIPAddressExpressionForDomain 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: |- IPAddressExpression ID in: path name: expression-id required: true type: string - in: body name: IPAddressExpression required: true schema: $ref: '#/definitions/IPAddressExpression' 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 a group IP Address expression tags: - Policy, Inventory, Groups, Groups x-vmw-nsx-module: Policy post: consumes: - application/json description: | It will add or remove the specified IP Addresses from a given expression of a group. operationId: AddorRemoveGroupIPAddresses parameters: - in: path name: domain-id required: true type: string - in: path name: group-id required: true type: string - in: path name: expression-id required: true type: string - in: body name: IPAddressList required: true schema: $ref: '#/definitions/IPAddressList' - description: Add or Remove group members. enum: - add - remove in: query name: action required: true 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: | Add or Remove IP Addresses from/to a Group tags: - Policy, Inventory, Groups, Groups x-vmw-nsx-module: Policy /global-infra/domains/{domain-id}/groups/{group-id}/mac-address-expressions/{expression-id}: delete: consumes: - application/json description: |- Delete Group MACAddressExpression operationId: DeleteGroupMACAddressExpression 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: |- MACAddressExpression ID in: path name: expression-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 Group MACAddressExpression tags: - Policy, Inventory, Groups, Groups x-vmw-nsx-module: Policy patch: consumes: - application/json description: | If a group MACAddressExpression with the expression-id is not already present, create a new MACAddressExpression. If it already exists, replace the existing MACAddressExpression. operationId: PatchGroupMACAddressExpressionForDomain 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: |- MACAddressExpression ID in: path name: expression-id required: true type: string - in: body name: MACAddressExpression required: true schema: $ref: '#/definitions/MACAddressExpression' 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 a group MAC Address expression tags: - Policy, Inventory, Groups, Groups x-vmw-nsx-module: Policy post: consumes: - application/json description: | It will add or remove the specified MAC Addresses from a given expression of a group. operationId: AddorRemoveGroupMACAddresses parameters: - in: path name: domain-id required: true type: string - in: path name: group-id required: true type: string - in: path name: expression-id required: true type: string - in: body name: MACAddressList required: true schema: $ref: '#/definitions/MACAddressList' - description: Add or Remove group members. enum: - add - remove in: query name: action required: true 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: | Add or Remove MAC Addresses from/to a Group tags: - Policy, Inventory, Groups, Groups x-vmw-nsx-module: Policy /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: GetMemberTypesForGroup 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: GetConsolidatedEffectiveIPMembers 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/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: GetGroupIPMembers 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: GetGroupLPMembers 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: GetGroupLSMembers 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/segment-ports: get: consumes: - application/json description: | Get segment ports that belong to this Group operationId: GetGroupSegmentPortMembers 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: GetGroupSegmentMembers 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: GetGroupVIFMembers 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: GetGroupVMMembers 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}/path-expressions/{expression-id}: delete: consumes: - application/json description: |- Delete Group Path Expression operationId: DeleteGroupPathExpression 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: |- PathExpression ID in: path name: expression-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 Group Path Expression tags: - Policy, Inventory, Groups, Groups x-vmw-nsx-module: Policy patch: consumes: - application/json description: | If a group path_expression with the expression-id is not already present, create a new pathexpresison. If it already exists, replace the existing pathexpression. operationId: PatchGroupPathExpressionForDomain 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: |- PathExpression ID in: path name: expression-id required: true type: string - in: body name: PathExpression required: true schema: $ref: '#/definitions/PathExpression' 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 a group path expression tags: - Policy, Inventory, Groups, Groups x-vmw-nsx-module: Policy post: consumes: - application/json description: | It will add or remove the specified members having path for a given expression of a group. operationId: AddorRemoveGroupPathMembers parameters: - in: path name: domain-id required: true type: string - in: path name: group-id required: true type: string - in: path name: expression-id required: true type: string - in: body name: GroupMemberList required: true schema: $ref: '#/definitions/GroupMemberList' - description: Add or Remove group members. enum: - add - remove in: query name: action required: true 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: | Add or Remove path based members from/to a Group tags: - Policy, Inventory, Groups, Groups x-vmw-nsx-module: Policy /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: GetGroupTags 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: ListSecurityPoliciesForDomain 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}: delete: consumes: - application/json description: | Deletes the security policy along with all the rules operationId: DeleteSecurityPolicyForDomain parameters: - in: path name: domain-id required: true type: string - in: path name: security-policy-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: |- Deletes a security policy from this domain tags: - Policy, Security, East West Security, Distributed Firewall, Rules x-vmw-nsx-module: DfwSecurityPolicy get: consumes: - application/json description: | Read security policy for a domain. operationId: ReadSecurityPolicyForDomain 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 patch: consumes: - application/json description: | Patch the security policy for a domain. If a security policy for the given security-policy-id is not present, the object will get created and if it is present it will be updated. This is a full replace. Performance Note: If you want to edit several rules in a security policy use this API. It will perform better than several individual rule APIs. Just pass all the rules which you wish to edit as embedded rules to it. operationId: PatchSecurityPolicyForDomain parameters: - in: path name: domain-id required: true type: string - in: path name: security-policy-id required: true type: string - in: body name: SecurityPolicy required: true schema: $ref: '#/definitions/SecurityPolicy' 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 security policy tags: - Policy, Security, East West Security, Distributed Firewall, Rules x-vmw-nsx-module: DfwSecurityPolicy put: consumes: - application/json description: | Create or Update the security policy for a domain. This is a full replace. All the rules are replaced. Performance Note: If you want to edit several rules in a security policy, use this API. It will perform better than several individual rule APIs. Just pass all the rules which you wish to edit as embedded rules to it. operationId: UpdateSecurityPolicyForDomain parameters: - in: path name: domain-id required: true type: string - in: path name: security-policy-id required: true type: string - in: body name: SecurityPolicy required: true schema: $ref: '#/definitions/SecurityPolicy' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SecurityPolicy' '400': $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 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: ListSecurityRules 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}: delete: consumes: - application/json description: |- Delete rule operationId: DeleteSecurityRule 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 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 rule tags: - Policy, Security, East West Security, Distributed Firewall, Rules x-vmw-nsx-module: DfwSecurityPolicy get: consumes: - application/json description: |- Read rule operationId: ReadSecurityRule 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 patch: consumes: - application/json description: | Patch the rule. If Rule corresponding to the the given rule-id is not present, the object will get created and if it is present it will be updated. This is a full replace. Performance Note: If you want to edit several rules in a security policy, prefer below mentioned API for optimal performance. Pass all the rules which you wish to edit as embedded rules to it. Use this API - PATCH (or PUT) /infra/domains//security-policies/ operationId: PatchSecurityRule 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 - in: body name: Rule required: true schema: $ref: '#/definitions/Rule' 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 a rule tags: - Policy, Security, East West Security, Distributed Firewall, Rules x-vmw-nsx-module: DfwSecurityPolicy put: consumes: - application/json description: | Update the rule. Create new rule if a rule with the rule-id is not already present. Performance Note: If you wish to edit several rules in a security policy, prefer below mentioned API for optimal performance. Pass all the rules which you wish to edit as embedded rules to it. Use this API - PATCH (or PUT) /infra/domains//security-policies/ operationId: UpdateSecurityRule 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 - in: body name: Rule required: true schema: $ref: '#/definitions/Rule' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/Rule' '400': $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 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: GetRuleStatistics 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 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}/rules/{rule-id}?action=revise: post: consumes: - application/json description: | This is used to re-order a rule within a security policy. operationId: ReviseSecurityRuleRevise 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 - in: body name: Rule required: true schema: $ref: '#/definitions/Rule' - description: 'The security policy/rule path if operation is ''insert_after'' or ''insert_before'' ' in: query name: anchor_path required: false type: string - default: insert_top description: Operation enum: - insert_top - insert_bottom - insert_after - insert_before in: query name: operation required: false 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: |- Revise the positioning of 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}/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: GetSecurityPolicyStatistics 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 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/domains/{domain-id}/security-policies/{security-policy-id}?action=revise: post: consumes: - application/json description: | This is used to set a precedence of a security policy w.r.t others. operationId: ReviseSecurityPoliciesRevise parameters: - in: path name: domain-id required: true type: string - in: path name: security-policy-id required: true type: string - in: body name: SecurityPolicy required: true schema: $ref: '#/definitions/SecurityPolicy' - description: 'The security policy/rule path if operation is ''insert_after'' or ''insert_before'' ' in: query name: anchor_path required: false type: string - default: insert_top description: Operation enum: - insert_top - insert_bottom - insert_after - insert_before in: query name: operation required: false 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: |- Revise the positioning of security policies tags: - Policy, Security, East West Security, Distributed Firewall, Rules x-vmw-nsx-module: DfwSecurityPolicy /global-infra/evpn-tenant-configs/{config-id}: patch: consumes: - application/json description: | Create a global evpn tenant configuration if it is not already present, otherwise update the evpn tenant configuration. operationId: PatchEvpnTenantConfig parameters: - description: |- Evpn Tenant config id in: path name: config-id required: true type: string - in: body name: EvpnTenantConfig required: true schema: $ref: '#/definitions/EvpnTenantConfig' 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 Evpn Tenant Configuration tags: - Policy, Networking, Networking Profiles, EVPN Tenant Configuration x-vmw-nsx-module: PolicyConnectivity put: consumes: - application/json description: | Create or update Evpn Tenant configuration. operationId: CreateOrUpdateEvpnTenantConfig parameters: - description: |- Evpn Tenant config id in: path name: config-id required: true type: string - in: body name: EvpnTenantConfig required: true schema: $ref: '#/definitions/EvpnTenantConfig' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/EvpnTenantConfig' '400': $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 Evpn Tenant Configuration tags: - Policy, Networking, Networking Profiles, EVPN Tenant Configuration x-vmw-nsx-module: PolicyConnectivity /global-infra/federation-config: get: consumes: - application/json description: |- Read a federation config from Global Manager. operationId: ReadFederationConfig 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, Infra, Federation Configuration x-vmw-nsx-module: PolicySiteGM /global-infra/firewall-schedulers: get: consumes: - application/json description: | Get all PolicyFirewallSchedulers operationId: ListPolicyFirewallSchedulers 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/PolicyFirewallSchedulerListResult' '400': $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 PolicyFirewallSchedulers tags: - Policy, Security, East West Security, Distributed Firewall, Settings, Firewall Scheduler x-vmw-nsx-module: PolicyFirewallScheduler /global-infra/firewall-schedulers/{firewall-scheduler-id}: delete: consumes: - application/json description: | Deletes the specified PolicyFirewallScheduler. If scheduler is consumed in a security policy, it won't get deleted. operationId: DeletePolicyFirewallScheduler parameters: - in: path name: firewall-scheduler-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 Policy Firewall Scheduler tags: - Policy, Security, East West Security, Distributed Firewall, Settings, Firewall Scheduler x-vmw-nsx-module: PolicyFirewallScheduler get: consumes: - application/json description: | Get a PolicyFirewallScheduler by id operationId: GetPolicyFirewallScheduler parameters: - in: path name: firewall-scheduler-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyFirewallScheduler' '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: |- Get PolicyFirewallScheduler tags: - Policy, Security, East West Security, Distributed Firewall, Settings, Firewall Scheduler x-vmw-nsx-module: PolicyFirewallScheduler patch: consumes: - application/json description: | Creates/Updates a PolicyFirewallScheduler, which can be set at security policy. Note that at least one property out of "days", "start_date", "time_interval", "end_date" is required if "recurring" field is true. Also "start_time" and "end_time" should not be present. And if "recurring" field is false then "start_date" and "end_date" is mandatory, "start_time" and "end_time" is optional. Also the fields "days" and "time_interval" should not be present. operationId: PatchPolicyFirewallScheduler parameters: - in: path name: firewall-scheduler-id required: true type: string - in: body name: PolicyFirewallScheduler required: true schema: $ref: '#/definitions/PolicyFirewallScheduler' 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 PolicyFirewallScheduler tags: - Policy, Security, East West Security, Distributed Firewall, Settings, Firewall Scheduler x-vmw-nsx-module: PolicyFirewallScheduler put: consumes: - application/json description: | Updates a PolicyFirewallScheduler, which can be set at security policy. Note that at least one property out of "days", "start_date", "time_interval", "end_date" is required if "recurring" field is true. Also "start_time" and "end_time" should not be present. And if "recurring" field is false then "start_date" and "end_date" is mandatory, "start_time" and "end_time" is optional. Also the fields "days" and "time_interval" should not be present. operationId: UpdatePolicyFirewallScheduler parameters: - in: path name: firewall-scheduler-id required: true type: string - in: body name: PolicyFirewallScheduler required: true schema: $ref: '#/definitions/PolicyFirewallScheduler' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyFirewallScheduler' '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: |- Create or Update PolicyFirewallScheduler tags: - Policy, Security, East West Security, Distributed Firewall, Settings, Firewall Scheduler x-vmw-nsx-module: PolicyFirewallScheduler /global-infra/firewall-session-timer-profiles: get: consumes: - application/json description: |- API will list all Firewall Session Timer Profiles operationId: ListPolicyFirewallSessionTimerProfiles 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: DeletePolicyFirewallSessionTimerProfile 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: GetPolicyFirewallSessionTimerProfile 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: PatchPolicyFirewallSessionTimerProfile 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: UpdatePolicyFirewallSessionTimerProfile 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/flood-protection-profiles: get: consumes: - application/json description: |- API will list all Flood Protection Profiles operationId: ListFloodProtectionProfiles 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: DeleteFloodProtectionProfile 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: GetFloodProtectionProfile 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: PatchFloodProtectionProfile 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: UpdateFloodProtectionProfile 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: ListFloodProtectionProfileBindings 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: ListFullSyncStates 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, Local Manager, 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: GetFullSyncStates 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, Local Manager, 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: ListGatewayQosProfiles 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: DeleteGatewayQosProfile 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: ReadGatewayQosProfile 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: PatchGatewayQosProfile 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: CreateOrReplaceGatewayQosProfile 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: patch: consumes: - application/json description: | Create or patch a Global Manager Config operationId: PatchGlobalManagerConfig parameters: - in: body name: GlobalManagerConfig required: true schema: $ref: '#/definitions/GlobalManagerConfig' 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 patch Global Manager Config tags: - Policy, Infra, Federation x-vmw-nsx-module: PolicySiteGM put: consumes: - application/json description: | Create or fully replace a Global Manager Config. Revision is optional for creation and required for update. operationId: CreateOrUpdateGlobalManagerConfig parameters: - in: body name: GlobalManagerConfig required: true schema: $ref: '#/definitions/GlobalManagerConfig' 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: |- Create or fully replace Global Manager Config tags: - Policy, Infra, Federation x-vmw-nsx-module: PolicySiteGM /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: ReadGlobalManagerConfigWithSensitiveDataShow-sensitive-data 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: - Policy, Infra, Federation x-vmw-nsx-module: PolicySiteGM /global-infra/global-managers: get: consumes: - application/json description: | List Global Managers under Infra. operationId: ListInfraGlobalManagers 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, Infra, Global Managers x-vmw-nsx-module: PolicySiteGM /global-infra/global-managers/{global-manager-id}: delete: consumes: - application/json description: | Delete a particular global manager under Infra. Global Manager id 'self' is reserved and can be used for referring to local logged in Global Manager. Example - /infra/global-managers/self operationId: DeleteInfraGlobalManager parameters: - in: path name: global-manager-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 Global Manager under Infra tags: - Federation, Infra, Global Managers x-vmw-nsx-module: PolicySiteGM 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: ReadInfraGlobalManager 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, Infra, Global Managers x-vmw-nsx-module: PolicySiteGM patch: consumes: - application/json description: | Create or patch a Global Manager under Infra. Global Manager id 'self' is reserved and can be used for referring to local logged in Global Manager. Example - /infra/global-managers/self operationId: PatchInfraGlobalManager parameters: - in: path name: global-manager-id required: true type: string - in: body name: GlobalManager required: true schema: $ref: '#/definitions/GlobalManager' - description: Indciates force switchover to Active 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: |- Create or patch a Global Manager tags: - Federation, Infra, Global Managers x-vmw-nsx-module: PolicySiteGM put: consumes: - application/json description: | Create or fully replace Global Manager under Infra. Revision is optional for creation and required for update. Global Manager id 'self' is reserved and can be used for referring to local logged in Global Manager. Example - /infra/global-managers/self operationId: CreateOrUpdateInfraGlobalManager parameters: - in: path name: global-manager-id required: true type: string - in: body name: GlobalManager required: true schema: $ref: '#/definitions/GlobalManager' - description: Indciates force switchover to Active in: query name: force type: boolean produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/GlobalManager' '400': $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 fully replace a Global Manager under infra tags: - Federation, Infra, 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: GetGroupsForObject 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: GetPolicyGroupServiceAssociations 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: GetGroupsForIPAddress 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: GetIPDiscoveryProfiles 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: DeleteIPDiscoveryProfile 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: GetIPDiscoveryProfile 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: CreateIPDiscoveryProfile 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: UpdateIPDiscoveryProfile 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: ListIPFIXDFWCollectorProfiles 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, Operations, 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: DeleteIPFIXDFWCollectorProfile 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, Operations, 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: ReadIPFIXDFWCollectorProfile 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, Operations, 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: PatchIPFIXDFWCollectorProfile 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, Operations, 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: CreateOrReplaceIPFIXDFWCollectorProfile 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, Operations, 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: ListIPFIXDFWProfiles 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, Operations, 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: DeleteIPFIXDFWProfile 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, Operations, IPFIX, Firewall IPFIX Profiles x-vmw-nsx-module: PolicyIPFIXDFW get: consumes: - application/json description: | API will return details of IPFIX DFW profile. operationId: ReadIPFIXDFWProfile 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, Operations, 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: PatchIPFIXDFWProfile 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, Operations, 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: CreateOrReplaceIPFIXDFWProfile 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, Operations, 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: ListIPFIXL2CollectorProfiles 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, Operations, 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: DeleteIPFIXL2CollectorProfile 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, Operations, IPFIX, Switch IPFIX Collectors x-vmw-nsx-module: PolicyIPFIXSwitch get: consumes: - application/json description: | API will return details of IPFIX collector profile. operationId: ReadIPFIXL2CollectorProfile 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, Operations, 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: PatchIPFIXL2CollectorProfile 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, Operations, 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: CreateOrReplaceIPFIXL2CollectorProfile 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, Operations, 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: ListIPFIXL2Profiles 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, Operations, 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: DeleteIPFIXL2Profile 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, Operations, IPFIX, Switch IPFIX Profiles x-vmw-nsx-module: PolicyIPFIXSwitch get: consumes: - application/json description: | API will return details of IPFIX L2 profile. operationId: ReadIPFIXL2Profile 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, Operations, 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: PatchIPFIXL2Profile 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, Operations, 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: CreateOrReplaceIPFIXL2Profile 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, Operations, 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: ListIpv6DadProfiles 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: DeleteIpv6DadProfile 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: ReadIpv6DadProfile 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: PatchIpv6DadProfile 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: CreateOrReplaceIpv6DadProfile 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: ListIpv6NdraProfiles 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: DeleteIpv6NdraProfile 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: ReadIpv6NdraProfile 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: PatchIpv6NdraProfile 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: CreateOrReplaceIpv6NdraProfile 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: ListPolicyLabelForInfra 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}: delete: consumes: - application/json description: |- Delete PolicyLabel object operationId: DeletePolicyLabelForInfra parameters: - in: path name: label-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 PolicyLabel object tags: - Policy, Infra, Labels x-vmw-nsx-module: PolicyLabel get: consumes: - application/json description: | Read a label. operationId: ReadPolicyLabelForInfra 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 patch: consumes: - application/json description: | Create label if not exists, otherwise take the partial updates. Note, once the label is created type attribute can not be changed. operationId: UpdatePolicyLabelForInfra parameters: - in: path name: label-id required: true type: string - in: body name: PolicyLabel required: true schema: $ref: '#/definitions/PolicyLabel' 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 an existing label object tags: - Policy, Infra, Labels x-vmw-nsx-module: PolicyLabel put: consumes: - application/json description: | Create label if not exists, otherwise replaces the existing label. If label already exists then type attribute cannot be changed. operationId: CreateOrReplacePolicyLabelForInfra parameters: - in: path name: label-id required: true type: string - in: body name: PolicyLabel required: true schema: $ref: '#/definitions/PolicyLabel' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/PolicyLabel' '400': $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 label 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: GetMacDiscoveryProfiles 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: DeleteMacDiscoveryProfile 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: GetMacDiscoveryProfile 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: CreateMacDiscoveryProfile 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: UpdateMacDiscoveryProfile 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/overridden-resources: get: consumes: - application/json description: |- List overridden resources operationId: ListOverriddenResources parameters: - description: Global resource path in: query name: intent_path required: false type: string - description: Site path in: query name: site_path required: false type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/OverriddenResourceListResult' '400': $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 overridden resources tags: - Federation, Infra, Federation Configuration x-vmw-nsx-module: PolicyOverrides /global-infra/port-mirroring-profiles: get: consumes: - application/json description: | API will list all port mirroring profiles group. operationId: ListPortMirroringProfiles 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, Operations, 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: DeletePortMirroringProfile 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, Operations, Port Mirroring x-vmw-nsx-module: PolicyPortMirroring get: consumes: - application/json description: | API will return details of port mirroring profile. operationId: ReadPortMirroringProfile 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, Operations, 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: PatchPortMirroringProfile 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, Operations, 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: CreateOrReplacePortMirroringProfile 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, Operations, Port Mirroring x-vmw-nsx-module: PolicyPortMirroring /global-infra/qos-profiles: get: consumes: - application/json description: | API will list all QoS profiles. operationId: ListQoSProfiles 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: DeleteQoSProfile 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: ReadQoSProfile 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: PatchQoSProfile 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: CreateOrReplaceQoSProfile 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/alarms: get: consumes: - application/json description: | Paginated list of all alarms. operationId: ListAlarms 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/PolicyAlarmResourceListResult' '400': $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 alarms in the system tags: - Policy, Infra, Realized State x-vmw-nsx-module: PolicyRealizedState /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: ListRealizedEntities 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: RefreshRealizedStateRefresh 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: - : the request is evaluated on all enforcement points for the given intent without enforcement point specific details. - : the request is evaluated on all enforcement points for the given intent with enforcement point specific details. operationId: ReadIntentStatus 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/segment-security-profiles: get: consumes: - application/json description: | API will list all segment security profiles. operationId: ListSegmentSecurityProfiles 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: DeleteSegmentSecurityProfile 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: GetSegmentSecurityProfile 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: PatchSegmentSecurityProfile 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: CreateOrUpdateSegmentSecurityProfile 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: ListAllInfraSegments 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/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: GetInfraSegmentsByState 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: ListInfraPortDiscoveryBindings 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} : get: consumes: - application/json description: | API will get Infra Port Discovery Profile Binding Map operationId: GetInfraPortDiscoveryBinding 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 /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: ListInfraPortMonitoringBindings 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} : get: consumes: - application/json description: | API will get Infra Port Monitoring Profile Binding Map. operationId: GetInfraPortMonitoringBinding 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 ? /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: GetInfraPortMonitoringBindingMirrorStackStatus 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, Segment, 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: ListInfraSegmentDiscoveryBindings 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} : delete: consumes: - application/json description: |- API will delete Segment Discovery Profile Binding Profile operationId: DeleteInfraSegmentDiscoveryBinding 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 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 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 Segment Discovery Profile Binding Map operationId: GetInfraSegmentDiscoveryBinding 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 patch: consumes: - application/json description: |- API will create Infra Segment Discovery Profile Binding Map. For objects with no binding maps, default profile is applied. operationId: PatchInfraSegmentDiscoveryBinding 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 - in: body name: SegmentDiscoveryProfileBindingMap required: true schema: $ref: '#/definitions/SegmentDiscoveryProfileBindingMap' 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 Segment 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 Segment Discovery Profile Binding Map. For objects with no binding maps, default profile is applied. operationId: UpdateInfraSegmentDiscoveryBinding 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 - in: body name: SegmentDiscoveryProfileBindingMap required: true schema: $ref: '#/definitions/SegmentDiscoveryProfileBindingMap' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentDiscoveryProfileBindingMap' '400': $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 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: ListInfraSegmentMonitoringBindings 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} : delete: consumes: - application/json description: |- API will delete Infra Segment Monitoring Profile Binding Profile. operationId: DeleteInfraSegmentMonitoringBinding 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 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 Segment 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 Segment Monitoring Profile Binding Map. operationId: GetInfraSegmentMonitoringBinding 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 patch: consumes: - application/json description: |- API will create infra segment monitoring profile binding map. operationId: PatchInfraSegmentMonitoringBinding 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 - in: body name: SegmentMonitoringProfileBindingMap required: true schema: $ref: '#/definitions/SegmentMonitoringProfileBindingMap' 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 Segment 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 Segment Monitoring Profile Binding Map. operationId: UpdateInfraSegmentMonitoringBinding 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 - in: body name: SegmentMonitoringProfileBindingMap required: true schema: $ref: '#/definitions/SegmentMonitoringProfileBindingMap' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentMonitoringProfileBindingMap' '400': $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 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: GetInfraSegmentMonitoringBindingMirrorStackStatus 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, Segment, Segment Profiles, Monitoring Profile Binding x-vmw-nsx-module: PolicyMonitoringProfileBinding /global-infra/segments/{segment-id}: delete: consumes: - application/json description: |- Delete infra segment operationId: DeleteInfraSegment parameters: - description: |- Segment ID in: path name: segment-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 segment tags: - Policy, Networking, Connectivity, Segments, Segments x-vmw-nsx-module: PolicyConnectivity get: consumes: - application/json description: |- Read infra segment operationId: ReadInfraSegment 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 patch: consumes: - application/json description: | If segment with the segment-id is not already present, create a new segment. If it already exists, update the segment with specified attributes. operationId: PatchInfraSegment parameters: - description: |- Segment ID in: path name: segment-id required: true type: string - in: body name: Segment required: true schema: $ref: '#/definitions/Segment' 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 segment tags: - Policy, Networking, Connectivity, Segments, Segments x-vmw-nsx-module: PolicyConnectivity put: consumes: - application/json description: | If segment with the segment-id is not already present, create a new segment. If it already exists, replace the segment with this object. operationId: CreateOrReplaceInfraSegment parameters: - description: |- Segment ID in: path name: segment-id required: true type: string - in: body name: Segment required: true schema: $ref: '#/definitions/Segment' 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: |- Create or update a infra segment tags: - Policy, Networking, Connectivity, Segments, Segments x-vmw-nsx-module: PolicyConnectivity /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: GetInfraSegmentInterfaceArpTable 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: 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: GetInfraSegmentInterfaceArpTableCsv 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: 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: ListInfraSegmentDhcpStaticBinding 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}: delete: consumes: - application/json description: |- Delete DHCP static binding operationId: DeleteInfraSegmentDhcpStaticBinding parameters: - in: path name: segment-id required: true type: string - in: path name: binding-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 DHCP static binding tags: - Policy, Networking, IP Management, DHCP, DHCP Static Bindings, Segments Bindings x-vmw-nsx-module: PolicyConnectivity get: consumes: - application/json description: |- Read DHCP static binding operationId: ReadInfraSegmentDhcpStaticBinding 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 patch: consumes: - application/json description: | If binding with the binding-id is not already present, create a new DHCP static binding instance. If it already exists, replace the existing DHCP static binding instance with specified attributes. operationId: PatchInfraSegmentDhcpStaticBinding parameters: - in: path name: segment-id required: true type: string - in: path name: binding-id required: true type: string - in: body name: DhcpStaticBindingConfig required: true schema: $ref: '#/definitions/DhcpStaticBindingConfig' 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 DHCP static binding tags: - Policy, Networking, IP Management, DHCP, DHCP Static Bindings, Segments Bindings x-vmw-nsx-module: PolicyConnectivity put: consumes: - application/json description: | If binding with the binding-id is not already present, create a new DHCP static binding instance. If it already exists, replace the existing DHCP static binding instance with this object. operationId: CreateOrReplaceInfraSegmentDhcpStaticBinding parameters: - in: path name: segment-id required: true type: string - in: path name: binding-id required: true type: string - in: body name: DhcpStaticBindingConfig required: true schema: $ref: '#/definitions/DhcpStaticBindingConfig' 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: |- Create or update 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: ReadInfraSegmentDhcpStaticBindingState 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: | Segment ID is the ID of the segment that is connected to the the tier-0 operationId: GetDownlinkPortArpTableForInfraSegment 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: 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: | Segment ID is the ID of the segment that is connected to the the tier-0 operationId: GetDownlinkPortArpTableForInfraSegmentInCsv 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: 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: GetDownlinkPortDadStateForInfraSegment 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: GetDownlinkPortStatisticsForInfraSegment 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: 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: GetDownlinkPortStatisticsSummaryForInfraSegment 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: GetInfraSegmentCsSpanInfo 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: - Policy, Networking, Connectivity, Segment, Intersite-Forwarder 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: GetInfraSegmentCsTrafficStats 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: - Policy, Networking, Connectivity, Segment, Intersite-Forwarder x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/segments/{segment-id}/mac-table: get: consumes: - application/json description: | Returns MAC table for a segment operationId: GetInfraSegmentMacTable 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, Segment, 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: GetInfraSegmentMacTableInCsv 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, Segment, 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: ListInfraSegmentPorts 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}: get: consumes: - application/json description: | Get detail information on an infra segment port by giving ID. operationId: GetInfraSegmentPort 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 /global-infra/segments/{segment-id}/ports/{port-id}/mac-table: get: consumes: - application/json description: | Returns MAC table for a segment port operationId: GetInfraSegmentPortMacTable 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, Segment, 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: GetInfraSegmentPortMacTableInCsv 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, Segment, 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: ListInfraPortQoSBindings 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}: get: consumes: - application/json description: | API will get Port QoS Profile Binding Map. operationId: GetInfraPortQoSBinding 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 /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: ListInfraSegmentPortSecurityProfileBindings 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} : 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: GetInfraSegmentPortSecurityProfileBinding 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 /global-infra/segments/{segment-id}/ports/{port-id}/state: get: consumes: - application/json description: | Returns infra segment port state on enforcement point operationId: GetInfraSegmentPortState 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, Segment, 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: ListInfraSegmentQoSBindings 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}: delete: consumes: - application/json description: |- API will delete Segment QoS Profile Binding Profile. operationId: DeleteInfraSegmentQoSBinding 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 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 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 Segment QoS Profile Binding Map. operationId: GetInfraSegmentQoSBinding 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 patch: consumes: - application/json description: |- API will create segment QoS profile binding map. For objects with no binding maps, default profile is applied. operationId: PatchInfraSegmentQoSBinding 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 - in: body name: SegmentQoSProfileBindingMap required: true schema: $ref: '#/definitions/SegmentQoSProfileBindingMap' 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 Segment 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 Segment QoS Profile Binding Map. For objects with no binding maps, default profile is applied. operationId: UpdateInfraSegmentQoSBinding 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 - in: body name: SegmentQoSProfileBindingMap required: true schema: $ref: '#/definitions/SegmentQoSProfileBindingMap' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentQoSProfileBindingMap' '400': $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 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: ListInfraSegmentSecurityProfileBindings 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}: delete: consumes: - application/json description: | API will delete segment security profile binding map. operationId: DeleteInfraSegmentSecurityProfileBinding 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 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 segment 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 segment security profile binding map. If the binding map does not exist, it will return 404. operationId: GetInfraSegmentSecurityProfileBinding 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 patch: consumes: - application/json description: | Create a new segment security profile binding map if the given security profile binding map does not exist. Otherwise, patch the existing segment security profile binding map. For objects with no binding maps, default profile is applied. operationId: PatchInfraSegmentSecurityProfileBinding 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 - in: body name: SegmentSecurityProfileBindingMap required: true schema: $ref: '#/definitions/SegmentSecurityProfileBindingMap' 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 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 segment security profile binding map. For objects with no binding maps, default profile is applied. operationId: CreateOrUpdateInfraSegmentSecurityProfileBinding 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 - in: body name: SegmentSecurityProfileBindingMap required: true schema: $ref: '#/definitions/SegmentSecurityProfileBindingMap' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentSecurityProfileBindingMap' '400': $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 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: GetInfraSegmentTepTable 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, Segment, 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: GetInfraSegmentTepTableInCsv 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, Segment, Tep Table x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/segments/{segment-id}?force=true: delete: consumes: - application/json description: |- Force delete bypasses validations during segment deletion. This may result in an inconsistent connectivity. operationId: ForceDeleteInfraSegmentTrue parameters: - in: path name: segment-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: |- Force delete infra segment tags: - Policy, Networking, Connectivity, Segments, Segments x-vmw-nsx-module: PolicyConnectivity patch: consumes: - application/json description: | If segment with the segment-id is not already present, create a new segment. If it already exists, update the segment with specified attributes. Force parameter is required when workload connectivity is indirectly impacted with the current update. operationId: PatchInfraSegmentWithForceTrue parameters: - description: |- Segment ID in: path name: segment-id required: true type: string - in: body name: Segment required: true schema: $ref: '#/definitions/Segment' 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 segment tags: - Policy, Networking, Connectivity, Segments, Segments x-vmw-nsx-module: PolicyConnectivity put: consumes: - application/json description: | If segment with the segment-id is not already present, create a new segment. If it already exists, replace the segment with this object. Force parameter is required when workload connectivity is indirectly impacted with the current replacement. operationId: CreateOrReplaceInfraSegmentWithForceTrue parameters: - description: |- Segment ID in: path name: segment-id required: true type: string - in: body name: Segment required: true schema: $ref: '#/definitions/Segment' 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: |- Create or update a infra segment tags: - Policy, Networking, Connectivity, Segments, Segments x-vmw-nsx-module: PolicyConnectivity /global-infra/segments/{segments-id}/ports/{port-id}/statistics: get: consumes: - application/json description: | Get infra segment port statistics information. operationId: GetInfraSegmentPortStatistics 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, Segment, Statistics x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/segments/{segments-id}/state: get: consumes: - application/json description: | Get infra segment state information. operationId: GetInfraSegmentState 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: GetInfraSegmentStatistics 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: ListServicesForTenant 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}: delete: consumes: - application/json description: |- Delete Service operationId: DeleteServiceForTenant parameters: - description: |- Service ID in: path name: service-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 Service tags: - Policy, Inventory, Services x-vmw-nsx-module: Policy get: consumes: - application/json description: |- Read a service operationId: ReadServiceForTenant 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 patch: consumes: - application/json description: | Create a new service if a service with the given ID does not already exist. Creates new service entries if populated in the service. If a service with the given ID already exists, patch the service including the nested service entries. operationId: PatchServiceForTenant parameters: - description: |- Service ID in: path name: service-id required: true type: string - in: body name: Service required: true schema: $ref: '#/definitions/Service' 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 a Service tags: - Policy, Inventory, Services x-vmw-nsx-module: Policy put: consumes: - application/json description: | Create a new service if a service with the given ID does not already exist. Creates new service entries if populated in the service. If a service with the given ID already exists, update the service including the nested service entries. This is a full replace. operationId: UpdateServiceForTenant parameters: - description: |- Service ID in: path name: service-id required: true type: string - in: body name: Service required: true schema: $ref: '#/definitions/Service' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/Service' '400': $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 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: ListServiceEntries 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}: delete: consumes: - application/json description: |- Delete Service entry operationId: DeleteServiceEntry 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 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 Service entry tags: - Policy, Inventory, Services x-vmw-nsx-module: Policy get: consumes: - application/json description: |- Service entry operationId: ReadServiceEntry 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 patch: consumes: - application/json description: | If a service entry with the service-entry-id is not already present, create a new service entry. If it already exists, patch the service entry. operationId: PatchServiceEntry 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 - in: body name: ServiceEntry required: true schema: $ref: '#/definitions/ServiceEntry' 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 a ServiceEntry tags: - Policy, Inventory, Services x-vmw-nsx-module: Policy put: consumes: - application/json description: | If a service entry with the service-entry-id is not already present, create a new service entry. If it already exists, update the service entry. operationId: UpdateServiceEntry 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 - in: body name: ServiceEntry required: true schema: $ref: '#/definitions/ServiceEntry' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ServiceEntry' '400': $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 ServiceEntry 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: ListSessionTimerProfileBindings 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: ListPolicyFirewallCPUMemThresholdsProfileBindingMaps 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-profile-binding-maps/{cpu-mem-thresholds-profile-binding-map-id}: delete: consumes: - application/json description: |- API will delete Firewall CPU Memory Thresholds Profile Binding. operationId: DeletePolicyFirewallCPUMemThresholdsProfileBindingMap parameters: - description: |- Firewall CPU Memory Thresholds Profile Binding Map ID in: path name: cpu-mem-thresholds-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 Firewall CPU Memory Thresholds Profile Binding 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: ListCPUMemThresholdsProfiles 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: DeleteCPUMemThresholdsProfile 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: ReadCPUMemThresholdsProfile 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: PatchCPUMemThresholdsProfile 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: UpdateCPUMemThresholdsProfile 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/export: get: consumes: - application/json description: | Get the information of the latest export task. operationId: GetExportTask produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ExportTask' '400': $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 information of export task tags: - Policy, Task x-vmw-nsx-module: PolicyTask post: consumes: - application/json description: | Invoke export task. There can be only one export task run at any point of time. Hence invocation of another export task will be discarded, when there exist an already running export task. Exported configuration will be in a CSV format. This CSV file will be zipped into a ZIP file, that can be downloaded after the completion of export task. operationId: InvokeExportTask parameters: - in: body name: ExportRequestParameter required: true schema: $ref: '#/definitions/ExportRequestParameter' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ExportTask' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Invoke export task tags: - Policy, Task x-vmw-nsx-module: PolicyTask /global-infra/settings/firewall/export?action=cancel: post: consumes: - application/json description: | This operation cancels an export task. Task needs to be in running state. operationId: CancelExportTaskCancel produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ExportTask' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': description: Not Found '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Cancel a running export task tags: - Policy, Task x-vmw-nsx-module: PolicyTask /global-infra/settings/firewall/export?action=download: get: consumes: - application/json description: | Download the exported file generated from the last export task. operationId: DownloadExportedFileDownload produces: - application/octet-stream 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: |- Download exported file tags: - Policy, Task x-vmw-nsx-module: PolicyTask /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: ResetRuleStatsReset parameters: - description: Aggregation statistic category enum: - DFW - EDGE in: query name: category 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 firewall rule statistics tags: - Policy, Security, East West Security, Distributed Firewall, Statistics x-vmw-nsx-module: DfwSecurityPolicy /global-infra/site-cleanup-pending: get: consumes: - application/json description: | Paginated list of resources pending to be cleaned. operationId: ListSiteCleanupPending 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: String Path of a resource. in: query name: intent_path 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/SiteCleanupPendingListResult' '400': $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 pending to be cleaned from set of sites. tags: - Federation, Infra, Global Managers x-vmw-nsx-module: GmSiteCleanupPending /global-infra/sites: get: consumes: - application/json description: | List Sites under Infra. operationId: ListSites 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: - Policy, Infra, 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: GetInfraSiteListenerCertificate parameters: - description: Host name or IP address of TLS listener format: host-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: - Policy, Infra, Sites x-vmw-nsx-module: PolicySiteGM /global-infra/sites/{site-id}: delete: consumes: - application/json description: | Delete a site under Infra. operationId: DeleteInfraSite parameters: - in: path name: site-id required: true type: string - in: query name: force 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 a site tags: - Policy, Infra, Sites x-vmw-nsx-module: PolicySiteGM get: consumes: - application/json description: | Read a site under Infra. operationId: ReadSite 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: - Policy, Infra, Sites x-vmw-nsx-module: PolicyEnforcementPointManagement patch: consumes: - application/json description: | Create or patch Site under Infra. operationId: PatchInfraSite parameters: - in: path name: site-id required: true type: string - in: body name: Site required: true schema: $ref: '#/definitions/Site' 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 patch Site tags: - Policy, Infra, Sites x-vmw-nsx-module: PolicySiteGM put: consumes: - application/json description: | Create or fully replace a Site under Infra. Revision is optional for creation and required for update. operationId: CreateOrUpdateInfraSite parameters: - in: path name: site-id required: true type: string - in: body name: Site required: true schema: $ref: '#/definitions/Site' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/Site' '400': $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 fully replace a Site under infra tags: - Policy, Infra, Sites x-vmw-nsx-module: PolicySiteGM /global-infra/sites/{site-id}/enforcement-points: get: consumes: - application/json description: | Paginated list of all enforcementpoints under Site. operationId: ListEnforcementPointForSite 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/{enforcement-point-id}?action=full-sync: post: consumes: - application/json description: |- Full sync EnforcementPoint from Site operationId: FullSyncEnforcementPointForSiteFull-sync parameters: - in: path name: site-id required: true type: string - in: path name: enforcement-point-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: |- Full sync EnforcementPoint from Site tags: - Policy, Infra, Enforcement Points x-vmw-nsx-module: PolicyEnforcementPointManagement /global-infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}: delete: consumes: - application/json description: |- Delete EnforcementPoint from Site operationId: DeleteEnforcementPointForSite parameters: - in: path name: site-id required: true type: string - in: path name: enforcementpoint-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 EnforcementPoint from Site tags: - Policy, Infra, Enforcement Points x-vmw-nsx-module: PolicyEnforcementPointManagement get: consumes: - application/json description: | Read an Enforcement Point under Infra/Site operationId: ReadEnforcementPointForSite 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 patch: consumes: - application/json description: | If the passed Enforcement Point does not already exist, create a new Enforcement Point. If it already exists, patch it. operationId: PatchEnforcementPointForSite parameters: - in: path name: site-id required: true type: string - in: path name: enforcementpoint-id required: true type: string - in: body name: EnforcementPoint required: true schema: $ref: '#/definitions/EnforcementPoint' 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 a new Enforcement Point under Site tags: - Policy, Infra, Enforcement Points x-vmw-nsx-module: PolicyEnforcementPointManagement put: consumes: - application/json description: | If the passed Enforcement Point does not already exist, create a new Enforcement Point. If it already exists, replace it. operationId: CreateOrUpdateEnforcementPointForSite parameters: - in: path name: site-id required: true type: string - in: path name: enforcementpoint-id required: true type: string - in: body name: EnforcementPoint required: true schema: $ref: '#/definitions/EnforcementPoint' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/EnforcementPoint' '400': $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 a new Enforcement Point under 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: ListEdgeClustersForEnforcementPoint 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: ReadEdgeClusterForEnforcementPoint 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: ListEdgeNodesUnderEdgeClusterForEnforcementPoint 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: ReadEdgeNodeUnderEdgeClusterForEnforcementPoint 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: ListTransportZonesForEnforcementPoint 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: PolicyEnforcementPointManagement /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: ReadTransportZoneForEnforcementPoint 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: PolicyEnforcementPointManagement /global-infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}?action=reload: post: consumes: - application/json description: | Reload an Enforcement Point under Site. This will read and update fabric configs from enforcement point. operationId: ReloadEnforcementPointForSiteReload 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: |- Reload an Enforcement Point under Site tags: - Policy, Infra, Enforcement Points x-vmw-nsx-module: PolicyEnforcementPointManagement /global-infra/sites/{site-id}/onboarding/feature-summary: get: consumes: - application/json description: | Get consolidated list of conflicting entities summary for each supported feature for a site with an example. operationId: ListFederationFeatureSummary parameters: - in: path name: site-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ConflictingEntityListResponse' '400': $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 conflicting entities summary for a Site tags: - Federation, Infra, Onboarding x-vmw-nsx-module: GmConfigOnboarding /global-infra/sites/{site-id}/onboarding/invalid-config-details: get: consumes: - application/json description: | Get feature summary details with invalid configuration for a feature. operationId: GetFederationFeatureSummaryDetails parameters: - in: path name: site-id required: true type: string - description: Unsupported features enum: - LB in: query name: feature required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/FederationInvalidConfigurationDetailsResponse' '400': $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 feature entities summary details for a Site tags: - Federation, Infra, Onboarding x-vmw-nsx-module: GmConfigOnboarding /global-infra/sites/{site-id}/onboarding/preferences: get: consumes: - application/json description: | Get user onboarding preferences for a site on global manager. operationId: GetSiteOnboardingPreference parameters: - in: path name: site-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SiteOnboardingPreference' '400': $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 Onboarding Preferences tags: - Federation, Infra, Onboarding x-vmw-nsx-module: GmConfigOnboarding put: consumes: - application/json description: | Update user onboarding preferences to allow or reject site onboarding on global manager. operationId: UpdateSiteOnboardingPreference parameters: - in: path name: site-id required: true type: string - in: body name: SiteOnboardingPreference required: true schema: $ref: '#/definitions/SiteOnboardingPreference' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SiteOnboardingPreference' '400': $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 Onboarding Preferences tags: - Federation, Infra, Onboarding x-vmw-nsx-module: GmConfigOnboarding /global-infra/sites/{site-id}/onboarding/status: get: consumes: - application/json description: |- Get onboarding status for a site. operationId: GetConfigOnboardingStatus parameters: - in: path name: site-id required: true type: string produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ConfigOnboardingStatus' '400': $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 Onboarding status tags: - Federation, Infra, Onboarding x-vmw-nsx-module: GmConfigOnboarding /global-infra/sites/{site-id}/onboarding?action=check_conflict: post: consumes: - application/json description: | Verifies and reports conflicting onboarding feature for a site. The response will contain first conflicting feature for the site configuration compared to corresponding global manager configuration. operationId: CheckConfigOnboardingConflictCheck_conflict parameters: - in: path name: site-id required: true type: string - in: body name: ConfigOnboardingConflictRequest required: true schema: $ref: '#/definitions/ConfigOnboardingConflictRequest' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ConfigOnboardingConflictStatus' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Check Onboarding configuration conflicts tags: - Federation, Infra, Onboarding x-vmw-nsx-module: GmConfigOnboarding /global-infra/sites/{site-id}/onboarding?action=start_onboarding: post: consumes: - application/json description: | Initiate config on-boarding of a Site. The entire on-boarding is async workflow controlled by API. operationId: StartConfigOnboardingStart_onboarding parameters: - in: path name: site-id required: true type: string - in: body name: ConfigOnboardingRequest required: true schema: $ref: '#/definitions/ConfigOnboardingRequest' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/ConfigOnboardingStatus' '400': $ref: '#/responses/BadRequest' '403': $ref: '#/responses/Forbidden' '404': $ref: '#/responses/NotFound' '412': $ref: '#/responses/PreconditionFailed' '500': $ref: '#/responses/InternalServerError' '503': $ref: '#/responses/ServiceUnavailable' summary: |- Start or Check on-boarding for a Site tags: - Federation, Infra, Onboarding x-vmw-nsx-module: GmConfigOnboarding /global-infra/span: get: consumes: - application/json description: |- Get span for an entity with specified path. operationId: GetSpan 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, Infra, Sites x-vmw-nsx-module: PolicySitesSpan /global-infra/spoofguard-profiles: get: consumes: - application/json description: | API will list all SpoofGuard profiles. operationId: ListSpoofGuardProfiles 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: DeleteSpoofGuardProfile 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: GetSpoofGuardProfile 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: PatchSpoofGuardProfile 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: CreateOrUpdateSpoofGuardProfile 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: ListTier0s 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}: delete: consumes: - application/json description: |- Delete Tier-0 operationId: DeleteTier0 parameters: - in: path name: tier-0-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 Tier-0 tags: - Policy, Networking, Connectivity, Tier-0 Gateways, Tier-0 Gateways x-vmw-nsx-module: PolicyConnectivity get: consumes: - application/json description: |- Read Tier-0 operationId: ReadTier0 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 patch: consumes: - application/json description: | If a Tier-0 with the tier-0-id is not already present, create a new Tier-0. If it already exists, update the Tier-0 for specified attributes. operationId: PatchTier0 parameters: - in: path name: tier-0-id required: true type: string - in: body name: Tier0 required: true schema: $ref: '#/definitions/Tier0' 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 tags: - Policy, Networking, Connectivity, Tier-0 Gateways, Tier-0 Gateways x-vmw-nsx-module: PolicyConnectivity put: consumes: - application/json description: | If a Tier-0 with the tier-0-id is not already present, create a new Tier-0. If it already exists, replace the Tier-0 instance with the new object. operationId: CreateOrReplaceTier0 parameters: - in: path name: tier-0-id required: true type: string - in: body name: Tier0 required: true schema: $ref: '#/definitions/Tier0' 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: |- Create or update a Tier-0 tags: - Policy, Networking, Connectivity, Tier-0 Gateways, Tier-0 Gateways x-vmw-nsx-module: PolicyConnectivity /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: ListCommunityList 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}: delete: consumes: - application/json description: |- Delete a BGP community list operationId: DeleteCommunityList parameters: - in: path name: tier-0-id required: true type: string - in: path name: community-list-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 BGP community list tags: - Policy, Networking, Connectivity, Tier-0 Gateways, Routing, Community Lists x-vmw-nsx-module: PolicyConnectivity get: consumes: - application/json description: |- Read a BGP community list operationId: ReadCommunityList 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 patch: consumes: - application/json description: | If a community list with the community-list-id is not already present, create a new community list. If it already exists, update the community list for specified attributes. operationId: PatchCommunityList parameters: - in: path name: tier-0-id required: true type: string - in: path name: community-list-id required: true type: string - in: body name: CommunityList required: true schema: $ref: '#/definitions/CommunityList' 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 community list tags: - Policy, Networking, Connectivity, Tier-0 Gateways, Routing, Community Lists x-vmw-nsx-module: PolicyConnectivity put: consumes: - application/json description: | If a community list with the community-list-id is not already present, create a new community list. If it already exists, replace the community list instance with the new object. operationId: CreateOrReplaceCommunityList parameters: - in: path name: tier-0-id required: true type: string - in: path name: community-list-id required: true type: string - in: body name: CommunityList required: true schema: $ref: '#/definitions/CommunityList' 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: |- Create or update 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: delete: consumes: - application/json description: |- Delete DNS configuration for tier-0 instance operationId: DeletePolicyDnsForwarderOnTier0 parameters: - description: |- Tier-0 ID in: path name: tier-0-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 DNS configuration for tier-0 instance tags: - Policy, Networking, IP Management, DNS, DNS Forwarder, Tier-0 Gateways x-vmw-nsx-module: PolicyDnsForwarder get: consumes: - application/json description: |- Read the DNS Forwarder for the given tier-0 instance operationId: ReadPolicyDnsForwarderOnTier0 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 patch: consumes: - application/json description: |- Update the DNS Forwarder operationId: PatchPolicyDnsForwarderOnTier0 parameters: - description: |- Tier-0 ID in: path name: tier-0-id required: true type: string - in: body name: PolicyDnsForwarder required: true schema: $ref: '#/definitions/PolicyDnsForwarder' 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 DNS Forwarder 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: PerformEPActionForDnsForwarderAtTier0 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 put: consumes: - application/json description: |- Update the DNS Forwarder operationId: UpdatePolicyDnsForwarderOnTier0 parameters: - description: |- Tier-0 ID in: path name: tier-0-id required: true type: string - in: body name: PolicyDnsForwarder required: true schema: $ref: '#/definitions/PolicyDnsForwarder' 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: |- Update the DNS Forwarder 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: LookupAddressViaTier0DNSForwarder 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: GetTier0DNSForwarderStatistics 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: GetTier0DNSForwarderStatus 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: GetTier0ForwardingTable 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: IPv4 or IPv6 CIDR Block format: ip-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 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: GetTier0ForwardingTableCsv 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: IPv4 or IPv6 CIDR Block format: ip-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 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: ViewTier0GatewayFirewall 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}/locale-services: get: consumes: - application/json description: | Paginated list of all Tier-0 locale-services operationId: ListTier0LocaleServices 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: | Returns ARP proxy table for a tier-0 operationId: GetTier0ArpProxies parameters: - in: path name: tier-0-id required: true type: string - in: path name: locale-service-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/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: get: consumes: - application/json description: |- Read BGP routing config operationId: ReadBgpRoutingConfig 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: PatchBgpRoutingConfig 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: CreateOrReplaceBgpRoutingConfig 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: ListBgpNeighborConfigs 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=" 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=" needs to be specified. If an edge_path is unspecified, then bgp neighbor status for all edges is fetched. operationId: GetTier0BgpNeighborsStatus 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: DeleteBgpNeighborConfig 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: ReadBgpNeighborConfig 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: PatchBgpNeighborConfig 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: CreateOrReplaceBgpNeighborConfig 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: GetTier0BgpNeighborAdvertisedRoutes 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: GetTier0BgpNeighborAdvertisedRoutesInCsvFormatCsv 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: GetTier0BgpNeighborRoutes 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: GetTier0BgpNeighborRoutesInCsvFormatCsv 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: ListTier0Interfaces 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: DeleteTier0Interface 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: ReadTier0Interface 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: PatchTier0Interface 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: CreateOrReplaceTier0Interface 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: GetTier0InterfaceArpProxies 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 - 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/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-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=" is given. The edge_path parameter is mandatory if the interface type is not EXTERNAL. operationId: GetTier0InterfaceArpTable 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: 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=" is given. The edge_path parameter is mandatory if the interface type is not EXTERNAL. operationId: GetTier0InterfaceArpTableCsv 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: 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: GetTier0InterfaceDADState 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: GetTier0InterfaceStatistics 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: GetTier0InterfaceStatisticsSummary 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: ListServiceInterfaces 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}: delete: consumes: - application/json description: |- Delete service interface operationId: DeleteServiceInterface 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 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 service interface tags: - Policy, Networking, Connectivity, Tier-0 Gateways, Interfaces, Interfaces x-vmw-nsx-module: PolicyConnectivity get: consumes: - application/json description: |- Read service interface operationId: ReadServiceInterface 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 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: PatchServiceInterface 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: ServiceInterface required: true schema: $ref: '#/definitions/ServiceInterface' 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. Modification of service interface is not allowed. operationId: CreateServiceInterface 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: ServiceInterface required: true schema: $ref: '#/definitions/ServiceInterface' 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: |- Create a 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: ListTier0DeploymentMaps 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}: delete: consumes: - application/json description: |- Delete Tier-0 Deployment Map operationId: DeleteTier0DeploymentMap 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 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 Deployment Map tags: - Policy, Networking, Connectivity, Tier-0 Gateways, Tier-0 Deployment Maps x-vmw-nsx-module: PolicyEnforcementPointManagement get: consumes: - application/json description: | Read a Tier-0 Deployment Map operationId: ReadTier0DeploymentMap 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 patch: consumes: - application/json description: | If the passed Tier-0 Deployment Map does not already exist, create a new Tier-0 Deployment Map. If it already exists, patch it. operationId: PatchTier0DeploymentMap 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 - in: body name: Tier0DeploymentMap required: true schema: $ref: '#/definitions/Tier0DeploymentMap' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/Tier0DeploymentMap' '400': $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 a Tier-0 Deployment Map under Tier-0 tags: - Policy, Networking, Connectivity, Tier-0 Gateways, Tier-0 Deployment Maps x-vmw-nsx-module: PolicyEnforcementPointManagement put: consumes: - application/json description: | If the passed Tier-0 Deployment Map does not already exist, create a new Tier-0 Deployment Map. If it already exists, replace it. operationId: CreateOrUpdateTier0DeploymentMap 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 - in: body name: Tier0DeploymentMap required: true schema: $ref: '#/definitions/Tier0DeploymentMap' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/Tier0DeploymentMap' '400': $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 new Tier-0 Deployment Map under Tier-0 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}: delete: consumes: - application/json description: |- Delete Tier-0 locale-services operationId: DeleteTier0LocaleServices parameters: - in: path name: tier-0-id required: true type: string - in: path name: locale-services-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 Tier-0 locale-services tags: - Policy, Networking, Connectivity, Tier-0 Gateways, Tier-0 Locale Services x-vmw-nsx-module: PolicyConnectivity get: consumes: - application/json description: |- Read Tier-0 locale-services operationId: ReadTier0LocaleServices 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 patch: consumes: - application/json description: | If a Tier-0 locale-services with the locale-services-id is not already present, create a new locale-services. If it already exists, update Tier-0 locale-services with specified attributes. operationId: PatchTier0LocaleServices parameters: - in: path name: tier-0-id required: true type: string - in: path name: locale-services-id required: true type: string - in: body name: LocaleServices required: true schema: $ref: '#/definitions/LocaleServices' 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 locale-services tags: - Policy, Networking, Connectivity, Tier-0 Gateways, Tier-0 Locale Services x-vmw-nsx-module: PolicyConnectivity put: consumes: - application/json description: | If a Tier-0 locale-services with the locale-services-id is not already present, create a new locale-services. If it already exists, replace the Tier-0 locale-services instance with the new object. operationId: CreateOrReplaceTier0LocaleServices parameters: - in: path name: tier-0-id required: true type: string - in: path name: locale-services-id required: true type: string - in: body name: LocaleServices required: true schema: $ref: '#/definitions/LocaleServices' 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: |- Create or update a 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: ViewTier0LocaleServicesGatewayFirewall 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: GetPolicyInterSiteBgpSummary 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: - Policy, Networking, Connectivity, Tier-0 Gateways, Inter-Site 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: GetPolicyInterSiteStatus 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: - Policy, Networking, Connectivity, Tier-0 Gateways, Inter-Site x-vmw-nsx-module: PolicyConnectivityStatistics /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: ListPolicyNatRulesStatisticsFromTier0 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. operationId: ListPolicyNatRulesFromTier0 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}: delete: consumes: - application/json description: |- Delete 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. operationId: DeletePolicyNatRuleFromTier0 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 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 NAT Rule tags: - Policy, Networking, Network Services, NAT, Rules, Tier-0 Gateways x-vmw-nsx-module: PolicyNAT 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. operationId: GetPolicyNatRuleFromTier0 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 patch: consumes: - application/json description: | If a NAT Rule is not already present on Tier-0 denoted by Tier-0 ID, under NAT section denoted by <nat-id>, create a new NAT Rule. If it already exists, update the NAT Rule. 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: PatchPolicyNatRuleOnTier0 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 - in: body name: PolicyNatRule required: true schema: $ref: '#/definitions/PolicyNatRule' 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 NAT Rule on tier-0 tags: - Policy, Networking, Network Services, NAT, Rules, Tier-0 Gateways x-vmw-nsx-module: PolicyNAT put: consumes: - application/json description: |- Update NAT Rule on 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: CreateOrReplacePolicyNatRuleOnTier0 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 - in: body name: PolicyNatRule required: true schema: $ref: '#/definitions/PolicyNatRule' 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: |- Update 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: GetPolicyNatRuleStatisticsFromTier0 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: 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: ListPrefixLists 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}: delete: consumes: - application/json description: |- Delete a prefix list operationId: DeletePrefixList parameters: - in: path name: tier-0-id required: true type: string - in: path name: prefix-list-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 prefix list tags: - Policy, Networking, Connectivity, Tier-0 Gateways, Routing, Prefix List x-vmw-nsx-module: PolicyConnectivity get: consumes: - application/json description: |- Read a prefix list operationId: ReadPrefixList 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 patch: consumes: - application/json description: | If prefix list for prefix-list-id is not already present, create a prefix list. If it already exists, update prefix list for prefix-list-id. operationId: PatchPrefixList parameters: - in: path name: tier-0-id required: true type: string - in: path name: prefix-list-id required: true type: string - in: body name: PrefixList required: true schema: $ref: '#/definitions/PrefixList' 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 prefix list tags: - Policy, Networking, Connectivity, Tier-0 Gateways, Routing, Prefix List x-vmw-nsx-module: PolicyConnectivity put: consumes: - application/json description: | If prefix list for prefix-list-id is not already present, create a prefix list. If it already exists, replace the prefix list for prefix-list-id. operationId: CreateOrReplacePrefixList parameters: - description: |- Tier-0 ID in: path name: tier-0-id required: true type: string - description: |- Prefix List ID in: path name: prefix-list-id required: true type: string - in: body name: PrefixList required: true schema: $ref: '#/definitions/PrefixList' 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: |- Create or update 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: ListAllRouteMaps 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}: delete: consumes: - application/json description: |- Delete a route map operationId: RemoveRouteMap parameters: - in: path name: tier-0-id required: true type: string - in: path name: route-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 a route map tags: - Policy, Networking, Connectivity, Tier-0 Gateways, Routing, Route Maps x-vmw-nsx-module: PolicyConnectivity get: consumes: - application/json description: |- Read a route map operationId: GetRouteMap 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 patch: consumes: - application/json description: | If a route map with the route-map-id is not already present, create a new route map. If it already exists, update the route map for specified attributes. operationId: PatchRouteMap parameters: - in: path name: tier-0-id required: true type: string - in: path name: route-map-id required: true type: string - in: body name: Tier0RouteMap required: true schema: $ref: '#/definitions/Tier0RouteMap' 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 route map tags: - Policy, Networking, Connectivity, Tier-0 Gateways, Routing, Route Maps x-vmw-nsx-module: PolicyConnectivity put: consumes: - application/json description: | If a route map with the route-map-id is not already present, create a new route map. If it already exists, replace the route map instance with the new object. operationId: CreateOrReplaceRouteMap parameters: - in: path name: tier-0-id required: true type: string - in: path name: route-map-id required: true type: string - in: body name: Tier0RouteMap required: true schema: $ref: '#/definitions/Tier0RouteMap' 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: |- Create or update 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: GetTier0Routes 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: IPv4 or IPv6 CIDR Block format: ip-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 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: GetTier0RoutesCsv 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: IPv4 or IPv6 CIDR Block format: ip-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 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: GetTier0State 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 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: ListTier0StaticRoutes 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: ListStaticRouteBfdPeer 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}: delete: consumes: - application/json description: |- Delete this StaticRouteBfdPeer and all the entities contained by it. operationId: DeleteStaticRouteBfdPeer 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 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 this StaticRouteBfdPeer and all the entities contained by it. tags: - Policy, Networking, Connectivity, Tier-0 Gateways, Routing, Static Routes BFD Peers x-vmw-nsx-module: PolicyConnectivity get: consumes: - application/json description: | Read a StaticRouteBfdPeer with the bfd-peer-id. operationId: ReadStaticRouteBfdPeer 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 patch: consumes: - application/json description: | If a StaticRouteBfdPeer with the bfd-peer-id is not already present, create a new StaticRouteBfdPeer. If it already exists, update the StaticRouteBfdPeer. This is a full replace. operationId: PatchStaticRouteBfdPeer 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 - in: body name: StaticRouteBfdPeer required: true schema: $ref: '#/definitions/StaticRouteBfdPeer' 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 StaticRouteBfdPeer tags: - Policy, Networking, Connectivity, Tier-0 Gateways, Routing, Static Routes BFD Peers x-vmw-nsx-module: PolicyConnectivity put: consumes: - application/json description: | If a StaticRouteBfdPeer with the bfd-peer-id is not already present, create a new StaticRouteBfdPeer. If it already exists, update the StaticRouteBfdPeer. This operation will fully replace the object. operationId: UpdateStaticRouteBfdPeer 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 - in: body name: StaticRouteBfdPeer required: true schema: $ref: '#/definitions/StaticRouteBfdPeer' 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: |- Create or update 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}: delete: consumes: - application/json description: |- Delete Tier-0 static routes operationId: DeleteTier0StaticRoutes parameters: - in: path name: tier-0-id required: true type: string - in: path name: route-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 Tier-0 static routes tags: - Policy, Networking, Connectivity, Tier-0 Gateways, Routing, Static Routes x-vmw-nsx-module: PolicyConnectivity get: consumes: - application/json description: |- Read Tier-0 static routes operationId: ReadTier0StaticRoutes 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 patch: consumes: - application/json description: | If static routes for route-id are not already present, create static routes. If it already exists, update static routes for route-id. operationId: PatchTier0StaticRoutes 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' 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 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: CreateOrReplaceTier0StaticRoutes 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/{tier0-id}/flood-protection-profile-bindings/{flood-protection-profile-binding-id}: delete: consumes: - application/json description: |- API will delete Flood Protection Profile Binding for Tier-0 Logical Router. operationId: DeleteTier0FloodProtectionProfileBinding parameters: - in: path name: tier0-id required: true type: string - in: path name: flood-protection-profile-binding-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 Flood Protection Profile Binding for Tier-0 Logical Router tags: - Policy, Security, Security Profiles, Flood Protection Profile Binding x-vmw-nsx-module: PolicyGatewayProfileBinding get: consumes: - application/json description: | API will get Flood Protection Profile Binding Map for Tier-0 Logical Router. operationId: GetTier0FloodProtectionProfileBinding 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 patch: consumes: - application/json description: |- API will create or update Flood Protection profile binding map for Tier-0 Logical Router. operationId: PatchTier0FloodProtectionProfileBindingMap parameters: - in: path name: tier0-id required: true type: string - in: path name: flood-protection-profile-binding-id required: true type: string - in: body name: FloodProtectionProfileBindingMap required: true schema: $ref: '#/definitions/FloodProtectionProfileBindingMap' 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 Binding Map for Tier-0 Logical Router tags: - Policy, Security, Security Profiles, Flood Protection Profile Binding x-vmw-nsx-module: PolicyGatewayProfileBinding put: consumes: - application/json description: |- API will create or update Flood Protection profile binding map for Tier-0 Logical Router. operationId: UpdateTier0FloodProtectionProfileBinding parameters: - in: path name: tier0-id required: true type: string - in: path name: flood-protection-profile-binding-id required: true type: string - in: body name: FloodProtectionProfileBindingMap required: true schema: $ref: '#/definitions/FloodProtectionProfileBindingMap' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/FloodProtectionProfileBindingMap' '400': $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 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} : delete: consumes: - application/json description: |- API will delete Flood Protection Profile Binding for Tier-0 Logical Router LocaleServices. operationId: DeleteTier0LocaleServicesFloodProtectionProfileBinding 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 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 Binding for Tier-0 Logical Router LocaleServices tags: - Policy, Security, Security Profiles, Flood Protection Profile Binding x-vmw-nsx-module: PolicyGatewayProfileBinding get: consumes: - application/json description: | API will get Flood Protection Profile Binding Map for Tier-0 Logical Router LocaleServices. operationId: GetTier0LocaleServicesFloodProtectionProfileBinding 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 patch: consumes: - application/json description: |- API will create or update Flood Protection profile binding map for Tier-0 Logical Router LocaleServices. operationId: PatchTier0LocaleServicesFloodProtectionProfileBindingMap 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 - in: body name: FloodProtectionProfileBindingMap required: true schema: $ref: '#/definitions/FloodProtectionProfileBindingMap' 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 Binding Map for Tier-0 Logical Router LocaleServices tags: - Policy, Security, Security Profiles, Flood Protection Profile Binding x-vmw-nsx-module: PolicyGatewayProfileBinding put: consumes: - application/json description: |- API will create or update Flood Protection profile binding map for Tier-0 Logical Router LocaleServices. operationId: UpdateTier0LocaleServicesFloodProtectionProfileBinding 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 - in: body name: FloodProtectionProfileBindingMap required: true schema: $ref: '#/definitions/FloodProtectionProfileBindingMap' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/FloodProtectionProfileBindingMap' '400': $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 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} : delete: consumes: - application/json description: |- API will delete Session Timer Profile Binding for Tier-0 Logical Router LocaleServices. operationId: DeleteTier0LocaleServicesSessionTimerProfileBinding 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 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 Session Timer Profile Binding for Tier-0 Logical Router LocaleServices tags: - Policy, Security, Security Profiles, Session Timer Profile Binding x-vmw-nsx-module: PolicyGatewayProfileBinding get: consumes: - application/json description: | API will get Session Timer Profile Binding Map for Tier-0 Logical Router LocaleServices. operationId: GetTier0LocaleServicesSessionTimerProfileBinding 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 patch: consumes: - application/json description: |- API will create or update Session Timer profile binding map for Tier-0 Logical Router LocaleServices. operationId: PatchTier0LocalServicesSessionTimerProfileBindingMap 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 - in: body name: SessionTimerProfileBindingMap required: true schema: $ref: '#/definitions/SessionTimerProfileBindingMap' 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 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 put: consumes: - application/json description: |- API will create or update Session Timer profile binding map for Tier-0 Logical Router LocaleServices. operationId: UpdateTier0LocaleServicesSessionTimerProfileBinding 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 - in: body name: SessionTimerProfileBindingMap required: true schema: $ref: '#/definitions/SessionTimerProfileBindingMap' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SessionTimerProfileBindingMap' '400': $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 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}: delete: consumes: - application/json description: |- API will delete Session Timer Profile Binding for Tier-0 Logical Router. operationId: DeleteTier0SessionTimerProfileBinding parameters: - in: path name: tier0-id required: true type: string - in: path name: session-timer-profile-binding-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 Session Timer Profile Binding for Tier-0 Logical Router tags: - Policy, Security, Security Profiles, Session Timer Profile Binding x-vmw-nsx-module: PolicyGatewayProfileBinding get: consumes: - application/json description: | API will get Session Timer Profile Binding Map for Tier-0 Logical Router. operationId: GetTier0SessionTimerProfileBinding 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 patch: consumes: - application/json description: |- API will create or update Session Timer profile binding map for Tier-0 Logical Router. operationId: PatchTier0SessionTimerProfileBindingMap parameters: - in: path name: tier0-id required: true type: string - in: path name: session-timer-profile-binding-id required: true type: string - in: body name: SessionTimerProfileBindingMap required: true schema: $ref: '#/definitions/SessionTimerProfileBindingMap' 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 Session Timer Profile Binding Map for Tier-0 Logical Router tags: - Policy, Security, Security Profiles, Session Timer Profile Binding x-vmw-nsx-module: PolicyGatewayProfileBinding put: consumes: - application/json description: |- API will create or update Session Timer profile binding map for Tier-0 Logical Router. operationId: UpdateTier0SessionTimerProfileBinding parameters: - in: path name: tier0-id required: true type: string - in: path name: session-timer-profile-binding-id required: true type: string - in: body name: SessionTimerProfileBindingMap required: true schema: $ref: '#/definitions/SessionTimerProfileBindingMap' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SessionTimerProfileBindingMap' '400': $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 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: ListTier1 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}: delete: consumes: - application/json description: |- Delete Tier-1 configuration operationId: DeleteTier1 parameters: - in: path name: tier-1-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 Tier-1 configuration tags: - Policy, Networking, Connectivity, Tier-1 Gateways, Tier-1 Gateways x-vmw-nsx-module: PolicyConnectivity get: consumes: - application/json description: |- Read Tier-1 configuration operationId: ReadTier1 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 patch: consumes: - application/json description: | If Tier-1 with the tier-1-id is not already present, create a new Tier-1 instance. If it already exists, update the tier-1 instance with specified attributes. operationId: PatchTier1 parameters: - in: path name: tier-1-id required: true type: string - in: body name: Tier1 required: true schema: $ref: '#/definitions/Tier1' 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 Tier-1 configuration tags: - Policy, Networking, Connectivity, Tier-1 Gateways, Tier-1 Gateways x-vmw-nsx-module: PolicyConnectivity put: consumes: - application/json description: | If Tier-1 with the tier-1-id is not already present, create a new Tier-1 instance. If it already exists, replace the Tier-1 instance with this object. operationId: CreateOrReplaceTier1 parameters: - in: path name: tier-1-id required: true type: string - in: body name: Tier1 required: true schema: $ref: '#/definitions/Tier1' 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: |- Create or update 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}/dns-forwarder: delete: consumes: - application/json description: |- Delete DNS configuration for tier-1 instance operationId: DeletePolicyDnsForwarderOnTier1 parameters: - description: |- Tier-1 ID in: path name: tier-1-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 DNS configuration for tier-1 instance tags: - Policy, Networking, IP Management, DNS, DNS Forwarder, Tier-1 Gateways x-vmw-nsx-module: PolicyDnsForwarder get: consumes: - application/json description: |- Read the DNS Forwarder for the given tier-1 instance operationId: ReadPolicyDnsForwarderOnTier1 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 patch: consumes: - application/json description: |- Create or update the DNS Forwarder operationId: PatchPolicyDnsForwarderOnTier1 parameters: - description: |- Tier-1 ID in: path name: tier-1-id required: true type: string - in: body name: PolicyDnsForwarder required: true schema: $ref: '#/definitions/PolicyDnsForwarder' 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 the DNS Forwarder 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: PerformEPActionForDnsForwarderAtTier1 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 put: consumes: - application/json description: |- Create or update the DNS Forwarder operationId: UpdatePolicyDnsForwarderOnTier1 parameters: - description: |- Tier-1 ID in: path name: tier-1-id required: true type: string - in: body name: PolicyDnsForwarder required: true schema: $ref: '#/definitions/PolicyDnsForwarder' 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: |- Create or update the DNS Forwarder 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: LookupAddressViaTier1DNSForwarder 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: GetTier1DNSForwarderStatistics 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: GetTier1DNSForwarderStatus 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: GetTier1ForwardingTable 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: IPv4 or IPv6 CIDR Block format: ip-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 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: GetTier1ForwardingTableCsv 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: IPv4 or IPv6 CIDR Block format: ip-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 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: ViewTier1GatewayFirewall 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}/locale-services: get: consumes: - application/json description: | Paginated list of all Tier-1 locale-services operationId: ListTier1LocaleServices 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: | Returns ARP proxy table for a tier-1 operationId: GetTier1ArpProxies parameters: - in: path name: tier-1-id required: true type: string - in: path name: locale-service-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/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: GetTier1InterfaceArpProxies 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 - 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/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-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: GetTier1InterfaceArpTable 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: 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: GetTier1InterfaceArpTableCsv 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: 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: GetTier1InterfaceDADState 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: GetTier1InterfaceStatistics 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: GetTier1InterfaceStatisticsSummary 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: ListTier1ServiceInterfaces 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}: delete: consumes: - application/json description: |- Delete Tier 1 service interface operationId: DeleteTier1ServiceInterface 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 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 1 service interface tags: - Policy, Networking, Connectivity, Tier-1 Gateways, Interfaces, Interfaces x-vmw-nsx-module: PolicyConnectivity get: consumes: - application/json description: |- Read Tier 1 service interface operationId: ReadTier1ServiceInterface 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 patch: consumes: - application/json description: | If a Tier1 service interface with the interface-id is not already present, create a new Tier1 service interface. operationId: PatchTier1ServiceInterface 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 - in: body name: ServiceInterface required: true schema: $ref: '#/definitions/ServiceInterface' 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-1 service interface tags: - Policy, Networking, Connectivity, Tier-1 Gateways, Interfaces, Interfaces x-vmw-nsx-module: PolicyConnectivity put: consumes: - application/json description: | If a Tier1 service interface with the interface-id is not already present, create a new Tier1 service interface. Modification of Tier 1 service interface is not allowed. operationId: CreateTier1ServiceInterface 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 - in: body name: ServiceInterface required: true schema: $ref: '#/definitions/ServiceInterface' 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: |- Create a Tier1 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}: delete: consumes: - application/json description: |- Delete Tier-1 locale-services operationId: DeleteTier1LocaleServices parameters: - in: path name: tier-1-id required: true type: string - in: path name: locale-services-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 Tier-1 locale-services tags: - Policy, Networking, Connectivity, Tier-1 Gateways, Tier-1 Locale Services x-vmw-nsx-module: PolicyConnectivity get: consumes: - application/json description: |- Read Tier-1 locale-services operationId: ReadTier1LocaleServices 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 patch: consumes: - application/json description: | If a Tier-1 locale services with the locale-services-id is not already present, create a new locale services. If it already exists, update Tier-1 locale services with specified attributes. operationId: PatchTier1LocaleServices parameters: - in: path name: tier-1-id required: true type: string - in: path name: locale-services-id required: true type: string - in: body name: LocaleServices required: true schema: $ref: '#/definitions/LocaleServices' 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-1 locale-services tags: - Policy, Networking, Connectivity, Tier-1 Gateways, Tier-1 Locale Services x-vmw-nsx-module: PolicyConnectivity put: consumes: - application/json description: | If a Tier-1 locale services with the locale-services-id is not already present, create a new locale-services. If it already exists, replace the Tier-1 locale services instance with the new object. Modifying edge cluster re-allocates NSX service routers of TIER1 to a different edge cluster. You can also place edge nodes manually and provide maximum two indices for HA mode ACTIVE_STANDBY. To re-allocating edge cluster is a disruptive operation and all existing statistics of Tier1 gateway will be removed. operationId: CreateOrReplaceTier1LocaleServices parameters: - in: path name: tier-1-id required: true type: string - in: path name: locale-services-id required: true type: string - in: body name: LocaleServices required: true schema: $ref: '#/definitions/LocaleServices' 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: |- Create or update a 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: ViewTier1LocaleServicesGatewayFirewall 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: ListTier1Interfaces 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}: delete: consumes: - application/json description: |- Delete Tier-1 interface operationId: DeleteTier1Interface 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 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-1 interface tags: - Policy, Networking, Connectivity, Tier-1 Gateways, Interfaces, Interfaces x-vmw-nsx-module: PolicyConnectivity get: consumes: - application/json description: |- Read Tier-1 interface operationId: ReadTier1Interface 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 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: PatchTier1Interface 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 - in: body name: Tier1Interface required: true schema: $ref: '#/definitions/Tier1Interface' 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-1 interface tags: - Policy, Networking, Connectivity, Tier-1 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: CreateOrReplaceTier1Interface 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 - in: body name: Tier1Interface required: true schema: $ref: '#/definitions/Tier1Interface' 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: |- Create or update a 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/statistics: get: consumes: - application/json description: |- List NAT Rules Statistics from Tier-1 denoted by Tier-1 ID. operationId: ListPolicyNatRulesStatisticsFromTier1 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. operationId: ListPolicyNatRules 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}: delete: consumes: - application/json description: |- Delete 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. operationId: DeletePolicyNatRule 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 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 NAT Rule tags: - Policy, Networking, Network Services, NAT, Rules, Tier-1 Gateways x-vmw-nsx-module: PolicyNAT 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. operationId: GetPolicyNatRule 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 patch: consumes: - application/json description: | If a NAT Rule is not already present on Tier-1 denoted by Tier-1 ID, under NAT section denoted by <nat-id>, create a new NAT Rule. If it already exists, update the NAT Rule. 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: PatchPolicyNatRule 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 - in: body name: PolicyNatRule required: true schema: $ref: '#/definitions/PolicyNatRule' 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 Nat Rule tags: - Policy, Networking, Network Services, NAT, Rules, Tier-1 Gateways x-vmw-nsx-module: PolicyNAT put: consumes: - application/json description: |- Update NAT Rule on 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: CreateOrReplacePolicyNatRule 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 - in: body name: PolicyNatRule required: true schema: $ref: '#/definitions/PolicyNatRule' 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: |- Update 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: GetPolicyNatRuleStatisticsFromTier1 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: 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 segments under Tier-1 instance operationId: ListSegments 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/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 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: GetTier1SegmentsByState 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, Segment, State x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}: delete: consumes: - application/json description: |- Delete segment operationId: DeleteSegment parameters: - in: path name: tier-1-id required: true type: string - in: path name: segment-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 segment tags: - Policy, Networking, Connectivity, Segments, Segments (Fixed) x-vmw-nsx-module: PolicyConnectivity get: consumes: - application/json description: |- Read segment operationId: ReadSegment 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 patch: consumes: - application/json description: | If segment with the segment-id is not already present, create a new segment. If it already exists, update the segment with specified attributes. operationId: PatchSegment parameters: - in: path name: tier-1-id required: true type: string - in: path name: segment-id required: true type: string - in: body name: Segment required: true schema: $ref: '#/definitions/Segment' 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 segment tags: - Policy, Networking, Connectivity, Segments, Segments (Fixed) x-vmw-nsx-module: PolicyConnectivity put: consumes: - application/json description: | If segment with the segment-id is not already present, create a new segment. If it already exists, replace the segment with this object. operationId: CreateOrReplaceSegment parameters: - in: path name: tier-1-id required: true type: string - in: path name: segment-id required: true type: string - in: body name: Segment required: true schema: $ref: '#/definitions/Segment' 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: |- Create or update a segment tags: - Policy, Networking, Connectivity, Segments, Segments (Fixed) x-vmw-nsx-module: PolicyConnectivity /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: GetSegmentInterfaceArpTable 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: 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: GetSegmentInterfaceArpTableCsv 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: 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}/dhcp-static-binding-configs: get: consumes: - application/json description: | Paginated list of all DHCP static binding instances operationId: ListSegmentDhcpStaticBinding 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}: delete: consumes: - application/json description: |- Delete DHCP static binding operationId: DeleteSegmentDhcpStaticBinding 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 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 DHCP static binding tags: - Policy, Networking, IP Management, DHCP, DHCP Static Bindings, Segments Bindings (Fixed) x-vmw-nsx-module: PolicyConnectivity get: consumes: - application/json description: |- Read DHCP static binding operationId: ReadSegmentDhcpStaticBinding 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 patch: consumes: - application/json description: | If binding with the binding-id is not already present, create a new DHCP static binding instance. If it already exists, replace the existing DHCP static binding instance with specified attributes. operationId: PatchSegmentDhcpStaticBinding 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 - in: body name: DhcpStaticBindingConfig required: true schema: $ref: '#/definitions/DhcpStaticBindingConfig' 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 DHCP static binding tags: - Policy, Networking, IP Management, DHCP, DHCP Static Bindings, Segments Bindings (Fixed) x-vmw-nsx-module: PolicyConnectivity put: consumes: - application/json description: | If binding with the binding-id is not already present, create a new DHCP static binding instance. If it already exists, replace the existing DHCP static binding instance with this object. operationId: CreateOrReplaceSegmentDhcpStaticBinding 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 - in: body name: DhcpStaticBindingConfig required: true schema: $ref: '#/definitions/DhcpStaticBindingConfig' 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: |- Create or update 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: ReadSegmentDhcpStaticBindingState 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: | Segment ID is the ID of the segment that is connected to the the tier-1 operationId: GetDownlinkPortArpTableForTier1Segment 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: 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: | Segment ID is the ID of the segment that is connected to the the tier-1 operationId: GetDownlinkPortArpTableForTier1SegmentInCsv 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: 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: GetDownlinkPortDadStateForTier1Segment 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: GetDownlinkPortStatisticsForTier1Segment 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: 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: GetDownlinkPortStatisticsSummaryForTier1Segment 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: GetSegmentCsSpanInfo 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: - Policy, Networking, Connectivity, Segment, Intersite-Forwarder 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: GetSegmentCsTrafficStats 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: - Policy, Networking, Connectivity, Segment, Intersite-Forwarder 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: GetTier1SegmentMacTable 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, Segment, 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: GetTier1SegmentMacTableInCsv 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, Segment, 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: ListTier1SegmentPorts 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}: get: consumes: - application/json description: | Get detail information on a Tier-1 segment port by giving ID. operationId: GetTier1SegmentPort 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 /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: GetTier1SegmentPortMacTable 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, Segment, 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: GetTier1SegmentPortMacTableInCsv 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, Segment, 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: ListPortDiscoveryBindings 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} : get: consumes: - application/json description: | API will get Port Discovery Profile Binding Map operationId: GetPortDiscoveryBinding 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 /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: ListPortMonitoringBindings 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} : get: consumes: - application/json description: | API will get Port Monitoring Profile Binding Map. operationId: GetPortMonitoringBinding 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 ? /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: GetPortMonitoringBindingMirrorStackStatus 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, Segment, 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: ListPortQoSBindings 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} : get: consumes: - application/json description: | API will get Port QoS Profile Binding Map. operationId: GetPortQoSBinding 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 /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: ListPortSecurityProfileBindings 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} : 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: GetPortSecurityProfileBinding 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 /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: GetTier1SegmentPortState 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, Segment, 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: ListSegmentDiscoveryBindings 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} : delete: consumes: - application/json description: |- API will delete Segment Discovery Profile Binding Profile operationId: DeleteSegmentDiscoveryBinding 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 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 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 Segment Discovery Profile Binding Map operationId: GetSegmentDiscoveryBinding 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 patch: consumes: - application/json description: |- API will create Segment Discovery Profile Binding Map. For objects with no binding maps, default profile is applied. operationId: PatchSegmentDiscoveryBinding 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 - in: body name: SegmentDiscoveryProfileBindingMap required: true schema: $ref: '#/definitions/SegmentDiscoveryProfileBindingMap' 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 Segment 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 Segment Discovery Profile Binding Map. For objects with no binding maps, default profile is applied. operationId: UpdateSegmentDiscoveryBinding 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 - in: body name: SegmentDiscoveryProfileBindingMap required: true schema: $ref: '#/definitions/SegmentDiscoveryProfileBindingMap' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentDiscoveryProfileBindingMap' '400': $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 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: ListSegmentMonitoringBindings 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} : delete: consumes: - application/json description: |- API will delete Segment Monitoring Profile Binding Profile. operationId: DeleteSegmentMonitoringBinding 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 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 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 Segment Monitoring Profile Binding Map. operationId: GetSegmentMonitoringBinding 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 patch: consumes: - application/json description: |- API will create segment monitoring profile binding map. operationId: PatchSegmentMonitoringBinding 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 - in: body name: SegmentMonitoringProfileBindingMap required: true schema: $ref: '#/definitions/SegmentMonitoringProfileBindingMap' 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 Segment 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 Segment Monitoring Profile Binding Map. operationId: UpdateSegmentMonitoringBinding 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 - in: body name: SegmentMonitoringProfileBindingMap required: true schema: $ref: '#/definitions/SegmentMonitoringProfileBindingMap' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentMonitoringProfileBindingMap' '400': $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 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: GetSegmentMonitoringBindingMirrorStackStatus 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, Segment, 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: ListSegmentQoSBindings 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} : delete: consumes: - application/json description: |- API will delete Segment QoS Profile Binding Profile. operationId: DeleteSegmentQoSBinding 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 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 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 Segment QoS Profile Binding Map. operationId: GetSegmentQoSBinding 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 patch: consumes: - application/json description: |- API will create segment QoS profile binding map. For objects with no binding maps, default profile is applied. operationId: PatchSegmentQoSBinding 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 - in: body name: SegmentQoSProfileBindingMap required: true schema: $ref: '#/definitions/SegmentQoSProfileBindingMap' 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 Segment 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 Segment QoS Profile Binding Map. For objects with no binding maps, default profile is applied. operationId: UpdateSegmentQoSBinding 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 - in: body name: SegmentQoSProfileBindingMap required: true schema: $ref: '#/definitions/SegmentQoSProfileBindingMap' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentQoSProfileBindingMap' '400': $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 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: ListSegmentSecurityProfileBindings 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} : delete: consumes: - application/json description: | API will delete segment security profile binding map. operationId: DeleteSegmentSecurityProfileBinding 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 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 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 segment security profile binding map. If the binding map does not exist, it will return 404. operationId: GetSegmentSecurityProfileBinding 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 patch: consumes: - application/json description: | Create a new segment security profile binding map if the given security profile binding map does not exist. Otherwise, patch the existing segment security profile binding map. For objects with no binding maps, default profile is applied. operationId: PatchSegmentSecurityProfileBinding 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 - in: body name: SegmentSecurityProfileBindingMap required: true schema: $ref: '#/definitions/SegmentSecurityProfileBindingMap' 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 binding map tags: - Policy, Networking, Connectivity, Segments, Segment Profiles, Security Profile Binding x-vmw-nsx-module: PolicySecurityProfileBinding put: consumes: - application/json description: | API will create or replace segment security profile binding map. For objects with no binding maps, default profile is applied. operationId: CreateOrUpdateSegmentSecurityProfileBinding 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 - in: body name: SegmentSecurityProfileBindingMap required: true schema: $ref: '#/definitions/SegmentSecurityProfileBindingMap' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SegmentSecurityProfileBindingMap' '400': $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 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: delete: consumes: - application/json description: |- Delete static ARP config operationId: DeleteStaticARPConfig parameters: - in: path name: tier-1-id required: true type: string - in: path name: segment-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 static ARP config tags: - Policy, Networking, Connectivity, Segments, Segments (Fixed) x-vmw-nsx-module: PolicyConnectivity get: consumes: - application/json description: |- Read static ARP config operationId: ReadStaticARPConfig 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 patch: consumes: - application/json description: | Create static ARP config with Tier-1 and segment IDs provided if it doesn't exist, update with provided config if it's already created. operationId: PatchStaticARPConfig parameters: - in: path name: tier-1-id required: true type: string - in: path name: segment-id required: true type: string - in: body name: StaticARPConfig required: true schema: $ref: '#/definitions/StaticARPConfig' 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 static ARP config tags: - Policy, Networking, Connectivity, Segments, Segments (Fixed) x-vmw-nsx-module: PolicyConnectivity put: consumes: - application/json description: | Create static ARP config with Tier-1 and segment IDs provided if it doesn't exist, update with provided config if it's already created. operationId: CreateOrReplaceStaticARPConfig parameters: - in: path name: tier-1-id required: true type: string - in: path name: segment-id required: true type: string - in: body name: StaticARPConfig required: true schema: $ref: '#/definitions/StaticARPConfig' 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: |- Create or update a 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: GetTier1SegmentTepTable 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, Segment, 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: GetTier1SegmentTepTableInCsv 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, Segment, Tep Table x-vmw-nsx-module: PolicyConnectivityStatistics /global-infra/tier-1s/{tier-1-id}/segments/{segment-id}?force=true: delete: consumes: - application/json description: | Force delete bypasses validations during segment deletion. This may result in an inconsistent connectivity. operationId: ForceDeleteSegmentTrue parameters: - in: path name: tier-1-id required: true type: string - in: path name: segment-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: |- Force delete segment tags: - Policy, Networking, Connectivity, Segments, Segments (Fixed) x-vmw-nsx-module: PolicyConnectivity /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: GetSegmentPortStatistics 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}/state: get: consumes: - application/json description: | Get tier1 segment state information. operationId: GetSegmentState 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: GetSegmentStatistics 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: GetTier1State 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 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: ListTier1StaticRoutes 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}: delete: consumes: - application/json description: |- Delete Tier-1 static routes operationId: DeleteTier1StaticRoutes parameters: - in: path name: tier-1-id required: true type: string - in: path name: route-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 Tier-1 static routes tags: - Policy, Networking, Connectivity, Tier-1 Gateways, Routing, Static Routes x-vmw-nsx-module: PolicyConnectivity get: consumes: - application/json description: |- Read Tier-1 static routes operationId: ReadTier1StaticRoutes 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 patch: consumes: - application/json description: | If static routes for route-id are not already present, create static routes. If it already exists, update static routes for route-id. operationId: PatchTier1StaticRoutes parameters: - in: path name: tier-1-id required: true type: string - in: path name: route-id required: true type: string - in: body name: StaticRoutes required: true schema: $ref: '#/definitions/StaticRoutes' 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-1 static routes tags: - Policy, Networking, Connectivity, Tier-1 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: CreateOrReplaceTier1StaticRoutes parameters: - in: path name: tier-1-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-1 static routes tags: - Policy, Networking, Connectivity, Tier-1 Gateways, Routing, Static Routes x-vmw-nsx-module: PolicyConnectivity /global-infra/tier-1s/{tier1-id}/flood-protection-profile-bindings/{flood-protection-profile-binding-id}: delete: consumes: - application/json description: |- API will delete Flood Protection Profile Binding for Tier-1 Logical Router. operationId: DeleteTier1FloodProtectionProfileBinding parameters: - in: path name: tier1-id required: true type: string - in: path name: flood-protection-profile-binding-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 Flood Protection Profile Binding for Tier-1 Logical Router tags: - Policy, Security, Security Profiles, Flood Protection Profile Binding x-vmw-nsx-module: PolicyGatewayProfileBinding get: consumes: - application/json description: | API will get Flood Protection Profile Binding Map for Tier-1 Logical Router. operationId: GetTier1FloodProtectionProfileBinding 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 patch: consumes: - application/json description: |- API will create or update Flood Protection profile binding map for Tier-1 Logical Router. operationId: PatchTier1FloodProtectionProfileBindingMap parameters: - in: path name: tier1-id required: true type: string - in: path name: flood-protection-profile-binding-id required: true type: string - in: body name: FloodProtectionProfileBindingMap required: true schema: $ref: '#/definitions/FloodProtectionProfileBindingMap' 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 Binding Map for Tier-1 Logical Router tags: - Policy, Security, Security Profiles, Flood Protection Profile Binding x-vmw-nsx-module: PolicyGatewayProfileBinding put: consumes: - application/json description: |- API will create or update Flood Protection profile binding map for Tier-1 Logical Router. operationId: UpdateTier1FloodProtectionProfileBinding parameters: - in: path name: tier1-id required: true type: string - in: path name: flood-protection-profile-binding-id required: true type: string - in: body name: FloodProtectionProfileBindingMap required: true schema: $ref: '#/definitions/FloodProtectionProfileBindingMap' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/FloodProtectionProfileBindingMap' '400': $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 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} : delete: consumes: - application/json description: |- API will delete Flood Protection Profile Binding for Tier-1 Logical Router LocaleServices. operationId: DeleteTier1LocaleServicesFloodProtectionProfileBinding 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 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 Binding for Tier-1 Logical Router LocaleServices tags: - Policy, Security, Security Profiles, Flood Protection Profile Binding x-vmw-nsx-module: PolicyGatewayProfileBinding get: consumes: - application/json description: | API will get Flood Protection Profile Binding Map for Tier-1 Logical Router LocaleServices. operationId: GetTier1LocaleServicesFloodProtectionProfileBinding 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 patch: consumes: - application/json description: |- API will create or update Flood Protection profile binding map for Tier-1 Logical Router LocaleServices. operationId: PatchTier1LocaleServicesFloodProtectionProfileBindingMap 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 - in: body name: FloodProtectionProfileBindingMap required: true schema: $ref: '#/definitions/FloodProtectionProfileBindingMap' 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 Binding Map for Tier-1 Logical Router LocaleServices tags: - Policy, Security, Security Profiles, Flood Protection Profile Binding x-vmw-nsx-module: PolicyGatewayProfileBinding put: consumes: - application/json description: |- API will create or update Flood Protection profile binding map for Tier-1 Logical Router LocaleServices. operationId: UpdateTier1LocaleServicesFloodProtectionProfileBinding 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 - in: body name: FloodProtectionProfileBindingMap required: true schema: $ref: '#/definitions/FloodProtectionProfileBindingMap' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/FloodProtectionProfileBindingMap' '400': $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 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} : delete: consumes: - application/json description: |- API will delete Session Timer Profile Binding for Tier-1 Logical Router LocaleServices. operationId: DeleteTier1LocaleServicesSessionTimerProfileBinding 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 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 Session Timer Profile Binding for Tier-1 Logical Router LocaleServices tags: - Policy, Security, Security Profiles, Session Timer Profile Binding x-vmw-nsx-module: PolicyGatewayProfileBinding get: consumes: - application/json description: | API will get Session Timer Profile Binding Map for Tier-1 Logical Router LocaleServices. operationId: GetTier1LocaleServicesSessionTimerProfileBinding 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 patch: consumes: - application/json description: |- API will create or update Session Timer profile binding map for Tier-1 Logical Router LocaleServices. operationId: PatchTier1LocaleServicesSessionTimerProfileBindingMap 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 - in: body name: SessionTimerProfileBindingMap required: true schema: $ref: '#/definitions/SessionTimerProfileBindingMap' 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 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 put: consumes: - application/json description: |- API will create or update Session Timer profile binding map for Tier-1 Logical Router LocaleServices. operationId: UpdateTier1LocaleServicesSessionTimerProfileBinding 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 - in: body name: SessionTimerProfileBindingMap required: true schema: $ref: '#/definitions/SessionTimerProfileBindingMap' produces: - application/json responses: '200': description: OK schema: $ref: '#/definitions/SessionTimerProfileBindingMap' '400': $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 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}: delete: consumes: - application/json description: |- API will delete Session Timer Profile Binding for Tier-1 Logical Router. operationId: DeleteTier1SessionTimerProfileBinding parameters: - in: path name: tier1-id required: true type: string - in: path name: session-timer-profile-binding-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 Session Timer Profile Binding for Tier-1 Logical Router tags: - Policy, Security, Security Profiles, Session Timer Profile Binding x-vmw-nsx-module: PolicyGatewayProfileBinding get: consumes: - application/json description: | API will get Session Timer Profile Binding Map for Tier-1 Logical Router. operationId: GetTier1SessionTimerProfileBinding 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 patch: consumes: - application/json description: |- API will create or update Session Timer profile binding map for Tier-1 Logical Router. operationId: PatchTier1SessionTimerProfileBindingMap parameters: - in: path name: tier1-id required: true type: string - in: path name: session-timer-profile-binding-id required: true type: string - in: body name: SessionTimerProfileBindingMap required: true schema: $ref: '#/definitions/SessionTimerProfileBindingMap' 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 Session Timer Profile Binding Map for Tier-1 Logical Router tags: - Policy, Security, Security Profiles, Session Timer Profile Binding x-vmw-nsx-module: PolicyGatewayProfileBinding put: consumes: - application/json description: |- API will create or update Session Timer profile binding map for Tier-1 Logical