Created
December 10, 2019 19:06
-
-
Save karatechops/54131342b6b553d0947eae71f6d986cb to your computer and use it in GitHub Desktop.
This file has been truncated, but you can view the full file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| {"info": {"description": "<div>\n Looking for product information? <a href=\"http://www.hpe.com\" target=\"_blank\">Visit hpe.com</a>\n</div>\n\n<div>\n Working on a project and need a copy of the OpenAPI schema? <a href=\"/api/v1/openapi\" target=\"_blank\">View/download it here</a>\n</div>\n\n<div>\n Having trouble with the API explorer?\n <ul>\n <li>For live assistance, go to the <a href=\"http://www.hpe.com/assistance\">Contact Hewlett Packard Enterprise Worldwide</a> website</li>\n <li>To access documentation and support services, go to the <a href=\"http://www.hpe.com/support/hpesc\">Hewlett Packard Enterprise Support Center</a> website</li>\n </ul>\n</div>\n\n<h4 class=\"opblock-tag\" id=\"_doc_api_authentication\">API Authentication</h4>\n\n<div id=\"api_login_auto\">\n This session is using the API token from the Composable Fabric Manager UI.\n Proceed with any API call!\n</div>\n\n<div id=\"api_login_manual\">\n To begin using this API explorer, you'll first need to obtain an API key:\n <ul>\n <li>Navigate to <a href=\"#/auth/getApiKey\" target=\"_blank\">POST /auth/token</a> (this link opens a new window)</li>\n <li>Click <span class=\"noformat\">Try it out</span></li>\n <li>\n To specify credentials, set the values of the following header parameters:\n <ul>\n <li>\n <span class=\"noformat\">X-Auth-Username</span>: your Composable Fabric Manager account user name\n </li>\n <li>\n <span class=\"noformat\">X-Auth-Password</span>: your Composable Fabric Manager account password\n </li>\n <li>\n <strong>NOTE:</strong> Users which are mapped to authentication sources of type <span class=\"noformat\">pki</span> do not need to include these\n headers. If they are included with a request which uses a verifiable client certificate which successfully authenticates the\n API user, these headers will simply be ignored.\n <br />\n If a client certificate is supplied which is either not verifiable or does not map to a valid API user, then the above\n headers will be used (if they are supplied) as a fallback mechanism.\n </li>\n </ul>\n </li>\n <li>Click <span class=\"noformat\">Execute</span></li>\n <li>\n In the response body section, copy the value of \"result\" (without quotes) to the clipboard. <br />\n This is your API key. By default, it is valid for 30 minutes.\n </li>\n <li>Click the \"Authorize\" button below (to the right of the \"schemes\" dropdown)</li>\n <li>Paste the API key into the text box (without quotes or other formatting)</li>\n <li>Click \"authorize\" to save the API key in the Swagger UI. Note that this does not validate the token for\n copy/paste or other typographical errors</li>\n <li>You may now use the API Explorer to make live API calls to Composable Fabric Manager</li>\n </ul>\n</div>\n\n<h4 class=\"opblock-tag\" id=\"_doc_api_versions\">API Versions</h4>\n\nThere are two ways to specify the Composable Fabric Manager API version in your requests:\n\n<ul>\n <li>\n <p>HTTP request header. For example, to request API version 1:</p>\n <p><span class=\"noformat\">Accept: application/json; version=1</span></p>\n </li>\n <li>\n <p>URL path. For example, to request API version 1:</p>\n <p><span class=\"noformat\">https://fabricmanager.example.com/api/v1</span></p>\n </li>\n</ul>\n\n<h4 class=\"opblock-tag\" id=\"_doc_auto_token_refresh\">Automatic token refresh</h4>\n\n<div>\n <ul>\n <li>\n Pass the <span class=\"noformat\">X-Auth-Refresh-Token</span> header with a value of\n <span class=\"noformat\">true</span> to automatically refresh (reset the expiration time)\n of the token used in the request\n </li>\n <li>\n See <a href=\"#/auth/getApiKey\" target=\"_blank\">POST /auth/token</a> for more details\n </li>\n </ul>\n</div>\n<h4 class=\"opblock-tag\" id=\"_doc_generic_responses\">Generic Responses</h4>\n<p>\n Unless specifically noted in the documentation for a given API call, the following responses\n can be returned:\n</p>\n<ul>\n <li>\n <p>\n <span class=\"noformat\">401 Unauthorized</span> response occurs when any of these\n conditions are present:\n </p>\n <ul>\n <li>\n User did not supply a token in the <span class=\"noformat\">Authorization</span>\n header <strong>OR</strong>\n </li>\n <li>User supplied an unknown token <strong>OR</strong></li>\n <li>User supplied expired token</li>\n <li>PKI User supplied a valid token created by a user which does not map to the client certificate supplied in the request</li>\n <li>PKI User supplied a valid token without supplying a client certificate</li>\n </ul>\n </li>\n <li>\n <p>\n <span class=\"noformat\">404 Not Found</span> response occurs when both:\n </p>\n <ul>\n <li>The API version is not specified in the request header <strong>and</strong></li>\n <li>The API version is not found in the URL</li>\n </ul>\n </li>\n <li>\n <p>\n <span class=\"noformat\">415 Unsupported Media Type</span> response occurs when any of\n these conditions are present:\n </p>\n <ul>\n <li>\n The <span class=\"noformat\">Content-Type</span> header is missing from the request\n <strong>OR</strong>\n </li>\n <li>\n The <span class=\"noformat\">Content-Type</span> header has a value other than\n <span class=\"noformat\">application/json</span>\n </li>\n </ul>\n </li>\n</ul>\n<h4 class=\"opblock-tag\" id=\"_doc_status_cache_build\">\n HTTP 202 \"Cache build in progress\" Responses\n</h4>\n<p>\n The Composable Fabric Manager platform operates in an \"eventual consistency\" model with respect to the\n data that it ingests from external systems it integrates with.\n</p>\n<p>\n The following conditions\n precipitate the <span class=\"noformat\">HTTP 202</span> response for select endpoints:\n</p>\n<ul>\n <li>Composable Fabric Manager has been initially deployed in a new environment</li>\n <li>Composable Fabric Manager has recently been upgraded</li>\n <li>\n A Composable Fabric Manager sensor has been explicitly restarted as a result of a reboot or other\n maintenance activity\n </li>\n</ul>\n<p>\n This response indicates that Composable Fabric Manager is in the process if achieving consistency with one\n or more external systems.\n</p>\n<p>\n In order to present the most accurate data possible, this response is\n used to alert clients to retry their request again. Due to the varying nature of the\n amount of time it takes to achieve such consistency (primarily the external system data set\n size), clients should retry (with a reasonable interval) until an\n <span class=\"noformat\">HTTP 200</span> response is received.\n</p>\n<p>\n The endpoints which are subject to this condition are explicitly documented with the\n <span class=\"noformat\">HTTP 202</span> response code in their respective schemas. See\n <a href=\"#/hosts\" target=\"_blank\">GET /api/v1/hosts</a> for an example.\n <!-- broken due to docExpansion: \"none\" in swagger UI init-->\n <!--<a href=\"#/hosts/listHosts\" target=\"_blank\">GET /api/v1/hosts</a> for an example.-->\n</p>\n<p>\n If a seemingly unreasonable amount of time passes before an\n <span class=\"noformat\">HTTP 200</span> response is received, or a\n given request always returns <span class=\"noformat\">HTTP 202</span>, please contact Support.\n</p>\n\n<!--\n\nWork in progress. Need to figure out how to toggle the various code samples. Maybe I'll just make a tabbed\ncontent section where a user can select a language by tab. Still have to figure out some onClick-like handler\ngiven React seemingly blocks traditional event handlers.\n\n<h3>API interaction examples</h3>\n<div>\n Here are some code snippets in various native programming languages you can use as a starting point for interacting\n with the Composable Fabric Manager API:\n</div>\n<div>\n <button onClick=\"document.getElementById('api_example_python').style.display = 'inherit';\">Python</button>\n <div id=\"api_example_python\">\n <pre>\nimport requests\nsession = requests.Session()\n# blah\n </pre>\n </div>\n</div>\n\n<div>\n <button>Java</button>\n</div>\n\n<div>\n <button>Perl</button>\n</div>\n\n<div>\n <button>Erlang</button>\n</div>\n\n<div>\n <button>Golang</button>\n</div>\n\n-->\n\n<!--\n<h3>API client tools</h3>\n<div>\n Links to github repos with SDKs / libraries / auto-generated client libs will live here.\n</div>\n-->"}, "paths": {"/acls": {"post": {"description": "", "parameters": [{"description": "ACL Create", "schema": {"$ref": "#/definitions/acl_create"}, "name": "body", "in": "body"}], "produces": ["application/json; version=1.0"], "tags": ["acls"], "summary": "Create an ACL", "consumes": ["application/json"], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/CreationWithIdResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}, "delete": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "ACL Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"collectionFormat": "csv", "items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "description": "Delete the ACL objects for the given list of ACL UUIDs.\n* Note that while the data type is `Array[string]`, the parameter value constructed by clients must be a string representation: a comma-separated list of UUIDs.\n* Limiting the value of this parameter to one UUID is also valid.", "required": false, "in": "query", "type": "array", "name": "acls"}], "tags": ["acls"], "produces": ["application/json; version=1.0"], "operationId": "deleteAcls", "consumes": ["application/json"], "summary": "Delete certain ACLs"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/acl_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "Include ACL scope objects.", "required": false, "in": "query", "x-param=conflicts-with": ["count_only"], "type": "boolean", "name": "scope"}, {"description": "Include ACL qualifier objects.", "required": false, "in": "query", "x-param=conflicts-with": ["count_only"], "type": "boolean", "name": "qualifiers"}, {"description": "Include ACL output action port/LAG objects.", "required": false, "in": "query", "x-param=conflicts-with": ["count_only"], "type": "boolean", "name": "output_interfaces"}, {"description": "Return only the count of ACL objects in the result property of the response.", "x-param-conflicts-with": ["scope, qualifiers"], "required": false, "in": "query", "type": "boolean", "name": "count_only"}, {"description": "Return the array of ACL objects contained in the given page number.", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of ACL objects of the given size.", "required": false, "type": "integer", "name": "page_size", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["acls"], "summary": "Get ACLs", "operationId": "getAcls"}}, "/acls/{uuid}": {"put": {"description": "", "parameters": [{"in": "path", "description": "UUID of ACL object to update", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"description": "ACL Update", "schema": {"$ref": "#/definitions/acl_update"}, "name": "body", "in": "body"}], "produces": ["application/json; version=1.0"], "tags": ["acls"], "summary": "Update an ACL", "consumes": ["application/json"], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "ACL Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}, "delete": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "ACL Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of the ACL to delete", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "tags": ["acls"], "produces": ["application/json; version=1.0"], "operationId": "deleteAcl", "consumes": ["application/json"], "summary": "Delete certain ACL"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/acl_response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of the ACL to get", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"description": "Include ACL scope objects.", "required": false, "type": "boolean", "name": "scope", "in": "query"}, {"description": "Include ACL qualifier objects.", "required": false, "type": "boolean", "name": "qualifiers", "in": "query"}, {"description": "Include ACL output action port/LAG objects.", "required": false, "type": "boolean", "name": "output_interfaces", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["acls"], "summary": "Get an ACL", "operationId": "getAcl"}}, "/affinities": {"post": {"responses": {"200": {"description": "affinity added successfully", "schema": {"$ref": "#/definitions/CreationWithIdResponse"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "The UUID of a successfully added affinity will be returned.", "parameters": [{"description": "affinity object.", "schema": {"$ref": "#/definitions/affinity_create"}, "name": "body", "in": "body"}], "tags": ["affinities"], "produces": ["application/json; version=1.0"], "operationId": "addAffinity", "consumes": ["application/json"], "summary": "Add a new affinity object"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/affinity_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Retrieve an array of affinity objects", "parameters": [{"description": "Return affinities that match the fabric uuid", "required": false, "type": "string", "name": "fabric_uuid", "in": "query"}, {"description": "Return only the count of Affinity objects in the `result` property of the response.", "required": false, "type": "boolean", "name": "count_only", "in": "query"}, {"description": "Return the array of Affinity objects contained in the given page number.", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of Affinity objects of the given size.", "required": false, "type": "integer", "name": "page_size", "in": "query"}, {"description": "Include related tag list as a property of each object in the response body", "required": false, "type": "boolean", "name": "tags", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["affinities"], "summary": "Get an array of affinity objects", "operationId": "listAffinities"}}, "/affinities/{uuid}": {"put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/affinity_response"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Update an affinity object by its UUID.", "parameters": [{"in": "path", "description": "UUID of affinity object to update", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"schema": {"$ref": "#/definitions/affinity_update"}, "description": "affinity.", "required": true, "name": "body", "in": "body"}], "produces": ["application/json; version=1.0"], "tags": ["affinities"], "summary": "Update an affinity by UUID", "operationId": "updateAffinity"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/affinity_response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Retrieve an affinity object by its UUID.", "parameters": [{"in": "path", "description": "UUID of affinity object to return", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["affinities"], "summary": "Get an affinity by UUID", "operationId": "getAffinity"}, "delete": {"responses": {"200": {"description": "affinity deleted successfully", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Deletes a single provisioned affinity object.", "parameters": [{"in": "path", "description": "UUID of affinity to delete", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["affinities"], "summary": "Delete a affinity by UUID", "operationId": "deleteAffinity"}}, "/audits": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/audit_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "Return an array of audit objects of the given size. Default page_size is 1000. If page_size is greater than 1000, the maximum number of audit objects returned will be1000.", "x-param-conflicts-with": ["count_only"], "required": false, "in": "query", "type": "integer", "name": "page_size"}, {"enum": ["ALARM", "EVENT"], "description": "Type of records to return.", "required": false, "in": "query", "type": "string", "name": "record_type"}, {"description": "Return only the count of audit objects in the `result` property of the response.", "x-param-conflicts-with": ["page_size", "after", "before"], "required": false, "in": "query", "type": "boolean", "name": "count_only"}, {"in": "query", "description": "Returns an array of audit objects that have occurred since the audit object associated with the UUID.", "minLength": 32, "required": false, "maxLength": 36, "type": "string", "name": "after"}, {"in": "query", "description": "Returns an array of audit objects that occurred before the audit object associated with the UUID.", "minLength": 32, "required": false, "maxLength": 36, "type": "string", "name": "before"}], "produces": ["application/json; version=1.0"], "tags": ["audits"], "summary": "Get list of Audit Log objects in order from most recent to least recent.", "operationId": "listAudits"}}, "/audits/{uuid}": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/audit_response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of Audit Log to return", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["audits"], "summary": "Get an Audit Log by UUID", "operationId": "getAuditByUuid"}}, "/auth/password_policy": {"put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/password_policy_response"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Update the system password policy.", "parameters": [{"schema": {"$ref": "#/definitions/password_policy"}, "description": "Password policy.", "required": true, "name": "body", "in": "body"}], "produces": ["application/json; version=1.0"], "tags": ["auth"], "summary": "Update the system password policy", "operationId": "updatePasswordPolicy"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/password_policy_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "produces": ["application/json; version=1.0"], "description": "Retrieve the system password policy.", "tags": ["auth"], "summary": "Get the system password policy", "operationId": "getPasswordPolicy"}}, "/auth/sources": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/auth_source_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"enum": ["local", "ldap", "pki"], "description": "Return only authentication sources of the given type.", "required": false, "in": "query", "type": "string", "name": "type"}, {"description": "Return only authentication sources matching the given name (list with one object).", "required": false, "type": "string", "name": "name", "in": "query"}, {"in": "query", "description": "Return the LDAP objects used by the fabric with the given UUID", "minLength": 32, "required": false, "maxLength": 36, "type": "string", "name": "fabric"}, {"in": "query", "description": "Return the LDAP objects used by the switch with the given UUID", "minLength": 32, "required": false, "maxLength": 36, "type": "string", "name": "switch"}], "produces": ["application/json; version=1.0"], "tags": ["auth_sources"], "summary": "Get an array of authentication sources", "operationId": "listAuthSources"}}, "/auth/sources/ldap": {"post": {"responses": {"200": {"description": "Authentication Source (LDAP) Added Successfully", "schema": {"$ref": "#/definitions/CreationWithIdResponse"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"schema": {"$ref": "#/definitions/auth_source_ldap_create"}, "description": "Authentication Source (LDAP)", "required": true, "name": "body", "in": "body"}, {"description": "When true, only verifies the TCP connection to the LDAP server using the given configuration and does not create the LDAP authentication source. When false or omitted, the LDAP authentication source will be created (if it is valid).\nOnly applicable to management software.", "required": false, "type": "boolean", "name": "verify_only", "in": "query"}], "tags": ["auth_sources"], "produces": ["application/json; version=1.0"], "operationId": "createLdapSource", "consumes": ["application/json"], "summary": "Add a new LDAP authentication source"}}, "/auth/sources/ldap/{uuid}": {"put": {"responses": {"200": {"description": "Authentication Source (LDAP) Updated Successfully", "schema": {"$ref": "#/definitions/CreationWithIdResponse"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"schema": {"$ref": "#/definitions/auth_source_ldap_update"}, "description": "Authentication Source (LDAP)", "required": true, "name": "body", "in": "body"}, {"in": "path", "description": "UUID of Authentication Source to update", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "tags": ["auth_sources"], "produces": ["application/json; version=1.0"], "operationId": "updateAuthSourceLdap", "consumes": ["application/json"], "summary": "Update a LDAP authentication source by UUID"}}, "/auth/sources/ldap/{uuid}/verify": {"post": {"responses": {"200": {"description": "Connection Verification Succeeded", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid UUID or Connection Verification Failed", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Only applicable to management software.", "parameters": [{"in": "path", "description": "UUID of Authentication Source to verify", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"required": true, "type": "string", "name": "Content-Type", "enum": ["application/json"], "in": "header"}], "tags": ["auth_sources"], "produces": ["application/json; version=1.0"], "operationId": "verifyAuthSourceLdap", "consumes": ["application/json"], "summary": "Verify an existing LDAP authentication source by UUID"}}, "/auth/sources/pki": {"post": {"responses": {"200": {"description": "Authentication Source (PKI) Added Successfully", "schema": {"$ref": "#/definitions/CreationWithIdResponse"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"schema": {"$ref": "#/definitions/auth_source_pki_create"}, "description": "Authentication Source (PKI)", "required": true, "name": "body", "in": "body"}, {"description": "When true, only verifies the trusted certificate list and does not create the PKI authentication source. When false or omitted, the PKI authentication source will be created (if it is valid).", "required": false, "type": "boolean", "name": "verify_only", "in": "query"}], "tags": ["auth_sources"], "produces": ["application/json; version=1.0"], "operationId": "createPkiSource", "consumes": ["application/json"], "summary": "Add a new PKI authentication source"}}, "/auth/sources/pki/{uuid}": {"put": {"responses": {"200": {"description": "Authentication Source (PKI) Updated Successfully", "schema": {"$ref": "#/definitions/CreationWithIdResponse"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"schema": {"$ref": "#/definitions/auth_source_pki_update"}, "description": "Authentication Source (PKI)", "required": true, "name": "body", "in": "body"}, {"in": "path", "description": "UUID of Authentication Source to update", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "tags": ["auth_sources"], "produces": ["application/json; version=1.0"], "operationId": "updateAuthSourcePki", "consumes": ["application/json"], "summary": "Update a PKI authentication source by UUID"}}, "/auth/sources/pki/{uuid}/verify": {"post": {"responses": {"200": {"description": "Verification Succeeded", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid UUID or Verification Failed", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of Authentication Source to verify", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"required": true, "type": "string", "name": "Content-Type", "enum": ["application/json"], "in": "header"}], "tags": ["auth_sources"], "produces": ["application/json; version=1.0"], "operationId": "verifyAuthSourcePki", "consumes": ["application/json"], "summary": "Verify an existing PKI authentication source by UUID"}}, "/auth/sources/{uuid}": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/auth_source_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of Authentication Source to retrieve", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["auth_sources"], "summary": "Get an authentication source by UUID", "operationId": "getAuthSourceByUuid"}, "delete": {"responses": {"200": {"description": "Authentication Source Deleted Successfully", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Username Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "* Deleting an Authentication Source with users associated is not permitted. Either associate the user(s) with a different authentication source or delete the users before deleting the authentication source.", "parameters": [{"in": "path", "description": "UUID of Authentication Source to delete", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["auth_sources"], "summary": "Delete an Authentication Source by UUID", "operationId": "deleteAuthSource"}}, "/auth/token": {"post": {"responses": {"200": {"description": "Successful Authentication", "schema": {"description": "Authorization Result", "allOf": [{"$ref": "#/definitions/Response"}, {"properties": {"result": {"type": "string", "description": "API Key", "example": "41bf89b3ee4f6a9129fdce90cd748c75f00992cfcfae43c22aab036d9635075e45434c780e50f0cb47297a787527dc50"}}}]}}, "400": {"description": "Request has missing authentication headers", "schema": {"$ref": "#/definitions/AuthErrorMissingHeaderResponse"}}, "404": {"description": "Request did not specify API version", "schema": {"$ref": "#/definitions/NoVersionErrorResponse"}}, "401": {"description": "Invalid Credentials", "schema": {"$ref": "#/definitions/AuthErrorInvalidCredentialsResponse"}}, "415": {"description": "Request is not JSON-encoded", "schema": {"$ref": "#/definitions/NotJsonEncodedResponse"}}}, "description": "Generates a unique token with every successful call\n* Tokens are stored in-memory; if the API is restarted or the server is rebooted, all tokens that were previously usable will no longer be valid\n* Users which are mapped to authentication sources of type __`pki`__ are required to include their client certificate with __every__ request where the authentication token obtained here is used\n* Obtaining authorization tokens using a client certificate is not currently supported in the API Explorer UI\n* A given user can have a maximum of 10 tokens in use at the same time.\n * Additional token requests beyond that limit will cause older tokens (expired or not) to be deleted to allow new token provisioning\n * See also [DELETE /auth/token](#/auth/deleteApiKey) - users can explicitly delete their authentication tokens (instead of waiting for token expiration or rotation)\n* Token will be usable for the number of minutes stored in the __`token_lifetime`__ property of the calling user's database record\n* To determine what the value of __`token_lifetime`__ is for the calling user, see the value returned within `GET /api/users/current`\n* The _default_ __`token_lifetime`__ property value is __`30`__ (minutes). \n* Set the __`X-Auth-Refresh-Token`__ header to __`true`__ with any authenticated API call in order to automatically extend the token expiration for the calling user.\nRequires the token used in the authenticated request to be valid and not yet expired", "parameters": [{"default": "admin", "required": true, "type": "string", "name": "X-Auth-Username", "in": "header"}, {"name": "X-Auth-Password", "format": "password", "default": "plexxi", "required": true, "in": "header", "type": "string"}, {"required": true, "type": "string", "name": "Content-Type", "enum": ["application/json"], "in": "header"}], "tags": ["auth"], "produces": ["application/json; version=1.0"], "security": [], "operationId": "getApiKey", "consumes": ["application/json"], "summary": "Get an API access token"}, "delete": {"responses": {"200": {"description": "API access token deleted successfully", "schema": {"allOf": [{"$ref": "#/definitions/Response"}]}}, "401": {"description": "Invalid or Expired Token", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "This call uses the same __`Authorization`__ header as other authenticated calls to process the token.\n* Returns __`200 OK`__ status if the token is valid and was deleted.\n* Returns __`401 Unauthorized`__ status if the token is not found or is expired.\nIf expired, the token is still deleted (as it is with any other authenticated call)", "parameters": [], "tags": ["auth"], "produces": ["application/json; version=1.0"], "operationId": "deleteApiKey", "consumes": ["application/json"], "summary": "Delete an API access token"}}, "/backups": {"post": {"responses": {"200": {"description": "Backup created successfully", "schema": {"$ref": "#/definitions/backup_response"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"required": true, "type": "string", "name": "Content-Type", "enum": ["application/json"], "in": "header"}, {"schema": {"$ref": "#/definitions/backup"}, "description": "Backup", "required": false, "name": "body", "in": "body"}], "produces": ["application/json; version=1.0"], "tags": ["backups"], "summary": "Create a backup", "operationId": "createBackup"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/backup_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "Return only the count of backup objects in the `result` property of the response.", "required": false, "type": "boolean", "name": "count_only", "in": "query"}, {"description": "If True include all backups scheduled for deletion by retention policy. Otherwise include all backups.", "required": false, "type": "boolean", "name": "scheduled_deletion", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["backups"], "summary": "Get an array of backups", "operationId": "listBackup"}}, "/backups/schedules": {"post": {"responses": {"200": {"description": "Backup schedule created successfully", "schema": {"$ref": "#/definitions/backup_schedule_response"}}, "400": {"description": "Invalid syntax or conflicted schedule rules.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"schema": {"$ref": "#/definitions/backup_schedule_create"}, "description": "Backup schedule", "required": true, "name": "body", "in": "body"}], "produces": ["application/json; version=1.0"], "tags": ["backups"], "summary": "Create a backup schedule", "operationId": "createBackupSchedule"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/backup_schedule_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "Return only the count of backup schedule objects in the `result` property of the response.", "required": false, "type": "boolean", "name": "count_only", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["backups"], "summary": "Get an array of backup schedules", "operationId": "listBackupSchedule"}}, "/backups/schedules/{uuid}": {"put": {"responses": {"200": {"description": "Backup schedule updated successfully", "schema": {"$ref": "#/definitions/backup_schedule_response"}}, "400": {"description": "Invalid syntax or conflicted schedule rules.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "403": {"description": "Backup schedule not supported", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Backup schedule not found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "Backup Schedule UUID", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"schema": {"$ref": "#/definitions/backup_schedule_update"}, "description": "Backup schedule", "required": true, "name": "body", "in": "body"}], "produces": ["application/json; version=1.0"], "tags": ["backups"], "summary": "Update a backup schedule", "operationId": "updateBackupSchedule"}, "delete": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "Backup Schedule UUID", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["backups"], "summary": "Delete a backup schedule", "operationId": "deleteBackupSchedule"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/backup_schedule_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "backup schedule not found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "Backup Schedule UUID", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["backups"], "summary": "Get info about a backup schedule", "operationId": "getBackupSchedule"}}, "/backups/upload": {"post": {"responses": {"200": {"description": "Backup uploaded successfully", "schema": {"$ref": "#/definitions/backup_response"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "409": {"description": "Error: Resource conflict", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"schema": {"$ref": "#/definitions/backup_upload"}, "description": "Backup binary file", "required": true, "name": "body", "in": "body"}], "tags": ["backups"], "produces": ["application/json; version=1.0"], "operationId": "uploadBackup", "consumes": ["application/octet-stream"], "summary": "Upload a backup"}}, "/backups/{uuid}": {"put": {"responses": {"200": {"description": "Backup restore_hours value updated successfully", "schema": {"$ref": "#/definitions/backup_response"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "403": {"description": "Backup not supported", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "Backup UUID", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"schema": {"$ref": "#/definitions/backup"}, "description": "Backup", "required": true, "name": "body", "in": "body"}], "produces": ["application/json; version=1.0"], "tags": ["backups"], "summary": "Update a backup retention hours value.", "operationId": "updateBackup"}, "delete": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "Backup UUID", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["backups"], "summary": "Delete a backup", "operationId": "deleteBackup"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/backup_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "backup not found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "Backup UUID", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["backups"], "summary": "Get metadata about a backup", "operationId": "getBackup"}}, "/backups/{uuid}/restore": {"put": {"responses": {"200": {"description": "Backup restored successfully", "schema": {"$ref": "#/definitions/backup_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "403": {"description": "Backup not supported", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "Backup UUID", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"required": true, "type": "string", "name": "Content-Type", "enum": ["application/json"], "in": "header"}], "produces": ["application/json; version=1.0"], "tags": ["backups"], "summary": "Restore a backup", "operationId": "restoreBackup"}}, "/certificates/ssl": {"put": {"responses": {"200": {"description": "Certificate Successfully Replaced", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid Format", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "* __NOTE__: When successful, this operation will overwrite the existing private key and certificate used by the web server\n* Please ensure you back up the existing private key and certificate if necessary, especially if they are not automatically generated by Composable Fabric Manager and the certificate has not yet expired", "parameters": [{"schema": {"$ref": "#/definitions/certificate_update"}, "description": "New certificate and private key", "required": true, "name": "body", "in": "body"}], "tags": ["certificates"], "produces": ["application/json; version=1.0"], "operationId": "replaceSslCertificate", "consumes": ["application/json"], "summary": "Replace SSL/TLS Certificate"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/certificate"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "produces": ["application/json; version=1.0"], "description": "", "tags": ["certificates"], "summary": "Get current Certificate Information", "operationId": "getCertificateInfo"}}, "/certificates/ssl/regenerate": {"post": {"responses": {"200": {"description": "Certificate Successfully Replaced", "schema": {"$ref": "#/definitions/Response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "produces": ["application/json; version=1.0"], "tags": ["certificates"], "summary": "Regenerate Self-Signed Certificate", "consumes": ["application/json"], "operationId": "regenerateSslCertificate"}}, "/clusters": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/cluster_simplivity_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "202": {"description": "Success: Request has been accepted, but processing has not been completed.", "schema": {"$ref": "#/definitions/AcceptedResponse"}}}, "description": "Note that each object's schema (including UUID pattern) will vary based on the value of its `vendor` property.\n\nDepending on enabled Packs, objects can be one of:\n* Object: Cluster (discovered by Simplivity Pack)\n\nSee the `models` heading at the bottom of the page.\n\nThe following parameters are mutually exclusive: `manager`, `type`, `vendor`", "parameters": [{"description": "Return only the count of cluster objects in the `result` property of the response.", "x-param-conflicts-with": ["vms", "hosts"], "required": false, "in": "query", "type": "boolean", "name": "count_only"}, {"description": "Return the array of cluster objects contained in the given page number", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of cluster objects of the given size", "required": false, "type": "integer", "name": "page_size", "in": "query"}, {"enum": ["nutanix", "vmware", "simplivity"], "description": "Return only clusters running software supplied by the given vendor", "required": false, "in": "query", "type": "string", "name": "vendor"}, {"description": "Include array of related hosts objects with each cluster object", "x-param-conflicts-with": ["count_only"], "required": false, "in": "query", "type": "boolean", "name": "hosts"}, {"description": "Include array of related virtual machine objects with each cluster object", "x-param-conflicts-with": ["count_only"], "required": false, "in": "query", "type": "boolean", "name": "vms"}], "produces": ["application/json; version=1.0"], "tags": ["clusters"], "summary": "Get an array of clusters", "operationId": "listClusters"}}, "/clusters/{uuid}": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/cluster_simplivity_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "202": {"description": "Success: Request has been accepted, but processing has not been completed.", "schema": {"$ref": "#/definitions/AcceptedResponse"}}, "404": {"description": "Host Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Note that the object's schema (including UUID pattern) will vary based on the value of its `vendor` property.\n\nDepending on enabled Packs, objects can be one of:\n* Object: Host (discovered by Simplivity Pack)\n\nSee the `models` heading at the bottom of the page.", "parameters": [{"description": "UUID of Cluster to return", "minLength": 32, "required": true, "in": "path", "type": "string", "name": "uuid"}, {"description": "Include array of related hosts objects with each cluster object", "required": false, "type": "boolean", "name": "hosts", "in": "query"}, {"description": "Include array of related virtual machine objects with each cluster object", "required": false, "type": "boolean", "name": "vms", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["clusters"], "summary": "Get a cluster by UUID", "operationId": "getClusterByUuid"}}, "/dhcp_relay/{fabric_uuid}": {"put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/dhcp_relay"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of Fabric to update", "required": true, "type": "string", "name": "fabric_uuid", "in": "path"}, {"schema": {"$ref": "#/definitions/dhcp_relay"}, "description": "DHCP relay properties configuration. \n* Can have multiple DHCP relay configurations. \n* Must not have any duplicate VLANs across the configurations.", "required": true, "name": "body", "in": "body"}], "produces": ["application/json; version=1.0"], "tags": ["dhcp_relay"], "summary": "Update DHCP relay properties.", "operationId": "putDhcpProperties"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/dhcp_relay"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of Fabric to return", "required": true, "type": "string", "name": "fabric_uuid", "in": "path"}], "produces": ["application/json; version=1.0"], "tags": ["dhcp_relay"], "summary": "Get DHCP relay configuration.", "operationId": "listDhcpProperties"}}, "/dns_client_configurations": {"post": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/dns_client_configuration_response"}}, "400": {"description": "Must specify domain_name or search_path, but not both", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "The UUID of a successfully added DNS Client Configuration will be returned", "parameters": [{"required": true, "description": "DNS Client Configuration\n * description - describes this DNS Client Configuration object\n * domain_name - specifies the domain name - RFC 1035\n * name - names this DNS Client Configuration object\n * name_servers - list of name servers in IPv4 or IPv6 format\n * search_path - search list of default local domain names\n\nTo create a DNS Client Configuration's associations with:\n * management_software - whether or not Management Software uses this DNS Client Configuration\n * fabric_uuids: UUIDs of any fabrics with which this configuration is associated\n * switch_uuids -UUIDs of any switches with which this configuration is associated\n\nNote: __`domain_name`__ and __`search_path`__ are mutually exclusive.", "schema": {"$ref": "#/definitions/dns_client_configuration_create"}, "name": "body", "in": "body"}], "tags": ["dns_client_configurations"], "produces": ["application/json; version=1.0"], "operationId": "addDns", "consumes": ["application/json"], "summary": "Add a new DNS Client Configuration"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/dns_client_configuration_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Retrieve an array of DNS Client Configuration objects, optionally filtered based on its usage by a fabric, a given switch or Management Software", "parameters": [{"description": "Return only the count of DNS Client Configuration objects in the __`result`__ property of the response", "required": false, "type": "boolean", "name": "count_only", "in": "query"}, {"description": "Return the array of DNS Client Configuration objects contained in the given page number", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of DNS Client Configuration objects of the given size", "required": false, "type": "integer", "name": "page_size", "in": "query"}, {"description": "Return the DNS Client Configuration objects used by Management Software", "required": false, "type": "boolean", "name": "management_software", "in": "query"}, {"description": "Return the DNS Client Configuration objects used by the fabric with the given UUID", "required": false, "type": "string", "name": "fabric", "in": "query"}, {"description": "Return the DNS Client Configuration objects used by the switch with the given UUID", "required": false, "type": "string", "name": "switch", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["dns_client_configurations"], "summary": "Get an array of DNS Client Configurations", "operationId": "listDns"}}, "/dns_client_configurations/{uuid}": {"put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/dns_client_configuration_response"}}, "400": {"description": "Invalid UUID, or must specify domain_name or search_path, but not both", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Update a DNS Client Configuration object by its UUID", "parameters": [{"description": "UUID of DNS Client Configuration object to update", "required": true, "type": "string", "name": "uuid", "in": "path"}, {"schema": {"$ref": "#/definitions/dns_client_configuration_update"}, "description": "DNS Client Configuration\nTo create a DNS Client Configuration attributes with:\n * description - describes this DNS Client Configuration object\n * domain_name - specifies the domain name - RFC 1035\n * name - names this DNS Client Configuration object\n * name_servers - list of name servers in IPv4 or IPv6 format\n * search_path - search list of default local domain names\n\nTo create a DNS Client Configuration's associations with:\n * management_software - whether or not Management Software uses this DNS Client Configuration\n * fabric_uuids: UUIDs of any fabrics with which this configuration is associated\n * switch_uuids: UUIDs of any switches with which this configuration is associated\nNote: __`domain_name`__ and __`search_path`__ are mutually exclusive.", "required": true, "name": "body", "in": "body"}], "produces": ["application/json; version=1.0"], "tags": ["dns_client_configurations"], "summary": "Update a DNS Client Configuration by UUID", "operationId": "updateDns"}, "delete": {"responses": {"200": {"description": "DNS Client Configuration deleted successfully", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Deletes a single DNS Client Configuration object", "parameters": [{"description": "UUID of DNS Client Configuration to delete", "required": true, "type": "string", "name": "uuid", "in": "path"}], "produces": ["application/json; version=1.0"], "tags": ["dns_client_configurations"], "summary": "Delete a DNS Client Configuration by UUID", "operationId": "deleteDns"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/dns_client_configuration_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Retrieve a DNS Client Configuration by its UUID", "parameters": [{"description": "UUID of DNS Client Configuration object to return", "required": true, "type": "string", "name": "uuid", "in": "path"}], "produces": ["application/json; version=1.0"], "tags": ["dns_client_configurations"], "summary": "Get a DNS Client Configuration by UUID", "operationId": "getDns"}}, "/fabric_ip_networks": {"post": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/fabric_ip_network_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Create a Fabric IP Network Configuration object for a specific fabric", "parameters": [{"description": "Fabric IP Network Create", "schema": {"$ref": "#/definitions/fabric_ip_network_create"}, "name": "body", "in": "body"}], "tags": ["fabric_ip_networks"], "produces": ["application/json; version=1.0"], "operationId": "createFabricIpNetworkConfig", "consumes": ["application/json"], "summary": "Add a new Fabric IP Network configuration"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/fabric_ip_network_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "Return only the count of objects in the `result` property of the response.", "required": false, "type": "boolean", "name": "count_only", "in": "query"}, {"description": "Return Fabric IP Network configuration for the fabric with the given UUID", "required": false, "type": "string", "name": "fabric", "in": "query"}, {"description": "Return the array of Fabric IP Network objects contained in the given page number", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of Fabric IP Network objects of the given size", "required": false, "type": "integer", "name": "page_size", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["fabric_ip_networks"], "summary": "Get an array of Fabric IP Network configurations", "operationId": "listFabricIpNetworkConfigs"}}, "/fabric_ip_networks/{uuid}": {"put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/fabric_ip_network_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "parameters": [{"in": "path", "description": "UUID of Fabric IP Network Configuration to update", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"description": "Fabric IP Network Update", "schema": {"$ref": "#/definitions/fabric_ip_network_update"}, "name": "body", "in": "body"}], "produces": ["application/json; version=1.0"], "tags": ["fabric_ip_networks"], "summary": "Update a Fabric IP Network configuration by UUID", "consumes": ["application/json"], "operationId": "updateFabricIpNetwork"}, "delete": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of Fabric IP Network to delete", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["fabric_ip_networks"], "summary": "Delete a Fabric IP Network configuration object", "operationId": "deleteFabricIpNetworkConfigs"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/fabric_ip_network_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of Fabric IP Network Configuration to return", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["fabric_ip_networks"], "summary": "Get a Fabric IP Network configuration by UUID", "operationId": "listFabricIpNetworkConfig"}}, "/fabrics": {"post": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/AcceptedResponse"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Switches must be using the default token within a fabric UUID already to be discovered.", "parameters": [{"description": "Fabric Discovery", "schema": {"$ref": "#/definitions/fabric_create"}, "name": "body", "in": "body"}], "produces": ["application/json; version=1.0"], "tags": ["fabrics"], "summary": "Discovers a Fabric using the IP address of one switch.", "operationId": "discoverFabricByIp"}, "patch": {"responses": {"422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "200": {"description": "Fabrics updated Successfully", "schema": {"$ref": "#/definitions/PatchResponse"}}, "207": {"description": "Partial success in updating fabrics.", "schema": {"$ref": "#/definitions/PatchResponse"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Invalid Request", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Update one or more fabrics using JSON patch(es) with their UUIDs.\nThe following patch `ops` are supported:\n* `replace`\n\nThe following patch `paths` are supported:\n* `/foreign_fabric_state`\n* `/foreign_manager_id`\n* `/foreign_manager_url`\n* `/tags`\n\nNotes:\nPatches are applied as follows:\n* Either the __`update_all`__ query parameter or __`uuids`__ property in the request body object must be provided\n* If a list of __`uuids`__ are provided in the request body:\n * The UUIDs must be associated with the fabrics\n * The matching __`patch`__ in the body will be applied to all fabrics whose UUID is in the __`uuids`__ list\n * Note that the use of the __`update_all`__ query parameter and inclusion of the __`uuids`__ property in the request object are mutually exclusive features.", "parameters": [{"description": "Apply an array of patches to fabric resources.", "schema": {"items": {"$ref": "#/definitions/fabric_patch_request"}, "type": "array"}, "name": "Fabric Patch Request", "in": "body"}, {"description": "Update all fabrics with all patch requests", "required": false, "type": "boolean", "name": "update_all", "in": "query"}], "tags": ["fabrics"], "produces": ["application/json; version=1.0"], "operationId": "updateFabrics", "consumes": ["application/json"], "summary": "Patch Request to update one or more fabrics"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/fabric_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "202": {"description": "Success: Request has been accepted, but processing has not been completed.", "schema": {"$ref": "#/definitions/AcceptedResponse"}}}, "description": "Retrieve an array of Fabric objects, optionally including an array of Switch objects related to each Fabric.", "parameters": [{"description": "Return only the count of objects in the `result` property of the response.", "required": false, "type": "boolean", "name": "count_only", "in": "query"}, {"description": "Include only fabric objects which have related switch known to Composable Fabric Manager.", "required": false, "type": "boolean", "name": "only_with_switches", "in": "query"}, {"description": "Return the array of fabric objects contained in the given page number", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of fabric objects of the given size", "required": false, "type": "integer", "name": "page_size", "in": "query"}, {"description": "Include fabric wide settings for various features in the response body", "required": false, "type": "boolean", "name": "settings", "in": "query"}, {"description": "Include array of fabric switches with each fabric object", "required": false, "type": "boolean", "name": "switches", "in": "query"}, {"description": "Include related tag list as a property of each object in the response body", "required": false, "type": "boolean", "name": "tags", "in": "query"}, {"description": "Include information about fabric segmentation.", "required": false, "type": "boolean", "name": "include_segments", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["fabrics"], "summary": "Get an array of Fabric objects", "operationId": "listFabrics"}}, "/fabrics/{uuid}": {"put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/AcceptedResponse"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Invalid Request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Update a Fabric object.\n\nThe following properties are optional.\n* `/foreign_fabric_state`\n* `/foreign_manager_id`\n* `/foreign_manager_url`\n\nNote: If the above properties are provided the existing configuration for those properties will be updated.\n\n", "parameters": [{"in": "path", "description": "UUID of Fabric to update", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"description": "Fabric Discovery", "schema": {"$ref": "#/definitions/fabric_update"}, "name": "body", "in": "body"}], "produces": ["application/json; version=1.0"], "tags": ["fabrics"], "summary": "Update a fabric.", "operationId": "putFabricByUuid"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/fabric_response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "202": {"description": "Success: Request has been accepted, but processing has not been completed.", "schema": {"$ref": "#/definitions/AcceptedResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Retrieve a Fabric object by its UUID, optionally including an array of Switch objects related to that Fabric.", "parameters": [{"in": "path", "description": "UUID of Fabric to return", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"description": "Include array of switches with each fabric object", "required": false, "type": "boolean", "name": "switches", "in": "query"}, {"description": "Include related tag list as a property of the object in the response body", "required": false, "type": "boolean", "name": "tags", "in": "query"}, {"description": "Include fabric wide settings for various features in the response body", "required": false, "type": "boolean", "name": "settings", "in": "query"}, {"description": "Include information about fabric segmentation.", "required": false, "type": "boolean", "name": "include_segments", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["fabrics"], "summary": "Get a Fabric by UUID", "operationId": "getFabricByUuid"}}, "/fabrics/{uuid}/change_password": {"post": {"responses": {"422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "200": {"description": "Password successfully changed", "schema": {"$ref": "#/definitions/Response"}}, "207": {"description": "Partial success updating switches in the fabric.", "schema": {"$ref": "#/definitions/MultiStatusResponse"}}, "400": {"description": "Invalid Input or Bad Current Password", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of the fabric for which to change the administrator password", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"schema": {"$ref": "#/definitions/user_password_update"}, "required": true, "name": "body", "in": "body"}], "tags": ["fabrics"], "produces": ["application/json; version=1.0"], "operationId": "changeFabricPassword", "consumes": ["application/json"], "summary": "Change the administrator password for a fabric"}}, "/fabrics/{uuid}/rediscovery": {"put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/AcceptedResponse"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Will use the existing fabric token to try and rediscover the switches.", "parameters": [{"in": "path", "description": "UUID of Fabric to rediscovery", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"description": "Fabric Rediscovery", "schema": {"$ref": "#/definitions/fabric_rediscover"}, "name": "body", "in": "body"}], "produces": ["application/json; version=1.0"], "tags": ["fabrics"], "summary": "Rediscovers a Fabric using the IP address of one switch.", "operationId": "rediscoverFabricByIp"}}, "/fabrics/{uuid}/settings": {"put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/AcceptedResponse"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Features that have global configuration per fabric.", "parameters": [{"in": "path", "description": "UUID of Fabric", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"description": "Fabric Settings", "schema": {"$ref": "#/definitions/fabric_settings_update"}, "name": "body", "in": "body"}], "produces": ["application/json; version=1.0"], "tags": ["fabrics"], "summary": "Fabric wide settings for various features.", "operationId": "fabricSettings"}}, "/fits": {"post": {"responses": {"422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "200": {"description": "Fit completed successfully", "schema": {"$ref": "#/definitions/CreationWithIdResponse"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "503": {"description": "Fitting service is unavailable, possibility that fit is\nbeing executed for the same fabric", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "409": {"description": "Tried to perform a fit with a fit UUID that already exists.", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Performs a FULL fit", "parameters": [{"description": "fit configuration", "schema": {"$ref": "#/definitions/fit_create"}, "name": "body", "in": "body"}], "tags": ["fits"], "produces": ["application/json; version=1.0"], "operationId": "performFit", "consumes": ["application/json"], "summary": "Perform a fit"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/fit_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Retrieve an array of fit objects", "parameters": [{"description": "Return fit that matches fabric_uuid if specified ", "x-param-conflicts-with": ["count_only", "page", "page_size"], "required": false, "in": "query", "type": "string", "name": "fabric_uuid"}, {"description": "Return fits that are performed for l2vpn configuration if true", "required": false, "type": "boolean", "name": "include_l2vpn", "in": "query"}, {"description": "Return all fits associated with the full fit, including the full fit itself", "required": false, "type": "string", "name": "full_fit_uuid", "in": "query"}, {"enum": ["full", "incremental", "l2vpn"], "description": "Return fits based on type", "required": false, "in": "query", "type": "string", "name": "fit_type"}, {"description": "Return only the count of Fit objects in the `result` property of the response.", "required": false, "type": "boolean", "name": "count_only", "in": "query"}, {"description": "Return the array of Fit objects contained in the given page number.", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of Fit objects of the given size.", "required": false, "type": "integer", "name": "page_size", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["fits"], "summary": "Get an array of fit objects", "operationId": "listFits"}}, "/fits/{uuid}": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/fit_response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Retrieve a fit object by its UUID.", "parameters": [{"in": "path", "description": "UUID of fit object to return", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["fits"], "summary": "Get a fit by UUID", "operationId": "getFit"}, "delete": {"responses": {"200": {"description": "fit deleted successfully", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Deletes a single provisioned fit object. This will delete the fit from the switches and the fitting engine just returning the fabric to a P2 topology ", "parameters": [{"in": "path", "description": "UUID of fit to delete", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["fits"], "summary": "Delete a fit by UUID", "operationId": "deleteFit"}}, "/high_availability/status": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/cfm_cluster_status_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "produces": ["application/json; version=1.0"], "description": "", "tags": ["high_availability"], "summary": "Get CFM cluster status object", "operationId": "listClusterStatus"}}, "/high_availability/vips": {"post": {"responses": {"200": {"description": "Virtual IP Added Successfully", "schema": {"$ref": "#/definitions/vip_response"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "* Add a new Virtual IP address for CFM.\n * Note: only <strong>one</strong> virtual IP address is allowed to exist. An attempt to create multiple will result in error.\n", "parameters": [{"schema": {"$ref": "#/definitions/vip_create"}, "description": "Virtual IP address", "required": true, "name": "body", "in": "body"}], "tags": ["high_availability"], "produces": ["application/json; version=1.0"], "operationId": "addCfmVip", "consumes": ["application/json"], "summary": "Create a new Virtual IP"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/vip_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "Return only the count of VIP objects in the `result` property of the response.", "required": false, "type": "boolean", "name": "count_only", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["high_availability"], "summary": "Get an array of Virtual IPs", "operationId": "listVips"}}, "/high_availability/vips/{uuid}": {"put": {"responses": {"200": {"description": "Virtual IP address successfully updated.", "schema": {"$ref": "#/definitions/vip_response"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Virtual IP address not found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of Virtual IP address object", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"schema": {"$ref": "#/definitions/vip_update"}, "description": "Virtual IP address", "required": true, "name": "body", "in": "body"}], "tags": ["high_availability"], "produces": ["application/json; version=1.0"], "operationId": "updateVip", "consumes": ["application/json"], "summary": "Modify a Virtual IP"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/vip_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Virtual IP not found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of Virtual IP address object", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["high_availability"], "summary": "Get a Virtual IP", "operationId": "getVip"}, "delete": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "CFM VIP not found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of Virtual IP address object", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["high_availability"], "summary": "Delete a Virtual IP", "operationId": "deleteVip"}}, "/hosts": {"patch": {"responses": {"200": {"description": "Hosts updated Successfully", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Invalid Request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Update one or more hosts using JSON patch(es) with their UUIDs.\nThe following patch __`operation`__ is supported:\n* `replace`\n\nThe following patch __`paths`__ are supported for access ports:\n* `/ilo/uid_indicator`\n\nNotes:\nPatches are applied as follows:\n* Either the __`update_all`__ query parameter or __`uuids`__ property in the request body object must be provided\n* If a list of __`uuids`__ are provided in the request body:\n * The UUIDs must be associated with the hosts\n * The matching __`patch`__ in the body will be applied to all hosts whose UUID is in the __`uuids`__ list\n * Note that the use of the __`update_all`__ query parameter and inclusion of the __`uuids`__ property in the request object are mutually exclusive features.", "parameters": [{"description": "Apply an array of patches to host resources", "schema": {"items": {"$ref": "#/definitions/host_patch_request"}, "type": "array"}, "name": "Host patch request", "in": "body"}, {"description": "Update all hosts with the first patch request", "required": false, "type": "boolean", "name": "update_all", "in": "query"}], "tags": ["hosts"], "produces": ["application/json; version=1.0"], "operationId": "updateHosts", "consumes": ["application/json"], "summary": "Patch request to update host objects"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/host_generic_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "202": {"description": "Success: Request has been accepted, but processing has not been completed.", "schema": {"$ref": "#/definitions/AcceptedResponse"}}}, "description": "Note that each object's schema (including UUID pattern) will vary based on the value of its `vendor` property.\n\nDepending on enabled Packs, objects can be one of:\n* Object: Host (discovered by iLO Amplifier Pack)\n* Object: Host (discovered by Kubernetes Pack)\n* Object: Host (discovered by Nutanix Pack)\n* Object: Host (discovered by vSphere Pack)\n\nSee the `models` heading at the bottom of the page.\n\nThe following parameters are mutually exclusive: `manager`, `type`, `vendor`", "parameters": [{"in": "query", "description": "Return only hosts from the given cluster", "minLength": 32, "required": false, "maxLength": 36, "type": "string", "name": "cluster_uuid"}, {"description": "Return only the count of host objects in the `result` property of the response.\n* With no other parameters, this returns an object with counts for each vendor.\n* When combined with the `type` parameter, this only returns the integer count of objects of that type.\n* When combined with the `vendor` parameter, this only returns the integer count of objects of that vendor.", "x-param-conflicts-with": ["host_names", "nics", "portgroups", "switch_ports", "vswitches", "vmkernel_adapters", "vms"], "required": false, "in": "query", "type": "boolean", "name": "count_only"}, {"name": "host_names", "in": "query", "items": {"type": "string", "example": "host.hpe.com", "maxLength": 255}, "x-param-conflicts-with": ["count_only"], "required": false, "type": "array", "collectionFormat": "csv", "description": "Return hosts for the given esxi hostname"}, {"description": "Return only hosts for the given cluster manager (Nutanix Prism or VMware Virtual Center instance) UUID", "x-param-conflicts-with": ["type", "vendor"], "required": false, "in": "query", "type": "string", "name": "manager"}, {"description": "Include array of physical host NICs with each host object", "x-param-conflicts-with": ["count_only"], "required": false, "in": "query", "type": "boolean", "name": "nics"}, {"description": "Return the array of host objects contained in the given page number", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of host objects of the given size", "required": false, "type": "integer", "name": "page_size", "in": "query"}, {"description": "Include array of related pod objects with each host", "x-param-conflicts-with": ["count_only"], "required": false, "in": "query", "type": "boolean", "name": "pods"}, {"description": "Include array of related port group objects with each virtual switch object (implicit inclusion of `vswitches=true`).\n* The `uuid` property of each `portgroup` object will consist of an ID relevant to the related `host` object for mapping purposes.", "required": false, "type": "boolean", "name": "portgroups", "in": "query"}, {"description": "Include Switch port UUID with each NIC object related to each host object (implicit inclusion of `nics=true`)", "x-param-conflicts-with": ["count_only"], "required": false, "in": "query", "type": "boolean", "name": "switch_ports"}, {"enum": ["baremetal", "compute", "hci", "vsan"], "description": "Return only hosts of the given type. \n* The `baremetal` type refers to generic servers discovered by the `iLOAmplifier` pack.\n* The `compute` type refers to hardware platforms which host applications, virtual machines, or containers.\n* The `hci` (Hyper-Converged Infrastructure) type refers to hardware platforms which host both compute and block storage services.\n* The `vsan` type refers specifically to vSphere hosts that are configured for VMware vSAN.", "x-param-conflicts-with": ["manager", "vendor"], "required": false, "in": "query", "type": "string", "name": "type"}, {"collectionFormat": "csv", "items": {"oneOf": [{"description": "Synthetic UUID", "format": "synthetic_uuid", "minLength": 34, "readOnly": true, "type": "string", "example": "5780276b-e32e-4527-96e0-43df965b1098-host-01"}, {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}]}, "description": "Return hosts for the given list of host UUIDs.\n* Note that while the data type is `Array[string]`, the parameter value constructed by clients must be a string representation: a comma-separated list of UUIDs.\n* Limiting the value of this parameter to one UUID is also valid.", "required": false, "in": "query", "type": "array", "name": "uuids"}, {"enum": ["kubernetes", "nutanix", "simplivity", "vmware", "ilo"], "description": "Return only hosts running software supplied by the given vendor", "x-param-conflicts-with": ["manager", "type"], "required": false, "in": "query", "type": "string", "name": "vendor"}, {"description": "Include array of related vmkernel adapters objects with each host object. Only applies to VMware hosts.", "x-param-conflicts-with": ["count_only"], "required": false, "in": "query", "type": "boolean", "name": "vmkernel_adapters"}, {"description": "Include array of related virtual machine objects with each host object", "x-param-conflicts-with": ["count_only"], "required": false, "in": "query", "type": "boolean", "name": "vms"}, {"description": "Include array of related virtual switch objects with each host object.\n* The `uuid` property of each `vswitch` object will consist of an ID relevant to the related `host` object.", "x-param-conflicts-with": ["count_only"], "required": false, "in": "query", "type": "boolean", "name": "vswitches"}], "produces": ["application/json; version=1.0"], "tags": ["hosts"], "summary": "Get an array of hosts", "operationId": "listHosts"}}, "/hosts/{uuid}": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/host_generic_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "202": {"description": "Success: Request has been accepted, but processing has not been completed.", "schema": {"$ref": "#/definitions/AcceptedResponse"}}, "404": {"description": "Host Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Note that the object's schema (including UUID pattern) will vary based on the value of its `vendor` property.\n\nDepending on enabled Packs, objects can be one of:\n* Object: Host (discovered by Kubernetes Pack)\n* Object: Host (discovered by Nutanix Pack)\n* Object: Host (discovered by vSphere Pack)\n\nSee the `models` heading at the bottom of the page.", "parameters": [{"description": "UUID of Host to return", "minLength": 32, "required": true, "in": "path", "type": "string", "name": "uuid"}, {"description": "Include array of physical host NICs with the host object", "required": false, "type": "boolean", "name": "nics", "in": "query"}, {"description": "Include array of related port group objects with each virtual switch object related to the host object (implicit inclusion of `vswitches=true`).\n* The `uuid` property of each `portgroup` object will consist of an ID relevant to the related `host` object for mapping purposes.", "required": false, "type": "boolean", "name": "portgroups", "in": "query"}, {"description": "Include Switch port UUID with each NIC object related to the host object (implicit inclusion of `nics=true`)", "required": false, "type": "boolean", "name": "switch_ports", "in": "query"}, {"description": "Include array of related vmkernel adapters objects with each host object. Only applies to VMware hosts.", "required": false, "type": "boolean", "name": "vmkernel_adapters", "in": "query"}, {"description": "Include array of virtual machine objects with the host object", "required": false, "type": "boolean", "name": "vms", "in": "query"}, {"description": "Include array of related virtual switch objects with the host object.\n* The `uuid` property of each `vswitch` object will consist of an ID relevant to the related `host` object.", "required": false, "type": "boolean", "name": "vswitches", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["hosts"], "summary": "Get a host by UUID", "operationId": "getHostByUuid"}}, "/hpe/ilo_amplifiers": {"post": {"responses": {"200": {"description": "Configuration Added Successfully", "schema": {"allOf": [{"$ref": "#/definitions/Response"}, {"properties": {"result": {"type": "string", "description": "Empty if `verify_only=true`. UUID of the newly created configuration otherwise", "example": "5d6a00bd286a497581e8879a2ce333e1"}}}]}}, "400": {"description": "Invalid Input or Connection Verification Failed", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"schema": {"$ref": "#/definitions/ilo_amplifier_pack_config_create"}, "description": "iLO Amplifier", "required": true, "name": "body", "in": "body"}, {"description": "* Limits request to verification of config data by establishing a connection to the server.\n* The pack configuration will not be created.\n* The `result` property in a success response will be empty.", "required": false, "type": "boolean", "name": "verify_only", "in": "query"}], "tags": ["ilo_amplifier"], "produces": ["application/json; version=1.0"], "operationId": "addILOAmplifierConfig", "consumes": ["application/json"], "summary": "Add a new HPE iLO Amplifier configuration"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ilo_amplifier_pack_config_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "Return only the count of HPE iLO Amplifier pack configurations (connected HPE iLO Amplifier instances).", "required": false, "type": "boolean", "name": "count_only", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["ilo_amplifier"], "summary": "Get an array of HPE iLO Amplifier configurations", "operationId": "listILOAmplifierConfig"}}, "/hpe/ilo_amplifiers/{uuid}": {"put": {"responses": {"200": {"description": "Configuration Updated Successfully", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of configuration to update", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"description": "* Limits request to verification of config data by establishing a connection to the server.\n* The pack configuration will not be updated.\n* The `result` property in a success response will be empty.", "required": false, "type": "boolean", "name": "verify_only", "in": "query"}, {"schema": {"$ref": "#/definitions/ilo_amplifier_pack_config_update"}, "description": "HPE iLO Amplifier configuration", "required": true, "name": "body", "in": "body"}], "tags": ["ilo_amplifier"], "produces": ["application/json; version=1.0"], "operationId": "updateILOAmplifierConfig", "consumes": ["application/json"], "summary": "Update a HPE iLO Amplifier configuration by UUID"}, "delete": {"responses": {"200": {"description": "Configuration Deleted Successfully", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid ID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of configuration to delete", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["ilo_amplifier"], "summary": "Delete a HPE iLO Amplifier configuration by UUID", "operationId": "deleteILOAmplifierConfig"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ilo_amplifier_pack_config_response"}}, "400": {"description": "Invalid ID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of configuration to return", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["ilo_amplifier"], "summary": "Get a HPE iLO Amplifier configuration by UUID", "operationId": "getILOAmplifierConfig"}}, "/hpe/ilo_amplifiers/{uuid}/verify": {"post": {"responses": {"200": {"description": "Connection Verification Succeeded", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Connection Verification Failed", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of configuration to verify", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"required": true, "type": "string", "name": "Content-Type", "enum": ["application/json"], "in": "header"}], "tags": ["ilo_amplifier"], "produces": ["application/json; version=1.0"], "operationId": "verifyILOAmplifierConfig", "consumes": ["application/json"], "summary": "Verify connectivity of a HPE iLO Amplifier configuration by UUID"}}, "/hpe/oneviews": {"post": {"responses": {"200": {"description": "Configuration Added Successfully", "schema": {"allOf": [{"$ref": "#/definitions/Response"}, {"properties": {"result": {"type": "string", "description": "Empty if `verify_only=true`. UUID of the newly created configuration otherwise", "example": "5d6a00bd286a497581e8879a2ce333e1"}}}]}}, "400": {"description": "Invalid Input or Connection Verification Failed", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"schema": {"$ref": "#/definitions/oneview_pack_config_create"}, "description": "OneView", "required": true, "name": "body", "in": "body"}, {"description": "* Limits request to verification of config data by establishing a connection to the server.\n* The pack configuration will not be created.\n* The `result` property in a success response will be empty.", "required": false, "type": "boolean", "name": "verify_only", "in": "query"}], "tags": ["oneview"], "produces": ["application/json; version=1.0"], "operationId": "addOneViewConfig", "consumes": ["application/json"], "summary": "Add a new HPE OneView configuration"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/oneview_pack_config_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "Return only the count of HPE OneView pack configurations (connected HPE OneView instances).", "required": false, "type": "boolean", "name": "count_only", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["oneview"], "summary": "Get an array of HPE OneView configurations", "operationId": "listOneViewConfig"}}, "/hpe/oneviews/{uuid}": {"put": {"responses": {"200": {"description": "Configuration Updated Successfully", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of configuration to update", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"description": "* Limits request to verification of config data by establishing a connection to the server.\n* The pack configuration will not be updated.\n* The `result` property in a success response will be empty.", "required": false, "type": "boolean", "name": "verify_only", "in": "query"}, {"schema": {"$ref": "#/definitions/oneview_pack_config_update"}, "description": "HPE OneView configuration", "required": true, "name": "body", "in": "body"}], "tags": ["oneview"], "produces": ["application/json; version=1.0"], "operationId": "updateOneViewConfig", "consumes": ["application/json"], "summary": "Update a HPE OneView configuration by UUID"}, "delete": {"responses": {"200": {"description": "Configuration Deleted Successfully", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid ID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of configuration to delete", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["oneview"], "summary": "Delete a HPE OneView configuration by UUID", "operationId": "deleteOneViewConfig"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/oneview_pack_config_response"}}, "400": {"description": "Invalid ID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of configuration to return", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["oneview"], "summary": "Get a HPE OneView configuration by UUID", "operationId": "getOneViewConfig"}}, "/hpe/oneviews/{uuid}/verify": {"post": {"responses": {"200": {"description": "Connection Verification Succeeded", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Connection Verification Failed", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of configuration to verify", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"required": true, "type": "string", "name": "Content-Type", "enum": ["application/json"], "in": "header"}], "tags": ["oneview"], "produces": ["application/json; version=1.0"], "operationId": "verifyOneViewConfig", "consumes": ["application/json"], "summary": "Verify connectivity of a HPE OneView configuration by UUID"}}, "/hpe/simplivitys": {"post": {"responses": {"200": {"description": "Configuration Added Successfully", "schema": {"allOf": [{"$ref": "#/definitions/Response"}, {"properties": {"result": {"type": "string", "description": "Empty if `verify_only=true`. UUID of the newly created configuration otherwise", "example": "5d6a00bd286a497581e8879a2ce333e1"}}}]}}, "400": {"description": "Invalid Input or Connection Verification Failed", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"schema": {"$ref": "#/definitions/simplivity_pack_config_create"}, "description": "Simplivity", "required": true, "name": "body", "in": "body"}, {"description": "* Limits request to verification of config data by establishing a connection to the server.\n* The pack configuration will not be created.\n* The `result` property in a success response will be empty.", "required": false, "type": "boolean", "name": "verify_only", "in": "query"}], "tags": ["simplivity"], "produces": ["application/json; version=1.0"], "operationId": "addSimplivityConfig", "consumes": ["application/json"], "summary": "Add a new HPE Simplivity configuration"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/simplivity_pack_config_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "Return only the count of HPE Simplivity pack configurations (connected HPE Simplivity instances).", "required": false, "type": "boolean", "name": "count_only", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["simplivity"], "summary": "Get an array of HPE Simplivity configurations", "operationId": "listSimplivityConfig"}}, "/hpe/simplivitys/{uuid}": {"put": {"responses": {"200": {"description": "Configuration Updated Successfully", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of configuration to update", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"description": "* Limits request to verification of config data by establishing a connection to the server.\n* The pack configuration will not be updated.\n* The `result` property in a success response will be empty.", "required": false, "type": "boolean", "name": "verify_only", "in": "query"}, {"schema": {"$ref": "#/definitions/simplivity_pack_config_update"}, "description": "HPE Simplivity configuration", "required": true, "name": "body", "in": "body"}], "tags": ["simplivity"], "produces": ["application/json; version=1.0"], "operationId": "updateSimplivityConfig", "consumes": ["application/json"], "summary": "Update a HPE Simplivity configuration by UUID"}, "delete": {"responses": {"200": {"description": "Configuration Deleted Successfully", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid ID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of configuration to delete", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["simplivity"], "summary": "Delete a HPE Simplivity configuration by UUID", "operationId": "deleteSimplivityConfig"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/simplivity_pack_config_response"}}, "400": {"description": "Invalid ID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of configuration to return", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["simplivity"], "summary": "Get a HPE Simplivity configuration by UUID", "operationId": "getSimplivityConfig"}}, "/hpe/simplivitys/{uuid}/refresh": {"post": {"responses": {"200": {"description": "Connection Verification Succeeded", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid UUID or Connection Verification Failed", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of HPE Simplivity configuration to refresh", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"required": true, "type": "string", "name": "Content-Type", "enum": ["application/json"], "in": "header"}], "produces": ["application/json; version=1.0"], "tags": ["simplivity"], "summary": "Refresh data learned from a HPE Simplivity instance by UUID", "operationId": "refreshSimplivityData"}}, "/hpe/simplivitys/{uuid}/verify": {"post": {"responses": {"200": {"description": "Connection Verification Succeeded", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Connection Verification Failed", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of configuration to verify", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"required": true, "type": "string", "name": "Content-Type", "enum": ["application/json"], "in": "header"}], "tags": ["simplivity"], "produces": ["application/json; version=1.0"], "operationId": "verifySimplivityConfig", "consumes": ["application/json"], "summary": "Verify connectivity of a HPE Simplivity configuration by UUID"}}, "/igmp_snooping/{fabric_uuid}": {"put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/igmp_snooping_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of Fabric to update", "required": true, "type": "string", "name": "fabric_uuid", "in": "path"}, {"description": "Set VLANs in configuration back to default settings (Supplied igmp_snooping values are ignored)", "required": false, "type": "boolean", "name": "defaults", "in": "query"}, {"schema": {"$ref": "#/definitions/igmp_snooping"}, "description": "IGMP snooping Properties configuration. \n* Can have multiple IGMP snooping configurations. \n* Must not have any duplicate VLANs across the configurations.", "required": true, "name": "body", "in": "body"}], "produces": ["application/json; version=1.0"], "tags": ["igmp_snooping"], "summary": "Update IGMP snooping properties.", "operationId": "putIgmpProperties"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/igmp_snooping_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of Fabric to return", "required": true, "type": "string", "name": "fabric_uuid", "in": "path"}], "produces": ["application/json; version=1.0"], "tags": ["igmp_snooping"], "summary": "Get an array of IGMP snooping objects.", "operationId": "listIgmpProperties"}}, "/integration_sets": {"patch": {"responses": {"200": {"description": "Integration Set updated Successfully", "schema": {"$ref": "#/definitions/PatchResponse"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Invalid Request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "parameters": [{"description": "Apply an array of patches to integration set resources.", "schema": {"items": {"$ref": "#/definitions/integration_set_patch_request"}, "type": "array"}, "name": "Integration Set Patch Request", "in": "body"}], "produces": ["application/json; version=1.0"], "description": "Update one integration set using JSON patch(es) with the UUID.\nThe following patch __`ops`__ are supported:\n* `replace`\n\nThe following patch __`paths`__ are supported:\n* `/is_selected`\n\nPatch is applied as follows:\n* The __`uuids`__ property in the request body object must be provided and must be a single __`uuid`__:\n* Only __`one`__ integration_set may be selected during the lifetime of the system\n", "tags": ["integrations"], "operationId": "updateIntegrationSets"}, "get": {"responses": {"200": {"description": "List of integration sets", "schema": {"$ref": "#/definitions/integration_set_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "parameters": [{"description": "Return only the count of Integration Set objects in the `result` property of the response.", "required": false, "type": "boolean", "name": "count_only", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["integrations"], "summary": "Get an array of integration sets", "operationId": "listIntegrationSets"}}, "/integrations": {"get": {"responses": {"200": {"description": "List of integrations", "schema": {"$ref": "#/definitions/integration_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "parameters": [{"description": "Include pack configuration summaries with pack info", "required": false, "type": "boolean", "name": "configurations", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["integrations"], "summary": "Get an array of integrations", "operationId": "listIntegrations"}}, "/integrations/{integration}/schema": {"get": {"responses": {"200": {"description": "Pack schema", "schema": {"$ref": "#/definitions/integration_schema_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Integration Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Return the integration configuration in json-schema format.", "parameters": [{"enum": ["kubernetes", "nsx", "nutanix", "oneview", "simplivity", "vsphere", "ilo_amplifier"], "description": "Name of pack", "required": true, "in": "path", "type": "string", "name": "pack"}], "produces": ["application/json; version=1.0"], "tags": ["integrations"], "summary": "Get an integration configuration schema", "operationId": "getIntegrationSchema"}}, "/ip_prefix_lists": {"post": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ip_prefix_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "IP Prefix List Create", "schema": {"$ref": "#/definitions/ip_prefix_list_create"}, "name": "body", "in": "body"}], "tags": ["ip_prefix_lists"], "produces": ["application/json; version=1.0"], "operationId": "createIPPrefixList", "consumes": ["application/json"], "summary": "Add a new IP Prefix List object"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ip_prefix_list_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "Return only the count of objects in the `result` property of the response.", "required": false, "type": "boolean", "name": "count_only", "in": "query"}, {"description": "Return the array of IP Prefix List objects contained in the given page number", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of IP Prefix List objects of the given size", "required": false, "type": "integer", "name": "page_size", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["ip_prefix_lists"], "summary": "Get an array of IP Prefix List objects", "operationId": "listIPPrefixes"}}, "/ip_prefix_lists/{uuid}": {"put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ip_prefix_list_create"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "List Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of Prefix List to update", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "uuid"}, {"description": "IP Prefix List Update", "schema": {"$ref": "#/definitions/ip_prefix_list_update"}, "name": "body", "in": "body"}], "produces": ["application/json; version=1.0"], "tags": ["ip_prefix_lists"], "summary": "Update an IP Prefix List object by UUID", "operationId": "updateIPPrefixListByUuid"}, "delete": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "List Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of Prefix List to delete", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["ip_prefix_lists"], "summary": "Delete an IP Prefix List object by UUID", "operationId": "deleteIPPrefixListByUuid"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ip_prefix_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "List Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of Prefix List to return", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["ip_prefix_lists"], "summary": "Get an IP Prefix List object by UUID", "operationId": "getIPPrefixListByUuid"}}, "/kubernetes/masters": {"post": {"responses": {"200": {"description": "Configuration Added Successfully", "schema": {"allOf": [{"$ref": "#/definitions/Response"}, {"properties": {"result": {"type": "string", "description": "empty if `verify_only=true`, new UUID otherwise", "example": "5d6a00bd286a497581e8879a2ce333e1"}}}]}}, "400": {"description": "Invalid Input or Connection Verification Failed", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"schema": {"$ref": "#/definitions/kubernetes_pack_config_create"}, "description": "Kubernetes Master", "required": true, "name": "body", "in": "body"}, {"description": "* Limits request to verification of config data by establishing a connection to the server.\n* The pack configuration will not be created.\n* The 'result' property in a success response will be empty.", "required": false, "type": "boolean", "name": "verify_only", "in": "query"}], "tags": ["kubernetes"], "produces": ["application/json; version=1.0"], "operationId": "addKubernetesConfig", "consumes": ["application/json"], "summary": "Add a new Kubernetes Master configuration"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/kubernetes_pack_config_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "Return only the count of Kubernetes pack configurations (connected Kubernetes Master instances / clusters).", "required": false, "type": "boolean", "name": "count_only", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["kubernetes"], "summary": "Get an array of Kubernetes Master configurations", "operationId": "listKubernetesConfig"}}, "/kubernetes/masters/{uuid}": {"put": {"responses": {"200": {"description": "Configuration Updated Successfully", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of configuration to update", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"description": "* Limits request to verification of config data by establishing a connection to the server.\n* The pack configuration will not be updated.\n* The 'result' property in a success response will be empty.", "required": false, "type": "boolean", "name": "verify_only", "in": "query"}, {"schema": {"$ref": "#/definitions/kubernetes_pack_config_update"}, "description": "Kubernetes Master configuration", "required": true, "name": "body", "in": "body"}], "tags": ["kubernetes"], "produces": ["application/json; version=1.0"], "operationId": "updateKubernetesConfig", "consumes": ["application/json"], "summary": "Update an Kubernetes configuration by UUID"}, "delete": {"responses": {"200": {"description": "Configuration Deleted Successfully", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid ID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of configuration to delete", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["kubernetes"], "summary": "Delete an Kubernetes configuration by UUID", "operationId": "deleteKubernetesConfig"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/kubernetes_pack_config_response"}}, "400": {"description": "Invalid ID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of configuration to return", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["kubernetes"], "summary": "Get an Kubernetes configuration by UUID", "operationId": "getKubernetesConfig"}}, "/kubernetes/masters/{uuid}/register": {"post": {"responses": {"200": {"description": "Registration Successful", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Registration Failed", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Use the configuration credentials to register the plugin.", "parameters": [{"in": "path", "description": "UUID of configuration to use for registration", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "tags": ["kubernetes"], "produces": ["application/json; version=1.0"], "operationId": "registerKubernetesPlugin", "consumes": ["application/json"], "summary": "Register the Composable Fabric Manager Kubernetes/OpenShift Plugin by UUID"}}, "/kubernetes/masters/{uuid}/verify": {"post": {"responses": {"200": {"description": "Connection Verification Succeeded", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Connection Verification Failed", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of configuration to verify", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"required": true, "type": "string", "name": "Content-Type", "enum": ["application/json"], "in": "header"}], "tags": ["kubernetes"], "produces": ["application/json; version=1.0"], "operationId": "verifyKubernetesConfig", "consumes": ["application/json"], "summary": "Verify connectivity of an Kubernetes configuration by UUID"}}, "/l2vpns": {"post": {"responses": {"200": {"description": "L2VPN added successfully", "schema": {"$ref": "#/definitions/CreationWithIdResponse"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "422": {"description": "Unprocessable request. If the L2VPN tunnel infrastructure was not initialized, run a full residual fit", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "The UUID of a successfully added L2VPN will be returned.", "parameters": [{"description": "L2VPN object.", "schema": {"$ref": "#/definitions/l2vpn_create"}, "name": "body", "in": "body"}], "tags": ["l2vpns"], "produces": ["application/json; version=1.0"], "operationId": "addL2vpn", "consumes": ["application/json"], "summary": "Add a new L2VPN object"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/l2vpn_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "202": {"description": "Success: Request has been accepted, but processing has not been completed.", "schema": {"$ref": "#/definitions/AcceptedResponse"}}}, "description": "Retrieve an array of L2VPN objects.", "parameters": [{"description": "Return only the count of L2VPN objects in the `result` property of the response.", "required": false, "type": "boolean", "name": "count_only", "in": "query"}, {"description": "Return the array of L2VPN objects contained in the given page number.", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of L2VPN objects of the given size.", "required": false, "type": "integer", "name": "page_size", "in": "query"}, {"description": "Return only the L2VPN object with this VNI", "required": false, "type": "integer", "name": "vni", "in": "query"}, {"in": "query", "description": "Return L2VPN objects associated with this fabric UUID. When used with `no_fabric_association` set to `True`, the call will return L2VPN objects associated with the given fabric UUID and L2VPN objects associated with no fabric.", "minLength": 32, "required": false, "maxLength": 36, "type": "string", "name": "fabric_uuid"}, {"description": "When `True`, return L2VPN objects which are not associated with any fabric. When `False`, return all L2VPN objects associated with any fabric. When used with `fabric_uuid` and set to `True`, the call will return L2VPN objects associated with that fabric and L2VPN objects not associated with a fabric. When used with `fabric_uuid` and set to `False`, the call will only return L2VPN objects associated with that fabric.", "required": false, "type": "boolean", "name": "no_fabric_association", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["l2vpns"], "summary": "Get an array of L2VPN objects", "operationId": "listL2vpn"}}, "/l2vpns/evpn_routes": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/evpn_route_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"collectionFormat": "csv", "items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "description": "Return EVPN Routes for the given list of Switch UUIDs.\n* Note that while the data type is `Array[string]`, the parameter value constructed by clients must be a string representation: a comma-separated list of UUIDs.\n* Limiting the value of this parameter to one UUID is also valid.", "required": false, "in": "query", "type": "array", "name": "switches"}, {"description": "Return only the count of EVPN Routes in the `result` property of the response.", "required": false, "type": "boolean", "name": "count_only", "in": "query"}, {"description": "Return the array of EVPN Route objects contained in the given page number", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of EVPN Route entry objects of the given size", "required": false, "type": "integer", "name": "page_size", "in": "query"}], "tags": ["l2vpns"], "produces": ["application/json; version=1.0"], "operationId": "l2vpnEvpnRoutesGet", "consumes": ["application/json"], "summary": "Get a switches EVPN Routes"}}, "/l2vpns/{uuid}": {"put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/l2vpn_response"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Update an L2VPN object by UUID. The L2VPN object and its assignments will be updated to match what is in the request body.", "parameters": [{"in": "path", "description": "UUID of L2VPN object to update", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"schema": {"$ref": "#/definitions/l2vpn_update"}, "description": "L2VPN.", "required": true, "name": "body", "in": "body"}], "produces": ["application/json; version=1.0"], "tags": ["l2vpns"], "summary": "Update an L2VPN object by UUID", "operationId": "updateL2vpn"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/l2vpn_response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Retrieve a L2VPN object by its UUID.", "parameters": [{"in": "path", "description": "UUID of L2VPN object to get", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["l2vpns"], "summary": "Get a L2VPN object by UUID", "operationId": "getL2vpn"}, "delete": {"responses": {"200": {"description": "L2VPN deleted successfully", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Deletes a single L2VPN object.", "parameters": [{"in": "path", "description": "UUID of L2VPN object to delete", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["l2vpns"], "summary": "Delete a L2VPN by UUID", "operationId": "deleteL2vpn"}}, "/lags": {"patch": {"responses": {"422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "200": {"description": "Link Aggregation Groups updated successfully", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Invalid Request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "409": {"description": "Link Aggregation Groups Concurrent modification", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Update one or more Link Aggregation Groups using JSON patch(es) with their UUIDs.\n\nThe following patch __`paths`__ are supported for the __`replace`__ operation:\n* `/description`\n* `/mac_learning_attachments`\n* `/mac_learning_attachments/{index}/mac_address`\n* `/mac_learning_attachments/{index}/vlan`\n* `/mac_learning_configuration`\n* `/mac_learning_configuration/aging`\n* `/mac_learning_configuration/learning_limit`\n* `/mac_learning_configuration/mode`\n* `/mac_learning_configuration/violation_action`\n* `/mac_learning_use_default_configuration`\n* `/name`\n* `/native_vlan`\n* `/tags`\n* `/ungrouped_vlans`\n* `/vlan_group_uuids`\n\nThe following patch __`paths`__ are supported for the __`add`__ operation:\n* `/vlan_group_uuids`\n\nThe following patch __`paths`__ are supported for the __`remove`__ operation:\n* `/vlan_group_uuids`\n\nNotes:\nPatches are applied as follows:\n* Either the __`update_all`__ query parameter or __`uuids`__ property in the request body object must be provided\n* If a list of __`uuids`__ are provided in the request body:\n * The UUIDs must be associated with the LAGs\n * The matching __`patch`__ in the body will be applied to all LAGs whose UUID is in the __`uuids`__ list\n * Note that the use of the __`update_all`__ query parameter and inclusion of the __`uuids`__ property in the request object are mutually exclusive features.", "parameters": [{"description": "Apply an array of patches to Link Aggregation Group resources.", "schema": {"items": {"$ref": "#/definitions/lag_patch_request"}, "type": "array"}, "name": "LAG Patch Request", "in": "body"}, {"description": "Update all Link Aggregation Groups with the first patch request.", "required": false, "type": "boolean", "name": "update_all", "in": "query"}], "tags": ["lags"], "produces": ["application/json; version=1.0"], "operationId": "updateLags", "consumes": ["application/json"], "summary": "Patch request to update LAG objects"}, "post": {"responses": {"200": {"description": "Provisioned Link Aggregation Group added successfully", "schema": {"$ref": "#/definitions/CreationWithIdResponse"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "409": {"description": "Link Aggregation Groups Concurrent modification", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "The UUID of a successfully added Link Aggregation Group will be returned.", "parameters": [{"description": "Provisioned Link Aggregation Group object.", "schema": {"$ref": "#/definitions/lag_create"}, "name": "body", "in": "body"}], "tags": ["lags"], "produces": ["application/json; version=1.0"], "operationId": "addLag", "consumes": ["application/json"], "summary": "Add a new provisioned LAG object"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/lag_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "202": {"description": "Success: Request has been accepted, but processing has not been completed.", "schema": {"$ref": "#/definitions/AcceptedResponse"}}}, "description": "Retrieve an array of Link Aggregation Group objects, optionally including an array of Port objects and/or VLAN Group objects related to each Link Aggregation Group.", "parameters": [{"description": "Return only the count of Link Aggregation Group objects in the `result` property of the response.", "x-param-conflicts-with": ["mac_attachments", "mac_learning", "ports", "vlan_groups"], "required": false, "in": "query", "type": "boolean", "name": "count_only"}, {"description": "Return Link Aggregation Group objects related to the fabric with the given UUID.", "required": false, "type": "string", "name": "fabric", "in": "query"}, {"description": "If there is a L2VPN object associated with this object, return the L2VPN's UUID", "required": false, "type": "boolean", "name": "l2vpn", "in": "query"}, {"description": "Include MAC attachment information with each Link Aggregation Group object in the response body.", "x-param-conflicts-with": ["count_only"], "required": false, "in": "query", "type": "boolean", "name": "mac_attachments"}, {"description": "Include MAC learning information with each Link Aggregation Group object in the response body.", "x-param-conflicts-with": ["count_only"], "required": false, "in": "query", "type": "boolean", "name": "mac_learning"}, {"description": "Return the array of Link Aggregation Group objects contained in the given page number.", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of Link Aggregation Group objects of the given size.", "required": false, "type": "integer", "name": "page_size", "in": "query"}, {"description": "Include an array of associated ports with each Link Aggregation Group object in the response body.", "x-param-conflicts-with": ["count_only"], "required": false, "in": "query", "type": "boolean", "name": "ports"}, {"enum": ["access", "fabric"], "description": "Filter the result set based on the value of each object's `type` property value, which can be one of:\n* `access`: exist by default on switches and are for general use.\n* `fabric`: are special ports, used solely for fabric switch-to-switch connections\n", "required": false, "in": "query", "type": "string", "name": "port_type"}, {"description": "Include related tag list as a property of each object in the response body", "required": false, "type": "boolean", "name": "tags", "in": "query"}, {"enum": ["internal", "provisioned"], "description": "Filter the result set based on the value of each object's `type` property value.\n* Link Aggregation Groups with type `provisioned` have been explicitly configured on switches and can contain one or more ports.\n* Link Aggregation Groups with type `internal` exist by default on switches and contain only one port. Think of these as objects that simply hold configuration state (e.g. configured line speed).", "required": false, "in": "query", "type": "string", "name": "type"}, {"description": "Include an array of associated VLAN Group objects with each Link Aggregation Group object in the response body.", "x-param-conflicts-with": ["count_only"], "required": false, "in": "query", "type": "boolean", "name": "vlan_groups"}], "produces": ["application/json; version=1.0"], "tags": ["lags"], "summary": "Get an array of LAG objects", "operationId": "listLags"}, "delete": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/lag_list_response"}}, "400": {"description": "One or more LAG UUIDs are invalid; returned upon the first invalid UUID discovered", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "One or more LAG UUIDs do not exist; returned upon the first non-existent UUID discovered", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "\n If any related tags exist which will be orphaned as a result of deleting the object, those tags will also be deleted.", "parameters": [{"description": "Delete provisioned LAGs for the given list of provisioned LAG UUIDs.\n* Note that while the data type is `Array[string]`, the parameter value constructed by clients must be a string representation: a comma-separated list of UUIDs.\n* Limiting the value of this parameter to one UUID is also valid.", "items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "required": true, "collectionFormat": "csv", "in": "query", "type": "array", "name": "lags"}, {"description": "Do not disable related ports and remove the native VLAN when this boolean is True.", "required": false, "type": "boolean", "name": "edge_safe", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["lags"], "summary": "Delete multiple provisioned LAG objects", "operationId": "deleteLags"}}, "/lags/mac_learning_defaults": {"put": {"responses": {"200": {"description": "MAC Learning Defaults Updated Successfully", "schema": {"$ref": "#/definitions/mac_learning_default_config_response"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"schema": {"$ref": "#/definitions/mac_learning_default_config"}, "description": "MAC learning configuration", "required": true, "name": "body", "in": "body"}], "tags": ["lags"], "produces": ["application/json; version=1.0"], "operationId": "updateMacLearningDefaultConfig", "consumes": ["application/json"], "summary": "Update the default MAC learning configuration"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/mac_learning_default_config_response"}}, "404": {"description": "Default Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "produces": ["application/json; version=1.0"], "description": "", "tags": ["lags"], "summary": "Get the default MAC learning configuration", "operationId": "getMacLearningDefaultConfig"}}, "/lags/{uuid}": {"put": {"responses": {"422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/Response"}}, "202": {"description": "Request to update Link Aggregation Group accepted", "schema": {"$ref": "#/definitions/AcceptedResponse"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "409": {"description": "Link Aggregation Groups Concurrent modification", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Update a Link Aggregation Group object by its UUID.", "parameters": [{"in": "path", "description": "UUID of Link Aggregation Group object to update", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"schema": {"$ref": "#/definitions/lag_update"}, "description": "Link Aggregation Group configuration\nTo modify only specific fields within the lag's mac learning configuration, set the unmodified fields to `null`.\nFor example, only update `aging=true`:\n```\n\"mac_learning_configuration\":\n{\n\"learning_limit\": null,\n\"aging\": true\n\"violation_action\": null\n\"mode\": null,\n }\n```\nNote that the following example shows all fields updated.", "required": true, "name": "body", "in": "body"}], "produces": ["application/json; version=1.0"], "tags": ["lags"], "summary": "Update a LAG by UUID", "operationId": "updateLag"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/lag_response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "202": {"description": "Success: Request has been accepted, but processing has not been completed.", "schema": {"$ref": "#/definitions/AcceptedResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Retrieve a Link Aggregation Group object by its UUID, optionally including an array of Port objects and/or VLAN Group objects related to the Link Aggregation Group.", "parameters": [{"in": "path", "description": "UUID of Link Aggregation Group object to return", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"description": "If there is a L2VPN object associated with this object, return the L2VPN's UUID", "required": false, "type": "boolean", "name": "l2vpn", "in": "query"}, {"description": "Include an array of associated MAC attachments.", "required": false, "type": "boolean", "name": "mac_attachments", "in": "query"}, {"description": "Include MAC learning information.", "required": false, "type": "boolean", "name": "mac_learning", "in": "query"}, {"description": "Include an array of associated ports.", "required": false, "type": "boolean", "name": "ports", "in": "query"}, {"description": "Include related tag list as a property of the object in the response body", "required": false, "type": "boolean", "name": "tags", "in": "query"}, {"description": "Include an array of associated VLAN Group objects.", "required": false, "type": "boolean", "name": "vlan_groups", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["lags"], "summary": "Get a LAG by UUID", "operationId": "getLag"}, "delete": {"responses": {"422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "200": {"description": "Link Aggregation Group deleted successfully", "schema": {"$ref": "#/definitions/Response"}}, "202": {"description": "Request to delete Link Aggregation Group accepted", "schema": {"$ref": "#/definitions/AcceptedResponse"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "LAG with UUID requested does not exist", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Deletes a single provisioned Link Aggregation Group object.", "parameters": [{"in": "path", "description": "UUID of provisioned Link Aggregation Group to delete", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"description": "Do not disable related ports and remove the native VLAN when this boolean is True.", "required": false, "type": "boolean", "name": "edge_safe", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["lags"], "summary": "Delete a provisioned LAG by UUID", "operationId": "deleteLag"}}, "/mac_attachments": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/mac_attachment_object_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Retrieve an array of MAC attachments. NOTE:\n* Most query parameters can contain more than one item.\n* A logical `OR` operation is performed when filtering items of a particular type\n* A logical `AND` operation is performed when query parameters of differing types are used", "parameters": [{"description": "Return only the count of MAC attachment objects in the `result` property of the response.\n", "x-param-conflicts-with": ["interfaces"], "required": false, "in": "query", "type": "boolean", "name": "count_only"}, {"description": "Return the port or LAG the MAC attachment object was learned on in the `result` property of the response.\n", "default": false, "x-param-conflicts-with": ["count_only"], "required": false, "in": "query", "type": "boolean", "name": "interfaces"}, {"description": "Return the array of MAC attachment objects contained in the given page number", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of MAC attachment objects of the given size", "required": false, "type": "integer", "name": "page_size", "in": "query"}, {"collectionFormat": "csv", "items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "description": "Get MAC attachments for the given list of switch UUIDs.\n* Note that while the data type is `Array[string]`, the parameter value constructed by clients must be a string representation: a comma-separated list of UUIDs.\n* Limiting the value of this parameter to one UUID is also valid.", "required": false, "in": "query", "type": "array", "name": "switches"}, {"collectionFormat": "csv", "items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "description": "Get MAC attachments for the given list of port UUIDs.\n* Note that while the data type is `Array[string]`, the parameter value constructed by clients must be a string representation: a comma-separated list of UUIDs.\n* Limiting the value of this parameter to one UUID is also valid.", "required": false, "in": "query", "type": "array", "name": "ports"}, {"collectionFormat": "csv", "items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "description": "Get MAC attachments for the given list of LAG UUIDs.\n* Note that while the data type is `Array[string]`, the parameter value constructed by clients must be a string representation: a comma-separated list of UUIDs.\n* Limiting the value of this parameter to one UUID is also valid.", "required": false, "in": "query", "type": "array", "name": "lags"}, {"collectionFormat": "csv", "items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "description": "Get MAC attachments learned on the given list of interface UUIDs.\n* Note that while the data type is `Array[string]`, the parameter value constructed by clients must be a string representation: a comma-separated list of UUIDs.\n* Limiting the value of this parameter to one UUID is also valid.", "required": false, "in": "query", "type": "array", "name": "interface_uuids"}, {"description": "Return a list of MAC Attachments for given list of MAC Addresses.\n* Note that while the data type is `Array[string]`, the parameter value constructed by clients must be a string representation: a comma-separated list of url-encoded MAC addresses.", "items": {"type": "string", "format": "mac_address"}, "required": false, "collectionFormat": "csv", "in": "query", "type": "array", "name": "mac_addresses"}, {"description": "Return a list of MAC attachments matching an MAC address OUI prefix.\nThe parameter value constructed by clients must be a string representation: a url-encoded MAC address OUI prefix.\n* The first 3 bytes are used to filter the request.\n* The last 3 are ignored.\nFor example: `AB:CD:EF:XX:XX:XX` Will return all MAC addresses with a OUI prefix of `AB:CD:EF`", "format": "mac_address", "required": false, "in": "query", "type": "string", "name": "oui"}, {"description": "Return a list of MAC attachments matching the list of VLANs.", "items": {"minimum": 1, "type": "integer", "maximum": 4000}, "required": false, "collectionFormat": "csv", "in": "query", "type": "array", "name": "vlan"}, {"description": "Return a list of MAC attachments learned on the list of VNIs.", "items": {"minimum": 1, "type": "integer"}, "required": false, "collectionFormat": "csv", "in": "query", "type": "array", "name": "vni"}, {"enum": ["lag", "port"], "description": "Return a list of MAC attachments learned on either a port or lag.", "required": false, "in": "query", "type": "string", "name": "interface_type"}], "produces": ["application/json; version=1.0"], "tags": ["mac_attachments"], "summary": "Get a list of MAC attachments filtering output by query parameters.", "operationId": "getMacAttachments"}}, "/mac_attachments/refresh": {"put": {"responses": {"400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "204": {"description": "Refresh Success"}}, "description": "Retrieve MAC attachments from a switch, a set of switches, or all switches and repopulate the persistent store.\n *CAUTION:* This action will result in the deletion of all MAC attachments in the persistent store prior to fetching them from the switches specified.", "parameters": [{"required": true, "type": "string", "name": "Content-Type", "enum": ["application/json"], "in": "header"}, {"collectionFormat": "csv", "items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "description": "Refresh MAC attachments for the switch or set of switches specified.", "required": false, "in": "query", "type": "array", "name": "switches"}], "produces": ["application/json; version=1.0"], "tags": ["mac_attachments"], "summary": "Refresh MAC attachments in persistent store.", "operationId": "refreshMacAttachment"}}, "/mac_attachments/{uuid}": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/mac_attachment_object_response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "parameters": [{"in": "path", "description": "UUID", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"description": "Return the port or LAG the MAC attachment object was learned on in the `result` property of the response.\n", "default": false, "required": false, "in": "query", "type": "boolean", "name": "interfaces"}], "produces": ["application/json; version=1.0"], "tags": ["mac_attachments"], "summary": "Get MAC attachment by UUID", "operationId": "getMacAttachment"}}, "/neighbor_discovery/configurations": {"post": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/neighbor_discovery_configuration_response"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "The UUID of a successfully added Neighbor Discovery Configuration will be returned", "parameters": [{"required": true, "description": "Neighbor discovery configuration to create.", "schema": {"$ref": "#/definitions/neighbor_discovery_configuration_create"}, "name": "body", "in": "body"}], "tags": ["neighbor_discovery"], "produces": ["application/json; version=1.0"], "operationId": "addNeighborDiscoveryConfiguration", "consumes": ["application/json"], "summary": "Add a new Neighbor Discovery Configuration switch override"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/neighbor_discovery_configuration_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Retrieve an array of neighbor discovery configurations, optionally filtered by fabric or switch.", "parameters": [{"description": "Return the number of discovery configuration objects", "required": false, "type": "boolean", "name": "count_only", "in": "query"}, {"in": "query", "description": "Return neighbor discovery configuration for the fabric as specified by its UUID.", "minLength": 32, "required": false, "maxLength": 36, "type": "string", "name": "fabric"}, {"in": "query", "description": "Return neighbor discovery configuration for the switch as specified by its UUID.", "minLength": 32, "required": false, "maxLength": 36, "type": "string", "name": "switch"}], "produces": ["application/json; version=1.0"], "tags": ["neighbor_discovery"], "summary": "Get an array of neighbor discovery configurations", "operationId": "getNeighborDiscoveryConfigurations"}}, "/neighbor_discovery/configurations/{uuid}": {"put": {"responses": {"200": {"description": "Successfully updated Neighbor Discovery configuration", "schema": {"$ref": "#/definitions/neighbor_discovery_configuration_response"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Update a neighbor discovery protocol configuration and return the modified fabric configuration object.", "parameters": [{"in": "path", "description": "UUID of the neighbor discovery configuration object", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"schema": {"$ref": "#/definitions/neighbor_discovery_configuration_update"}, "description": "Neighbor Discovery configuration object.", "required": true, "name": "body", "in": "body"}], "tags": ["neighbor_discovery"], "produces": ["application/json; version=1.0"], "operationId": "updateNeighborDiscoveryConfiguration", "consumes": ["application/json"], "summary": "Modify an existing neighbor discovery protocol configuration"}, "delete": {"responses": {"200": {"description": "Neighbor Discovery Configuration deleted successfully", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Deletes a single Neighbor Discovery Configuration object", "parameters": [{"in": "path", "description": "UUID of the Neighbor Discovery Configuration to delete", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["neighbor_discovery"], "summary": "Delete a Neighbor Discovery Configuration by UUID", "operationId": "deleteNeighborDiscoveryConfiguration"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/neighbor_discovery_configuration_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "parameters": [{"in": "path", "description": "UUID of the neighbor discovery configuration", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["neighbor_discovery"], "summary": "Get a neighbor discovery configuration by UUID", "operationId": "getNeighborDiscoveryConfiguration"}}, "/neighbor_discovery/neighbor/refresh": {"put": {"responses": {"400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "204": {"description": "Refresh success"}}, "description": "Retrieve neighbor discovery neighbors from a switch, a set of switches, or all switches and repopulate the persistent store.\n *CAUTION:* This action will result in the deletion of all neighbors in the persistent store prior to fetching them from the switches specified.", "parameters": [{"required": true, "type": "string", "name": "Content-Type", "enum": ["application/json"], "in": "header"}, {"collectionFormat": "csv", "items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "description": "Refresh neighbor neighbors for the switch or set of switches specified.", "required": false, "in": "query", "type": "array", "name": "switches"}], "tags": ["neighbor_discovery"], "produces": ["application/json; version=1.0"], "operationId": "refreshNeighborDiscoveryAdvertisement", "consumes": ["application/json"], "summary": "Refresh neighbor discovery neighbors in persistent store"}}, "/neighbor_discovery/neighbors": {"post": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/CreationWithIdResponse"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "This API is used to create a user-defined neighbor discovery neighbor. In order to create one, the port, switch, chassis ID and port ID _must_ be specified.\nThe UUID of a successfully added User-Defined Neighbor will be returned", "parameters": [{"required": true, "description": "User-Defined Neighbor\n * port_uuid - port UUID\n * switch_uuid - switch UUID\n * chassis_id - chassis ID\n * port_id - port ID\n", "schema": {"$ref": "#/definitions/neighbor_discovery_advertisement_create"}, "name": "body", "in": "body"}], "tags": ["neighbor_discovery"], "produces": ["application/json; version=1.0"], "operationId": "addNeighborDiscoveryAdvertisement", "consumes": ["application/json"], "summary": "Add a user-defined Neighbor"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/neighbor_discovery_advertisement_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Retrieve an array of neighbor discovery neighbors.", "parameters": [{"enum": ["cdp", "lldp", "user"], "description": "Return only the neighbor discovery neighbor objects of the given type, or, if used in conjunction with `count_only` will return the count of that type.", "required": false, "in": "query", "type": "string", "name": "type"}, {"collectionFormat": "csv", "items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "description": "Return neighbors for the given list of switch UUIDs.\n* Note that while the data type is `Array[string]`, the parameter value constructed by clients must be a string representation: a comma-separated list of UUIDs.\n* Limiting the value of this parameter to one UUID is also valid.", "required": false, "in": "query", "type": "array", "name": "switches"}, {"collectionFormat": "csv", "items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "description": "Return neighbors for the given list of port UUIDs.\n* Note that while the data type is `Array[string]`, the parameter value constructed by clients must be a string representation: a comma-separated list of UUIDs.\n* Limiting the value of this parameter to one UUID is also valid.", "required": false, "in": "query", "type": "array", "name": "ports"}, {"description": "Neighbor with matching Chassis ID", "required": false, "type": "string", "name": "chassis_id", "in": "query"}, {"description": "Neighbor with matching Port ID", "required": false, "type": "string", "name": "port_id", "in": "query"}, {"description": "When set to True, include neighbors that are no longer active, but have yet to be deleted (i.e., `stale` neighbors).", "default": false, "required": false, "in": "query", "type": "boolean", "name": "include_stale"}, {"description": "Return only the count of attachment objects in the `result` property of the response.\n* With no other parameters, this returns an object with counts for each vendor.\n* When combined with the `type` parameter, this only returns the integer count of objects of that type.", "required": false, "type": "boolean", "name": "count_only", "in": "query"}, {"description": "Return the array of neighbor objects contained in the given page number", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of neighbor objects of the given size", "required": false, "type": "integer", "name": "page_size", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["neighbor_discovery"], "summary": "Get all neighbor discovery neighbors", "operationId": "getNeighborDiscoveryAdvertisements"}}, "/neighbor_discovery/neighbors/{uuid}": {"put": {"responses": {"200": {"description": "The updated Neighbor Discovery neighbor", "schema": {"$ref": "#/definitions/neighbor_discovery_advertisement_response"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Update a neighbor discovery neighbor and return the modified object.", "parameters": [{"in": "path", "description": "UUID of user-defined neighbor", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"description": "Neighbor Discovery neighbor object.", "schema": {"$ref": "#/definitions/neighbor_discovery_advertisement_update"}, "name": "body", "in": "body"}], "tags": ["neighbor_discovery"], "produces": ["application/json; version=1.0"], "operationId": "updateNeighborDiscoveryAdvertisement", "consumes": ["application/json"], "summary": "Modify an existing user-defined neighbor discovery neighbor"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/neighbor_discovery_advertisement_response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Retrieve neighbor discovery neighbor", "parameters": [{"in": "path", "description": "UUID", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["neighbor_discovery"], "summary": "Get neighbor discovery neighbor by UUID", "operationId": "getNeighborDiscoveryAdvertisement"}, "delete": {"responses": {"200": {"description": "User-defined neighbor deleted successfully", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Deletes a single user-defined neighbor.", "parameters": [{"in": "path", "description": "UUID of _user-defined_ neighbor to delete", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["neighbor_discovery"], "summary": "Delete a user-defined neighbor by UUID", "operationId": "deleteUserDefinedAdvertisement"}}, "/neighbor_discovery/statistics": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/neighbor_discovery_statistic_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Retrieve an array of neighbor discovery statistics.", "parameters": [{"in": "query", "description": "Get LLDP stats for the switch identified by this UUID", "minLength": 32, "required": false, "maxLength": 36, "type": "string", "name": "switch"}, {"in": "query", "description": "Get LLDP stats for all switches in the fabric identified by this UUID", "minLength": 32, "required": false, "maxLength": 36, "type": "string", "name": "fabric"}], "produces": ["application/json; version=1.0"], "tags": ["neighbor_discovery"], "summary": "Get neighbor discovery statistics", "operationId": "getNeighborDiscoveryStatistics"}}, "/ntp_client_configurations": {"post": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ntp_client_configuration_response"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "The UUID of a successfully added NTP Client Configuration will be returned", "parameters": [{"required": true, "description": "NTP Client Configuration\n * description - describes this NTP object.\n * name - names this NTP object.\n * servers - list of NTP servers in IPv4, IPv6 or hostname format.\n\nTo create a NTP Client Configuration's associations with:\n * fabric_uuids: UUIDs of any fabrics with which this configuration is associated.\n * switch_uuids: UUIDs of any switches with which this configuration is associated.\n\n", "schema": {"$ref": "#/definitions/ntp_client_configuration_create"}, "name": "body", "in": "body"}], "tags": ["ntp_client_configurations"], "produces": ["application/json; version=1.0"], "operationId": "addNtp", "consumes": ["application/json"], "summary": "Add a new NTP Client Configuration"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ntp_client_configuration_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Retrieve an array of NTP objects, optionally filtered based on its usage by a fabric, or a switch", "parameters": [{"description": "Return only the count of NTP objects in the `result` property of the response", "required": false, "type": "boolean", "name": "count_only", "in": "query"}, {"description": "Return the array of NTP Client Configuration objects contained in the given page number", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of NTP Client Configuration objects of the given size", "required": false, "type": "integer", "name": "page_size", "in": "query"}, {"in": "query", "description": "Return the NTP objects associated with the fabric with the given UUID", "minLength": 32, "required": false, "maxLength": 36, "type": "string", "name": "fabric"}, {"in": "query", "description": "Return the NTP objects associated with the switch with the given UUID", "minLength": 32, "required": false, "maxLength": 36, "type": "string", "name": "switch"}], "produces": ["application/json; version=1.0"], "tags": ["ntp_client_configurations"], "summary": "Get an array of NTP configurations", "operationId": "listNtp"}}, "/ntp_client_configurations/{uuid}": {"put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ntp_client_configuration_response"}}, "400": {"description": "Invalid Input)", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Update a NTP Client Configuration object by its UUID", "parameters": [{"in": "path", "description": "UUID of NTP Client Configuration object to update", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"schema": {"$ref": "#/definitions/ntp_client_configuration_update"}, "description": "NTP Client Configuration\nTo create a NTP Client Configuration attributes with:\n * description - describes this NTP object.\n * name - names this NTP object.\n * servers - list of NTP servers in IPv4, IPv6 or hostname format.\n\nTo create a NTP Client Configuration's associations with:\n * fabric_uuids: UUIDs of any fabrics with which this configuration is associated.\n * switch_uuids: UUIDs of any switches with which this configuration is associated.\n", "required": true, "name": "body", "in": "body"}], "produces": ["application/json; version=1.0"], "tags": ["ntp_client_configurations"], "summary": "Update a NTP Client Configuration by UUID", "operationId": "updateNtp"}, "delete": {"responses": {"200": {"description": "NTP Client Configuration deleted successfully", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Deletes a single NTP Client Configuration object", "parameters": [{"in": "path", "description": "UUID of NTP Client Configuration to delete", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["ntp_client_configurations"], "summary": "Delete a NTP Client Configuration by UUID", "operationId": "deleteNtp"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ntp_client_configuration_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Retrieve a NTP Client Configuration by its UUID", "parameters": [{"in": "path", "description": "UUID of NTP Client Configuration object to return", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["ntp_client_configurations"], "summary": "Get a NTP Client Configuration by UUID", "operationId": "getNtp"}}, "/nutanix/prisms": {"post": {"responses": {"200": {"description": "Configuration Added Successfully", "schema": {"allOf": [{"$ref": "#/definitions/Response"}, {"properties": {"result": {"type": "string", "description": "Empty if `verify_only=true` or `verify_snmp_only=true`. UUID of the newly created configuration otherwise", "example": "5d6a00bd286a497581e8879a2ce333e1"}}}]}}, "400": {"description": "Invalid Input or Connection Verification Failed", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"schema": {"$ref": "#/definitions/nutanix_pack_config_create"}, "description": "Nutanix Prism", "required": true, "name": "body", "in": "body"}, {"description": "* Limits request to verification of config data by establishing a connection to the server.\n* The pack configuration will not be created.\n* The `result` property in a success response will be empty.", "required": false, "type": "boolean", "name": "verify_only", "in": "query"}, {"description": "* Limits request to a verification of SNMP switch configuration. Each fabric/switch must have an associated SNMP configuration\n* The pack configuration will not be created.\n* The `result` property in a success response will be empty.", "required": false, "type": "boolean", "name": "verify_snmp_only", "in": "query"}], "tags": ["nutanix"], "produces": ["application/json; version=1.0"], "operationId": "addNutanixConfig", "consumes": ["application/json"], "summary": "Add a new Nutanix Prism configuration"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/nutanix_pack_config_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "202": {"description": "Success: Request has been accepted, but processing has not been completed.", "schema": {"$ref": "#/definitions/AcceptedResponse"}}}, "description": "", "parameters": [{"description": "Return only the count of Nutanix pack configurations (connected Nutanix Prism instances / clusters).", "required": false, "type": "boolean", "name": "count_only", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["nutanix"], "summary": "Get an array of Nutanix Prism configurations", "operationId": "listNutanixConfig"}}, "/nutanix/prisms/{uuid}": {"put": {"responses": {"200": {"description": "Configuration Updated Successfully", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of configuration to update", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"description": "* Limits request to verification of config data by establishing a connection to the server.\n* The pack configuration will not be updated.\n* The `result` property in a success response will be empty.", "required": false, "type": "boolean", "name": "verify_only", "in": "query"}, {"schema": {"$ref": "#/definitions/nutanix_pack_config_update"}, "description": "Nutanix Prism configuration", "required": true, "name": "body", "in": "body"}, {"description": "* Limits request to a verification of SNMP switch configuration. Each fabric/switch must have an associated SNMP configuration\n* The pack configuration will not be created.\n* The `result` property in a success response will be empty.", "required": false, "type": "boolean", "name": "verify_snmp_only", "in": "query"}], "tags": ["nutanix"], "produces": ["application/json; version=1.0"], "operationId": "updateNutanixConfig", "consumes": ["application/json"], "summary": "Update a Nutanix Prism configuration by UUID"}, "delete": {"responses": {"200": {"description": "Configuration Deleted Successfully", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of configuration to delete", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["nutanix"], "summary": "Delete a Nutanix Prism configuration by UUID", "operationId": "deleteNutanixConfig"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/nutanix_pack_config_response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of configuration to return", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["nutanix"], "summary": "Get a Nutanix Prism configuration by UUID", "operationId": "getNutanixConfig"}}, "/nutanix/prisms/{uuid}/refresh": {"post": {"responses": {"200": {"description": "Connection Verification Succeeded", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid UUID or Connection Verification Failed", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of Nutanix Prism configuration to refresh", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"required": true, "type": "string", "name": "Content-Type", "enum": ["application/json"], "in": "header"}], "produces": ["application/json; version=1.0"], "tags": ["nutanix"], "summary": "Refresh data learned from a Nutanix Prism instance by UUID", "operationId": "refreshNutanixData"}}, "/nutanix/prisms/{uuid}/verify": {"post": {"responses": {"200": {"description": "Connection Verification Succeeded", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid UUID or Connection Verification Failed", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of configuration to verify", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"required": true, "type": "string", "name": "Content-Type", "enum": ["application/json"], "in": "header"}], "tags": ["nutanix"], "produces": ["application/json; version=1.0"], "operationId": "verifyNutanixConfig", "consumes": ["application/json"], "summary": "Verify connectivity of a Nutanix Prism configuration by UUID"}}, "/openapi": {"get": {"responses": {"200": {"description": "JSON document", "schema": {"type": "string", "example": ""}}}, "description": "This endpoint does not require authentication.", "produces": ["application/json; version=1.0"], "tags": ["openapi"], "summary": "Get the Composable Fabric Manager OpenAPI Schema", "security": [], "operationId": "getConnectOpenApiSchema"}}, "/path_actors": {"post": {"responses": {"200": {"description": "path actor added successfully", "schema": {"$ref": "#/definitions/CreationWithIdResponse"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "The UUID of a successfully added path actors will be returned.", "parameters": [{"description": "path actor object.", "schema": {"$ref": "#/definitions/path_actor_create"}, "name": "body", "in": "body"}], "tags": ["path_actors"], "produces": ["application/json; version=1.0"], "operationId": "addPathActor", "consumes": ["application/json"], "summary": "Add a new path actor object"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/path_actor_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Retrieve an array of Path Actor objects", "parameters": [{"description": "Return path actors that match the topology uuid", "required": false, "type": "string", "name": "topology_uuid", "in": "query"}, {"description": "Return only the count of Path Actor objects in the `result` property of the response.", "required": false, "type": "boolean", "name": "count_only", "in": "query"}, {"description": "Return the array of Path Actor objects contained in the given page number.", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of Path Actor objects of the given size.", "required": false, "type": "integer", "name": "page_size", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["path_actors"], "summary": "Get an array of Path Actor objects", "operationId": "listPathActors"}}, "/path_actors/{uuid}": {"put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/path_actor_response"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Update a path actor object by its UUID.", "parameters": [{"in": "path", "description": "UUID of path actor object to update", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"schema": {"$ref": "#/definitions/path_actor_update"}, "description": "path actor.", "required": true, "name": "body", "in": "body"}], "produces": ["application/json; version=1.0"], "tags": ["path_actors"], "summary": "Update a path actor by UUID", "operationId": "updatePathActor"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/path_actor_response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Retrieve a path actor object by its UUID.", "parameters": [{"in": "path", "description": "UUID of path actor object to return", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["path_actors"], "summary": "Get a path actor by UUID", "operationId": "getPathActor"}, "delete": {"responses": {"200": {"description": "path actor deleted successfully", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Deletes a single provisioned path actor object.", "parameters": [{"in": "path", "description": "UUID of path actor to delete", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["path_actors"], "summary": "Delete a path actor by UUID", "operationId": "deletePathActor"}}, "/peers": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/peer_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "202": {"description": "Success: Request has been accepted, but processing has not been completed.", "schema": {"$ref": "#/definitions/AcceptedResponse"}}, "422": {"description": "Error: Unprocessable due to switch communication error", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Retrieve an array of Peer objects.", "parameters": [{"in": "query", "description": "UUID of fabric for which associated switch peer data will be returned.", "minLength": 32, "required": false, "maxLength": 36, "type": "string", "name": "fabric_uuid"}], "produces": ["application/json; version=1.0"], "tags": ["peers"], "summary": "Get an array of Peer objects", "operationId": "listPeers"}}, "/ping": {"get": {"responses": {"204": {"description": "Composable Fabric Manager API is operational.", "schema": {"$ref": "#/definitions/ping_response"}}}, "description": "* This endpoint does not require authentication\n* This endpoint simply confirms that the Composable Fabric Manager API is generally operational.", "produces": ["application/json"], "tags": ["ping"], "summary": "Composable Fabric Manager API status check", "security": [], "operationId": "getPing"}}, "/pods": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/pod_generic_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "202": {"description": "Success: Request has been accepted, but processing has not been completed.", "schema": {"$ref": "#/definitions/AcceptedResponse"}}}, "description": "Get Kubernetes/OpenShift pods. \nThe following parameters are mutually exclusive: `hosts`, `manager`, `vendor`", "parameters": [{"description": "Return only the count of pod objects in the `result` property of the response.\n* With no other parameters, this returns an object with counts for each vendor.\n* When combined with the `vendor` parameter, this only returns the integer count of objects of that vendor.", "x-param-conflicts-with": ["nics"], "required": false, "in": "query", "type": "boolean", "name": "count_only"}, {"name": "hosts", "in": "query", "items": {"type": "string"}, "x-param-conflicts-with": ["manager", "vendor"], "required": false, "type": "array", "collectionFormat": "csv", "description": "Return Pods for the given list of host UUIDs.\n* Note that while the data type is `Array[string]`, the parameter value constructed by clients must be a string representation: a comma-separated list of UUIDs.\n* Limiting the value of this parameter to one UUID is also valid.\n* To match `pod` objects which have an empty `host_uuid` property, use `null` as the value for this parameter. Note that in that case, other values will be ignored."}, {"description": "Return only pods for the given infrastructure manager UUID", "x-param-conflicts-with": ["hosts", "vendor"], "required": false, "in": "query", "type": "string", "name": "manager"}, {"description": "Include array of pod NICs with each pod", "x-param-conflicts-with": ["count_only"], "required": false, "in": "query", "type": "boolean", "name": "nics"}, {"description": "Return the array of pod objects contained in the given page number", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of pod objects of the given size", "required": false, "type": "integer", "name": "page_size", "in": "query"}, {"enum": ["kubernetes"], "description": "Return only pods hosted on the given vendor's infrastructure", "x-param-conflicts-with": ["hosts", "manager"], "required": false, "in": "query", "type": "string", "name": "vendor"}], "produces": ["application/json; version=1.0"], "tags": ["pods"], "summary": "Get an array of pods", "operationId": "listPods"}}, "/pods/{uuid}": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/pod_generic_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "202": {"description": "Success: Request has been accepted, but processing has not been completed.", "schema": {"$ref": "#/definitions/AcceptedResponse"}}, "404": {"description": "Pod Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Returns a single pod with the given UUID.", "parameters": [{"description": "UUID of pod to return", "minLength": 32, "required": true, "in": "path", "type": "string", "name": "uuid"}, {"description": "Include array of pod NICs with each pod", "required": false, "type": "boolean", "name": "nics", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["pods"], "summary": "Get a pod by UUID", "operationId": "getPodByUuid"}}, "/port_mirrors": {"post": {"responses": {"200": {"description": "Port mirror configuration updated successfully", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"schema": {"$ref": "#/definitions/port_mirror_update"}, "description": "Port mirror configuration to be added.", "required": true, "name": "body", "in": "body"}], "tags": ["port_mirrors"], "produces": ["application/json; version=1.0"], "operationId": "AddPortMirrors", "consumes": ["application/json"], "summary": "Add a new port mirror configuration"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/port_mirror_list_response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "Return the port mirror configurations for the given fabric UUID.", "required": false, "type": "uuid_opt_hyphenated", "name": "fabric_uuid", "in": "query"}, {"collectionFormat": "csv", "items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "description": "Return port mirror configurations for the given list of switch UUIDs.\n* Note that while the data type is `Array[string]`, the parameter value constructed by clients must be a string representation: a comma-separated list of UUIDs.\n* Limiting the value of this parameter to one UUID is also valid.", "required": false, "in": "query", "type": "array", "name": "switches"}, {"description": "Include an array of associated ports with each Port Mirror object", "required": false, "type": "boolean", "name": "ports", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["port_mirrors"], "summary": "Get port mirror configurations", "operationId": "getPortMirrors"}}, "/port_mirrors/{uuid}": {"put": {"responses": {"200": {"description": "Port mirror configuration updated successfully", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"schema": {"$ref": "#/definitions/port_mirror_update"}, "description": "Port mirror properties to be updated.", "required": true, "name": "body", "in": "body"}], "tags": ["port_mirrors"], "produces": ["application/json; version=1.0"], "operationId": "updatePortMirrorsByMirrorUUID", "consumes": ["application/json"], "summary": "Update port mirror configuration for given mirror UUID"}, "delete": {"responses": {"200": {"description": "Port mirror configuration deleted successfully", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of the mirror to delete", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "tags": ["port_mirrors"], "produces": ["application/json; version=1.0"], "operationId": "deletePortMirrorsByMirrorUUID", "consumes": ["application/json"], "summary": "Delete port mirror configuration for given mirror UUID"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/port_mirror_response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of the mirror to get", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"description": "Include an array of associated ports with the Port Mirror object", "required": false, "type": "boolean", "name": "ports", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["port_mirrors"], "summary": "Get port mirror configuration", "operationId": "getPortMirrorByUUID"}}, "/ports": {"patch": {"responses": {"422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "200": {"description": "Ports updated Successfully", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Invalid Request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "409": {"description": "Ports Concurrent modification", "schema": {"allOf": [{"$ref": "#/definitions/ErrorResponse"}]}}}, "description": "Update one or more ports using JSON patch(es) with their UUIDs.\nThe following patch __`operation`__ is supported:\n* `replace`\n\nThe following patch __`paths`__ are supported for access ports:\n* `/admin_state`\n* `/description`\n* `/downlink_switch_uuid`\n* `/fec`\n* `/name`\n* `/native_vlan`\n* `/speed/current`\n* `/tags`\n* `/type`\n* `/ungrouped_vlans`\n* `/qsfp_mode`\n* `/vlan_group_uuids`\n* `/bridge_loop_detection/mode`\n* `/bridge_loop_detection/interval`\n\nThe following patch __`paths`__ are supported for fabric ports:\n* `/fec`\n* `/type`\n* `/qsfp_mode`\n\nNotes:\nPatches are applied as follows:\n* Either the __`update_all`__ query parameter or __`uuids`__ property in the request body object must be provided\n* If a list of __`uuids`__ are provided in the request body:\n * The UUIDs must be associated with the ports\n * The matching __`patch`__ in the body will be applied to all ports whose UUID is in the __`uuids`__ list\n * Note that the use of the __`update_all`__ query parameter and inclusion of the __`uuids`__ property in the request object are mutually exclusive features.", "parameters": [{"description": "Apply an array of patches to port resources.", "schema": {"items": {"$ref": "#/definitions/port_patch_request"}, "type": "array"}, "name": "Port Patch Request", "in": "body"}, {"description": "Update all ports with the first patch request", "required": false, "type": "boolean", "name": "update_all", "in": "query"}], "tags": ["ports"], "produces": ["application/json; version=1.0"], "operationId": "updatePorts", "consumes": ["application/json"], "summary": "Patch Request to update Port objects"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/port_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "202": {"description": "Success: Request has been accepted, but processing has not been completed.", "schema": {"$ref": "#/definitions/AcceptedResponse"}}}, "description": "", "parameters": [{"description": "Return only the count of Port objects in the `result` property of the response.", "required": false, "type": "boolean", "name": "count_only", "in": "query"}, {"description": "Include port objects which qualify as a \"uplink\" port in the response body\n", "###\n* `true` - returns uplink ports \n* `false` - returns non-uplink ports \nNote : Uplink ports are ports that connect up to the core routing infrastructure from the switches.required": false, "type": "boolean", "name": "is_uplink", "in": "query"}, {"description": "If there is a L2VPN object associated with this object, return the L2VPN's UUID", "required": false, "type": "boolean", "name": "l2vpn", "in": "query"}, {"description": "Include related lag object as a property of each port object in the response body", "required": false, "type": "boolean", "name": "lag", "in": "query"}, {"description": "Return the array of Port objects contained in the given page number", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of Port objects of the given size", "required": false, "type": "integer", "name": "page_size", "in": "query"}, {"description": "Return an array of Port objects with the matching label", "required": false, "type": "string", "name": "port_label", "in": "query"}, {"description": "###\nInclude ports which have port security:\n* `true` - enabled or\n* `false` - disabled\n", "required": false, "type": "boolean", "name": "port_security_enabled", "in": "query"}, {"collectionFormat": "csv", "items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "description": "Return Ports for the given list of Switch UUIDs.\n* Note that while the data type is `Array[string]`, the parameter value constructed by clients must be a string representation: a comma-separated list of UUIDs.\n* Limiting the value of this parameter to one UUID is also valid.", "required": false, "in": "query", "type": "array", "name": "switches"}, {"description": "Include related tag list as a property of each object in the response body", "required": false, "type": "boolean", "name": "tags", "in": "query"}, {"description": "Include an array of related VLAN group objects as a property of each port object in the response body", "required": false, "type": "boolean", "name": "vlan_groups", "in": "query"}, {"enum": ["access", "fabric"], "description": "Filter the result set based on the value of each object's `type` property value, which can be one of:\n* `access`: exist by default on switches and are for general use.\n* `fabric`: are special ports, used solely for fabric switch-to-switch connections\n", "required": false, "in": "query", "type": "string", "name": "type"}, {"description": "Include an array of neighbor (learned via CDP, LLDP, or user-defined) within the neighbors property of each port object in the response body", "required": false, "type": "boolean", "name": "neighbors", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["ports"], "summary": "Get an array of Port objects", "operationId": "listPorts"}}, "/ports/statistics": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/port_statistic_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "Return only the count of Port statistic objects in the `result` property of the response.", "required": false, "type": "boolean", "name": "count_only", "in": "query"}, {"description": "Return the port statistic objects starting at the epoch time specified in this parameter", "format": "int64", "required": false, "in": "query", "type": "integer", "name": "start_time"}, {"description": "Return port statistic objects up to the epoch time specified in this parameter", "format": "int64", "required": false, "in": "query", "type": "integer", "name": "end_time"}, {"collectionFormat": "csv", "items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "description": "Return Port Statistics for the given list of Port UUIDs.\n* Note that while the data type is `Array[string]`, the parameter value constructed by clients must be a string representation: a comma-separated list of UUIDs.\n* Limiting the value of this parameter to one UUID is also valid.", "required": false, "in": "query", "type": "array", "name": "ports"}, {"collectionFormat": "csv", "items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "description": "Return Port Statistics for the given list of Switch UUIDs.\n* Note that while the data type is `Array[string]`, the parameter value constructed by clients must be a string representation: a comma-separated list of UUIDs.\n* Limiting the value of this parameter to one UUID is also valid.", "required": false, "in": "query", "type": "array", "name": "switches"}, {"in": "query", "description": "Return Port Statistics for all ports on all switches in this fabric", "minLength": 32, "required": false, "maxLength": 36, "type": "string", "name": "fabric uuid"}, {"enum": ["in_octets", "in_unicast_packets", "in_nunicast_packets", "in_ipv4_packets", "in_discards", "in_errors", "out_octets", "out_unicast_packets", "out_nunicast_packets", "out_ipv4_packets", "out_discards", "out_errors"], "description": "Filter the result set based on the statistic `type`.", "required": false, "in": "query", "type": "string", "name": "type"}], "produces": ["application/json; version=1.0"], "tags": ["ports"], "summary": "Get an array of Port statistic objects", "operationId": "listPortStats"}}, "/ports/statistics/{uuid}": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/port_statistic_response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "Return Port statistics identified by this UUID", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"enum": ["in_octets", "in_unicast_packets", "in_nunicast_packets", "in_ipv4_packets", "in_discards", "in_errors", "out_octets", "out_unicast_packets", "out_nunicast_packets", "out_ipv4_packets", "out_discards", "out_errors"], "description": "Filter the result set based on the statistic `type`.", "required": false, "in": "query", "type": "string", "name": "type"}], "produces": ["application/json; version=1.0"], "tags": ["ports"], "summary": "Get a Port's statistics by UUID", "operationId": "getPortStatsByUuid"}}, "/ports/{uuid}": {"put": {"responses": {"422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "200": {"description": "Ports Updated Successfully", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "409": {"description": "Ports Concurrent modification", "schema": {"allOf": [{"$ref": "#/definitions/ErrorResponse"}]}}}, "description": "* If the value `not_applicable` is submitted for the `qsfp_mode` property, it will be ignored.", "parameters": [{"in": "path", "description": "UUID of Port to update", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"schema": {"$ref": "#/definitions/port_update"}, "description": "Port properties to be updated.", "required": true, "name": "body", "in": "body"}], "tags": ["ports"], "produces": ["application/json; version=1.0"], "operationId": "updatePort", "consumes": ["application/json"], "summary": "Update a Port configuration by UUID"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/port_response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "202": {"description": "Success: Request has been accepted, but processing has not been completed.", "schema": {"$ref": "#/definitions/AcceptedResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of Port to return", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"description": "If there is a L2VPN object associated with this object, return the L2VPN's UUID", "required": false, "type": "boolean", "name": "l2vpn", "in": "query"}, {"description": "Include related lag object as a property of the port object in the response body", "required": false, "type": "boolean", "name": "lag", "in": "query"}, {"description": "Include an array of neighbor (learned via CDP, LLDP, or user-defined) within the neighbors property of each port object in the response body", "required": false, "type": "boolean", "name": "neighbors", "in": "query"}, {"description": "Include related tag list as a property of the object in the response body", "required": false, "type": "boolean", "name": "tags", "in": "query"}, {"description": "Include an array of related VLAN group objects as a property of the port object in the response body", "required": false, "type": "boolean", "name": "vlan_groups", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["ports"], "summary": "Get a Port by UUID", "operationId": "getPortByUuid"}}, "/qualifiers": {"post": {"description": "", "parameters": [{"description": "Qualifier Create", "schema": {"$ref": "#/definitions/qualifier_create"}, "name": "body", "in": "body"}], "produces": ["application/json; version=1.0"], "tags": ["qualifiers"], "summary": "Create a qualifier", "consumes": ["application/json"], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/CreationWithIdResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}, "delete": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Qualifier Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"collectionFormat": "csv", "items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "description": "Delete the qualifier objects for the given list of Qualifier UUIDs.\n* Note that while the data type is `Array[string]`, the parameter value constructed by clients must be a string representation: a comma-separated list of UUIDs.\n* Limiting the value of this parameter to one UUID is also valid.", "required": false, "in": "query", "type": "array", "name": "qualifiers"}], "tags": ["qualifiers"], "produces": ["application/json; version=1.0"], "operationId": "deleteQualifiers", "consumes": ["application/json"], "summary": "Delete qualifiers"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/qualifier_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "Return only the count of ACL objects in the `result` property of the response.", "required": false, "type": "boolean", "name": "count_only", "in": "query"}, {"description": "Return the array of ACL objects contained in the given page number.", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of ACL objects of the given size.", "required": false, "type": "integer", "name": "page_size", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["qualifiers"], "summary": "Get qualifiers", "operationId": "getQualifiers"}}, "/qualifiers/{uuid}": {"put": {"description": "", "parameters": [{"in": "path", "description": "UUID of the qualifier to update", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"description": "Qualifier Update", "schema": {"$ref": "#/definitions/qualifier_update"}, "name": "body", "in": "body"}], "produces": ["application/json; version=1.0"], "tags": ["qualifiers"], "summary": "Update a qualifier", "consumes": ["application/json"], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Qualifier Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}, "delete": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Qualifier Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of the qualifier to delete", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "tags": ["qualifiers"], "produces": ["application/json; version=1.0"], "operationId": "deleteQualifier", "consumes": ["application/json"], "summary": "Delete qualifier"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/qualifier_response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of the qualifier to get", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["qualifiers"], "summary": "Get a qualifier", "operationId": "getQualifier"}}, "/settings": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/setting_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [], "produces": ["application/json; version=1.0"], "tags": ["settings"], "summary": "Get an array of settings", "operationId": "listSettings"}}, "/settings/{key}": {"put": {"description": "", "parameters": [{"description": "Key of setting to update", "required": true, "type": "string", "name": "key", "in": "path"}, {"schema": {"$ref": "#/definitions/setting_update"}, "description": "Composable Fabric Manager Settings", "required": true, "name": "body", "in": "body"}], "produces": ["application/json; version=1.0"], "tags": ["settings"], "summary": "Update a setting by key", "consumes": ["application/json"], "responses": {"200": {"description": "Setting Updated Successfully", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Setting Key Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/setting_response"}}, "400": {"description": "Invalid Setting key", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Setting Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "Key of setting to return", "required": true, "type": "string", "name": "key", "in": "path"}], "produces": ["application/json; version=1.0"], "tags": ["settings"], "summary": "Get a setting by key", "operationId": "getSetting"}}, "/sflow_configurations": {"post": {"responses": {"200": {"description": "sFlow configuration added successfully", "schema": {"$ref": "#/definitions/CreationWithIdResponse"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "The UUID of a successfully added sFlow configuration will be returned.", "parameters": [{"description": "sFlow Configuration object.", "schema": {"$ref": "#/definitions/sflow_configuration_create"}, "name": "body", "in": "body"}], "tags": ["sflow_configurations"], "produces": ["application/json; version=1.0"], "operationId": "addSflowConfiguration", "consumes": ["application/json"], "summary": "Add a new sFlow configuration object"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/sflow_configuration_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Retrieve an array of sFlow configuration objects, optionally including an array of associated objects. ", "parameters": [{"description": "Return only the count of sFlow configuration objects in the `result` property of the response.", "required": false, "type": "boolean", "name": "count_only", "in": "query"}, {"in": "query", "description": "Return the sFlow configuration objects used by the fabric with the given UUID.", "minLength": 32, "required": false, "maxLength": 36, "type": "string", "name": "fabric"}, {"description": "Return the array of sFlow configuration objects contained in the given page number.", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of sFlow configuration objects of the given size.", "required": false, "type": "integer", "name": "page_size", "in": "query"}, {"in": "query", "description": "Return the sFlow configuration objects used by the switch with the given UUID.", "minLength": 32, "required": false, "maxLength": 36, "type": "string", "name": "switch"}], "produces": ["application/json; version=1.0"], "tags": ["sflow_configurations"], "summary": "Get an array of sFlow configuration objects", "operationId": "listSflowConfigurations"}}, "/sflow_configurations/{uuid}": {"put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/sflow_configuration_response"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Update an sFlow configuration object by its UUID.", "parameters": [{"in": "path", "description": "UUID of sFlow configuration object to update", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"schema": {"$ref": "#/definitions/sflow_configuration_update"}, "description": "sFlow configuration.", "required": true, "name": "body", "in": "body"}], "produces": ["application/json; version=1.0"], "tags": ["sflow_configurations"], "summary": "Update an sFlow configuration by UUID", "operationId": "updateSflowConfiguration"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/sflow_configuration_response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Retrieve an sFlow configuration object by its UUID.", "parameters": [{"in": "path", "description": "UUID of sFlow configuration object to return", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["sflow_configurations"], "summary": "Get an sFlow configuration by UUID", "operationId": "getSflowConfiguration"}, "delete": {"responses": {"200": {"description": "sFlow configuration deleted successfully", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Deletes a single provisioned sFlow configuration object.", "parameters": [{"in": "path", "description": "UUID of sFlow configuration to delete", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["sflow_configurations"], "summary": "Delete an sFlow configuration by UUID", "operationId": "deleteSflowConfiguration"}}, "/snmp_configurations": {"post": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/CreationWithIdResponse"}}, "400": {"description": "Error: Bad Request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "422": {"description": "Error: Could not process entity", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"schema": {"$ref": "#/definitions/snmp_configuration_create"}, "description": "SNMP agent specification in body", "required": true, "name": "body", "in": "body"}], "produces": ["application/json; version=1.0"], "tags": ["snmp_configurations"], "summary": "Add a new SNMP configuration", "operationId": "addSnmpConfigurations"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/snmp_configuration_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "Return only the count of SNMP objects in the `result` property of the response.", "required": false, "type": "boolean", "name": "count_only", "in": "query"}, {"description": "Return the array of SNMP Configuration objects contained in the given page number.", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of SNMP Configuration objects of the given size.", "required": false, "type": "integer", "name": "page_size", "in": "query"}, {"in": "query", "description": "Return the SNMP objects used by the fabric with given UUID.", "minLength": 32, "required": false, "maxLength": 36, "type": "string", "name": "fabric"}, {"in": "query", "description": "Return the SNMP objects used by the switch with given UUID.", "minLength": 32, "required": false, "maxLength": 36, "type": "string", "name": "switch"}], "produces": ["application/json; version=1.0"], "tags": ["snmp_configurations"], "summary": "Get an array of SNMP configurations", "operationId": "listSnmpConfigurations"}}, "/snmp_configurations/{uuid}": {"put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Error: Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Error: UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of SNMP Agent configuration.", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"schema": {"$ref": "#/definitions/snmp_configuration_update"}, "description": "SNMP agent specification in body", "required": true, "name": "body", "in": "body"}], "produces": ["application/json; version=1.0"], "tags": ["snmp_configurations"], "summary": "Update a SNMP configuration by UUID", "operationId": "updateSnmpConfigurations"}, "delete": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Error: Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Error: UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of SNMP Agent configuration.", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["snmp_configurations"], "summary": "Delete a SNMP configuration by UUID", "operationId": "deleteSnmpConfigurations"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/snmp_configuration_response"}}, "400": {"description": "Error: Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Error: UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of SNMP Agent configuration.", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["snmp_configurations"], "summary": "Get a SNMP configuration by UUID", "operationId": "getSnmpConfigurations"}}, "/statistic_configurations": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/statistic_configuration_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [], "produces": ["application/json; version=1.0"], "tags": ["statistic_configurations"], "summary": "Get an array of statistic configurations", "operationId": "listStatisticConfigurations"}}, "/statistic_configurations/{uuid}": {"put": {"description": "", "parameters": [{"in": "path", "description": "UUID of statistic configuration to modify", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"schema": {"$ref": "#/definitions/statistic_configuration_update"}, "description": "Composable Fabric Manager Settings", "required": true, "name": "body", "in": "body"}], "produces": ["application/json; version=1.0"], "tags": ["statistic_configurations"], "summary": "Update a statistic configurations", "consumes": ["application/json"], "responses": {"200": {"description": "Statistic Configuration Updated Successfully", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/statistic_configuration_response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of statistic configuration to get", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["statistic_configurations"], "summary": "Get a statistic configuration", "operationId": "getStatisticConfiguration"}}, "/support_bundles": {"post": {"responses": {"401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "202": {"description": "Bundle creation requested", "schema": {"$ref": "#/definitions/CreationWithIdResponse"}}}, "description": "Creates a new support bundle.", "parameters": [{"required": true, "schema": {"$ref": "#/definitions/support_bundle_create"}, "name": "body", "in": "body"}], "produces": ["application/json; version=1.0"], "tags": ["support_bundles"], "summary": "Add a support bundle", "operationId": "createSupportBundle"}, "delete": {"responses": {"200": {"description": "Success", "schema": {"allOf": [{"$ref": "#/definitions/Response"}, {"properties": {"result": {"type": "number", "description": "Count of deleted bundles", "example": 3}}}]}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "produces": ["application/json; version=1.0"], "description": "", "tags": ["support_bundles"], "summary": "Delete all support bundles", "operationId": "deleteAllSupportBundle"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/support_bundle_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "Return only the count of Support Bundle objects in the `result` property of the response.", "required": false, "type": "boolean", "name": "count_only", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["support_bundles"], "summary": "Get an array of support bundles", "operationId": "listSupportBundle"}}, "/support_bundles/{name}": {"delete": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "Name of support bundle collection", "required": true, "type": "string", "name": "name", "in": "path"}], "produces": ["application/json; version=1.0"], "tags": ["support_bundles"], "summary": "Delete a support bundle by name", "operationId": "deleteSupportBundle"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/support_bundle_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "support bundle not found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "Support bundle file name", "required": true, "type": "string", "name": "name", "in": "path"}], "produces": ["application/json; version=1.0"], "tags": ["support_bundles"], "summary": "Get metadata about a support bundle", "operationId": "getSupportBundle"}}, "/switches": {"patch": {"responses": {"422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "200": {"description": "Switch updated Successfully", "schema": {"$ref": "#/definitions/PatchResponse"}}, "202": {"description": "Success: Request has been accepted, but processing has not been completed.", "schema": {"$ref": "#/definitions/AcceptedResponse"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Invalid Request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "409": {"description": "Switches Concurrent modification", "schema": {"allOf": [{"$ref": "#/definitions/ErrorResponse"}]}}}, "description": "Update a switch object using JSON patch(es) with its UUID.\nThe following patch __`ops`__ are supported:\n* `replace`\n\nThe following patch __`paths`__ are supported:\n* `/description`\n* `/ip_address`\n* `/ip_address_v6`\n* `/ip_gateway`\n* `/ip_gateway_v6`\n* `/ip_mask`\n* `/ip_mask_v6`\n* `/ip_mode` - `static` or `dhcp`\n* `/ip_mode_v6` - `static` or `dhcp`\n* `/name`\n* `/tags`\n\nNotes:\n* Patches for switches are applied to only one switch at a time.\n* The use of update_all is not supported.\n\n* To disable IPv4 specify `0.0.0.0` for a `static` `ip_address_v4`\n* Currently IPv6 must be disabled by using `::` for a `static` `ip_address_v6`\n", "parameters": [{"description": "Apply an array of patches to switch resources.", "schema": {"items": {"$ref": "#/definitions/switch_patch_request"}, "type": "array"}, "name": "switch_patch_request", "in": "body"}], "tags": ["switches"], "produces": ["application/json; version=1.0"], "operationId": "patchSwitch", "consumes": ["application/json"], "summary": "Patch Request to update a Switch object"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/switch_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "202": {"description": "Success: Request has been accepted, but processing has not been completed.", "schema": {"$ref": "#/definitions/AcceptedResponse"}}}, "description": "", "parameters": [{"description": "Return only the count of attachment objects (broken down by type) in the `result` property of the response.", "required": false, "type": "boolean", "name": "count_only", "in": "query"}, {"description": "Return switches for the fabric with the given UUID", "required": false, "type": "string", "name": "fabric", "in": "query"}, {"description": "Return the array of attachment objects contained in the given page number", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of attachment objects of the given size", "required": false, "type": "integer", "name": "page_size", "in": "query"}, {"description": "Include array of ports with each switch object", "required": false, "type": "boolean", "name": "ports", "in": "query"}, {"description": "Include the software state of the switch, including running and staged software versions.", "required": false, "type": "boolean", "name": "software", "in": "query"}, {"description": "Include related tag list as a property of each object in the response body", "required": false, "type": "boolean", "name": "tags", "in": "query"}, {"description": "Include only switches within this segment UUID.", "required": false, "type": "string", "name": "segment", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["switches"], "summary": "Get an array of Switch objects", "operationId": "listSwitches"}}, "/switches/downlink": {"post": {"responses": {"200": {"description": "Downlink switch added successfully", "schema": {"$ref": "#/definitions/CreationWithIdResponse"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "The UUID of a successfully added downlink switch will be returned.", "parameters": [{"description": "Downlink switch object.", "schema": {"$ref": "#/definitions/downlink_switch_create"}, "name": "body", "in": "body"}], "tags": ["switches"], "produces": ["application/json; version=1.0"], "operationId": "addDownlinkSwitch", "consumes": ["application/json"], "summary": "Add a new downlink switch object"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/downlink_switch_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Retrieve an array of downlink switch objects.", "parameters": [{"description": "Return only the count of attachment objects (broken down by type) in the `result` property of the response.", "required": false, "type": "boolean", "name": "count_only", "in": "query"}, {"description": "Return the array of attachment objects contained in the given page number", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of attachment objects of the given size", "required": false, "type": "integer", "name": "page_size", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["switches"], "summary": "Get an array of downlink switch objects", "operationId": "listDownlinkSwitches"}}, "/switches/downlink/{uuid}": {"put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Updates a single downlink switch object.", "parameters": [{"in": "path", "description": "UUID of downlink switch to update", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"description": "Downlink switch object.", "schema": {"$ref": "#/definitions/downlink_switch_update"}, "name": "body", "in": "body"}], "produces": ["application/json; version=1.0"], "tags": ["switches"], "summary": "Update a downlink switch by UUID.", "operationId": "updateDownlinkSwitchByUuid"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/downlink_switch_response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Retrieve a single downlink switch object by its UUID.", "parameters": [{"in": "path", "description": "UUID of downlink switch to return", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["switches"], "summary": "Get a downlink switch by UUID", "operationId": "getDownlinkSwitchByUuid"}, "delete": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Deletes a single downlink switch object.", "parameters": [{"in": "path", "description": "UUID of downlink switch to delete", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["switches"], "summary": "Delete a downlink switch by UUID. This will delete all associated configuration relating to this particular switch (there is no undo)", "operationId": "deleteDownlinkSwitchByUuid"}}, "/switches/reboot": {"put": {"responses": {"400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "202": {"description": "Switches rebooting", "schema": {"$ref": "#/definitions/Response"}}, "422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "207": {"description": "Partial success rebooting switches", "schema": {"$ref": "#/definitions/MultiStatusResponse"}}}, "description": "", "parameters": [{"schema": {"$ref": "#/definitions/reboot"}, "description": "The switches to reboot", "required": true, "name": "body", "in": "body"}, {"description": "Toggle the switch boot partition. If true, switch will boot software installed on the alternate partition. Not specifying this parameter is equivalent to false.", "required": false, "type": "boolean", "name": "toggle_boot_partition", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["switches"], "summary": "Reboot switches", "operationId": "switchReboot"}}, "/switches/reconcile": {"put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/switch_response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "202": {"description": "Success: Request has been accepted, but processing has not been completed.", "schema": {"$ref": "#/definitions/AcceptedResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "Ensure config alignment between the switch and CFM.", "required": false, "type": "boolean", "name": "force", "in": "query"}, {"description": "Switch Reconcile", "schema": {"$ref": "#/definitions/switch_reconcile"}, "name": "body", "in": "body"}], "produces": ["application/json; version=1.0"], "tags": ["switches"], "summary": "Perform a soft config check on a list of switches.", "operationId": "reconcileSwitch"}}, "/switches/replacement": {"put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/switch_response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "202": {"description": "Success: Request has been accepted, but processing has not been completed.", "schema": {"$ref": "#/definitions/AcceptedResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "Force a switch replacement in the system. (May be needed in the event the user wishes to replace the switch while other switches within the fabric can see it.)", "required": false, "type": "boolean", "name": "force", "in": "query"}, {"description": "Switch Replacement Configuration", "schema": {"$ref": "#/definitions/switch_replacement"}, "name": "body", "in": "body"}], "produces": ["application/json; version=1.0"], "tags": ["switches"], "summary": "Replace a Switch by the UUID, this will make the new switch inherit UUID and all associated configuration will be reconciled on the new switch.", "operationId": "replaceSwitch"}}, "/switches/software": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/software_state_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "query", "description": "Return the software state objects of all switches in the fabric with the given UUID.", "minLength": 32, "required": false, "maxLength": 36, "type": "string", "name": "fabric"}, {"description": "Return the array of switch software states contained in the given page number.", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of switch software states objects of the given size.", "required": false, "type": "integer", "name": "page_size", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["switches"], "summary": "Get an array of switch software states", "operationId": "listSoftwareStates"}}, "/switches/software/images": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/software_image_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "Return only the count of switch software image objects in the `result` property of the response.", "required": false, "type": "boolean", "name": "count_only", "in": "query"}, {"description": "Return the array of switch software image objects contained in the given page number.", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of switch software image objects of the given size.", "required": false, "type": "integer", "name": "page_size", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["switches"], "summary": "Get an array of switch software images", "operationId": "listSoftwareImages"}, "delete": {"responses": {"200": {"description": "Success", "schema": {"allOf": [{"$ref": "#/definitions/Response"}, {"properties": {"result": {"type": "number", "description": "Count of deleted switch software images", "example": 3}}}]}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "produces": ["application/json; version=1.0"], "description": "", "tags": ["switches"], "summary": "Delete all switch software images", "operationId": "deleteAllSoftwareImages"}}, "/switches/software/images/{name}": {"put": {"responses": {"200": {"description": "Switch software image uploaded successfully", "schema": {"$ref": "#/definitions/software_image_response"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "409": {"description": "Software image with given name exists", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "Name of the software image to upload", "required": true, "type": "string", "name": "name", "in": "path"}, {"schema": {"$ref": "#/definitions/software_image_upload"}, "description": "Software image binary file", "required": true, "name": "body", "in": "body"}], "tags": ["switches"], "produces": ["application/json; version=1.0"], "operationId": "uploadSoftwareImage", "consumes": ["application/octet-stream"], "summary": "Upload a switch software image"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/software_image_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Software image not found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "Software image name", "required": true, "type": "string", "name": "name", "in": "path"}], "produces": ["application/json; version=1.0"], "tags": ["switches"], "summary": "Get metadata about a switch software image", "operationId": "getSoftwareImage"}, "delete": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Software image not found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "Name of the switch software image to delete", "required": true, "type": "string", "name": "name", "in": "path"}], "produces": ["application/json; version=1.0"], "tags": ["switches"], "summary": "Delete a switch software image by name", "operationId": "deleteSoftwareImage"}}, "/switches/software/stagings": {"post": {"responses": {"400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "202": {"description": "Switch software staging process initialized", "schema": {"$ref": "#/definitions/CreationWithIdResponse"}}, "409": {"description": "Software staging process with given switches already in progress", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "Force re-staging the image on the specified switches. This only applies if the specified image already exists as a staged image on a switch.", "required": false, "type": "boolean", "name": "force", "in": "query"}, {"schema": {"$ref": "#/definitions/staging"}, "description": "Software staging process details", "required": true, "name": "body", "in": "body"}], "produces": ["application/json; version=1.0"], "tags": ["switches"], "summary": "Add a new switch software staging process", "operationId": "addStaging"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/staging_state_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "Return only the count of switch software staging processes in the `result` property of the response.", "required": false, "type": "boolean", "name": "count_only", "in": "query"}, {"description": "Return the array of switch software staging processes contained in the given page number.", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of switch software processes objects of the given size.", "required": false, "type": "integer", "name": "page_size", "in": "query"}, {"enum": ["active", "inactive"], "description": "Filter the result set based on the state of each process object, which can be one of:\n* `active`: actively running processes.\n* `inactive`: processes that are not actively running.\n", "required": false, "in": "query", "type": "string", "name": "state"}], "produces": ["application/json; version=1.0"], "tags": ["switches"], "summary": "Get an array of switch software staging processes", "operationId": "listStagings"}}, "/switches/software/stagings/{uuid}": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/staging_state_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Software staging process not found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of software staging.", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["switches"], "summary": "Get a switch software staging by UUID", "operationId": "getStaging"}, "delete": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Software staging process not found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of software staging process.", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["switches"], "summary": "Abort a switch software staging process by UUID", "operationId": "deleteStaging"}}, "/switches/software/upgrades": {"post": {"responses": {"400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "202": {"description": "Switch software upgrade process initialized", "schema": {"$ref": "#/definitions/CreationWithIdResponse"}}, "403": {"description": "Software EULA not accepted by caller", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "409": {"description": "Software upgrade process with given switches already in progress", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"schema": {"$ref": "#/definitions/upgrade"}, "description": "Software upgrade process details", "required": true, "name": "body", "in": "body"}, {"description": "Assertion that the client accepts the end user license agreement (EULA) for the software to be staged in the request. A value of false indicates the user does _not_ accept the agreement, and the request will be denied.", "required": true, "type": "boolean", "name": "accept_eula", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["switches"], "summary": "Add a new switch software upgrade process", "operationId": "addUpgrade"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/upgrade_state_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "Return only the count of switch software upgrade processes in the `result` property of the response.", "required": false, "type": "boolean", "name": "count_only", "in": "query"}, {"description": "Return the array of switch software upgrade processes contained in the given page number.", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of switch software processes objects of the given size.", "required": false, "type": "integer", "name": "page_size", "in": "query"}, {"enum": ["active", "inactive"], "description": "Filter the result set based on the state of each process object, which can be one of:\n* `active`: actively running processes.\n* `inactive`: processes that are not actively running.\n", "required": false, "in": "query", "type": "string", "name": "state"}], "produces": ["application/json; version=1.0"], "tags": ["switches"], "summary": "Get an array of switch software upgrade processes", "operationId": "listUpgrades"}}, "/switches/software/upgrades/{uuid}": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/upgrade_state_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Software upgrade process not found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of software upgrade.", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["switches"], "summary": "Get a switch software upgrade by UUID", "operationId": "getUpgrade"}, "delete": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Software upgrade process not found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of software upgrade process.", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["switches"], "summary": "Abort a switch software upgrade process by UUID", "operationId": "deleteUpgrade"}}, "/switches/status": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/switch_status_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "query", "description": "Return switch status for switches in the fabric with the given UUID", "minLength": 32, "required": false, "maxLength": 36, "type": "string", "name": "fabric"}, {"in": "query", "description": "Return switch status for a switch identified by this UUID", "minLength": 32, "required": false, "maxLength": 36, "type": "string", "name": "switch"}, {"enum": ["cpu_status", "disk_status", "fan_status", "memory_status", "power_supply_status", "temperature_status"], "description": "Type of switch status to retrieve", "required": true, "in": "query", "type": "string", "name": "type"}], "produces": ["application/json; version=1.0"], "tags": ["switches"], "summary": "Get an array of Switch Status objects", "operationId": "listSwitchStatus"}}, "/switches/{uuid}": {"delete": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/AcceptedResponse"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "202": {"description": "Success: Request has been accepted, but processing has not been completed.", "schema": {"$ref": "#/definitions/AcceptedResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of Switch to delete", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"description": "Force a switch removal from the system. (May be needed in the event the user wishes to remove the switch while other switches within the fabric can see it.)", "required": false, "type": "boolean", "name": "force", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["switches"], "summary": "Delete a Switch by UUID, this will delete all associated configuration relating to this particular switch (there is no undo)", "operationId": "deleteSwitchByUuid"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/switch_response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "202": {"description": "Success: Request has been accepted, but processing has not been completed.", "schema": {"$ref": "#/definitions/AcceptedResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of Switch to return", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"description": "Include array of ports with each switch object", "required": false, "type": "boolean", "name": "ports", "in": "query"}, {"description": "Include the software state of the switch, including running and staged software versions.", "required": false, "type": "boolean", "name": "software", "in": "query"}, {"description": "Include related tag list as a property of the object in the response body", "required": false, "type": "boolean", "name": "tags", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["switches"], "summary": "Get a Switch by UUID", "operationId": "getSwitchByUuid"}}, "/switches/{uuid}/change_password": {"post": {"responses": {"200": {"description": "Password successfully changed", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid Input or Bad Current Password", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of the switch for which to change the administrator password", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"schema": {"$ref": "#/definitions/user_password_update"}, "required": true, "name": "body", "in": "body"}], "tags": ["switches"], "produces": ["application/json; version=1.0"], "operationId": "changeSwitchPassword", "consumes": ["application/json"], "summary": "Change the administrator password for a switch"}}, "/switches/{uuid}/software": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/software_state_response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of the switch for which to get software state", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["switches"], "summary": "Get a switch software state by UUID", "operationId": "getSoftwareState"}}, "/syslog_client_configurations": {"post": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/syslog_client_configuration_response"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "The UUID of a successfully added Syslog Client Configuration will be returned", "parameters": [{"required": true, "description": "Syslog Client Configuration\nTo create a Syslog Client Configuration attributes with:\n * description - describes this Syslog object.\n * name - names this Syslog object.\n Defaults to 514.\n * entity_list - list of entities.\n Each contains:\n * host - address of remote syslog server. Specify a hostname, IPv4 or IPv6 address.\n * port - optional internet port for host.\n * filter_list - list of filters.\n Each contains:\n * facility - facility of messages to log.\n * severity - severity of messages to log.\n\nTo create a Syslog Client Configuration's associations with:\n * fabric_uuids: UUIDs of any fabrics with which this configuration is associated.\n * switch_uuids: UUIDs of any switches with which this configuration is associated.\n\n", "schema": {"$ref": "#/definitions/syslog_client_configuration_create"}, "name": "body", "in": "body"}], "tags": ["syslog_client_configurations"], "produces": ["application/json; version=1.0"], "operationId": "addSyslog", "consumes": ["application/json"], "summary": "Add a new Syslog Client Configuration"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/syslog_client_configuration_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Retrieve an array of Syslog objects, optionally filtered based on its usage by a fabric, or a switch", "parameters": [{"description": "Return only the count of Syslog objects in the `result` property of the response", "required": false, "type": "boolean", "name": "count_only", "in": "query"}, {"description": "Return the array of Syslog Client Configuration objects contained in the given page number", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of Syslog Client Configuration objects of the given size", "required": false, "type": "integer", "name": "page_size", "in": "query"}, {"in": "query", "description": "Return the Syslog objects used by the fabric with the given UUID", "minLength": 32, "required": false, "maxLength": 36, "type": "string", "name": "fabric"}, {"in": "query", "description": "Return the Syslog objects used by the switch with the given UUID", "minLength": 32, "required": false, "maxLength": 36, "type": "string", "name": "switch"}], "produces": ["application/json; version=1.0"], "tags": ["syslog_client_configurations"], "summary": "Get an array of Syslog configurations", "operationId": "listSyslog"}}, "/syslog_client_configurations/{uuid}": {"put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/syslog_client_configuration_response"}}, "400": {"description": "Invalid Input)", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Update a Syslog Client Configuration object by its UUID", "parameters": [{"in": "path", "description": "UUID of Syslog Client Configuration object to update", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"required": true, "description": "Syslog Client Configuration\nTo update a Syslog Client Configuration attributes with:\n * description - describes this Syslog object.\n * name - names this Syslog object.\n * entity_list - list of entities.\n Each contains:\n * host - address of remote syslog server. Specify a hostname, IPv4 or IPv6 address.\n * port - optional internet port for host.\n * filter_list - list of filters.\n Each contains:\n * facility - facility of messages to log.\n * severity - severity of messages to log.\n\nTo update a Syslog Client Configuration's associations with:\n * fabric_uuids: UUIDs of any fabrics with which this configuration is associated.\n * switch_uuids: UUIDs of any switches with which this configuration is associated.\n\n", "schema": {"$ref": "#/definitions/syslog_client_configuration_update"}, "name": "body", "in": "body"}], "produces": ["application/json; version=1.0"], "tags": ["syslog_client_configurations"], "summary": "Update a Syslog Client Configuration by UUID", "operationId": "updateSyslog"}, "delete": {"responses": {"200": {"description": "Syslog Client Configuration deleted successfully", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Deletes a single Syslog Client Configuration object", "parameters": [{"in": "path", "description": "UUID of Syslog Client Configuration to delete", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["syslog_client_configurations"], "summary": "Delete a Syslog Client Configuration by UUID", "operationId": "deleteSyslog"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/syslog_client_configuration_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Retrieve a Syslog Client Configuration by its UUID", "parameters": [{"in": "path", "description": "UUID of Syslog Client Configuration object to return", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["syslog_client_configurations"], "summary": "Get a Syslog Client Configuration by UUID", "operationId": "getSyslog"}}, "/tacacs_configurations": {"post": {"responses": {"200": {"description": "TACACS Configuration Added Successfully", "schema": {"$ref": "#/definitions/CreationWithIdResponse"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"schema": {"$ref": "#/definitions/tacacs_configuration_create"}, "description": "TACACS Configuration", "required": true, "name": "body", "in": "body"}], "tags": ["tacacs_configurations"], "produces": ["application/json; version=1.0"], "operationId": "createTacacsSource", "consumes": ["application/json"], "summary": "Add a new TACACS Configuration"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/tacacs_configuration_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "Return only the count of TACACS Client Configuration objects in the __`result`__ property of the response", "required": false, "type": "boolean", "name": "count_only", "in": "query"}, {"description": "Return the array of TACACS Client Configuration objects contained in the given page number", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of TACACS Client Configuration objects of the given size", "required": false, "type": "integer", "name": "page_size", "in": "query"}, {"description": "Return the TACACS Client Configuration objects used by Management Software", "required": false, "type": "boolean", "name": "management_software", "in": "query"}, {"in": "query", "description": "Return the TACACS Client Configuration used by the fabric with the given UUID", "minLength": 32, "required": false, "maxLength": 36, "type": "string", "name": "fabric"}, {"in": "query", "description": "Return the TACACS Client Configuration used by the switch with the given UUID", "minLength": 32, "required": false, "maxLength": 36, "type": "string", "name": "switch"}], "produces": ["application/json; version=1.0"], "tags": ["tacacs_configurations"], "summary": "Get an array of TACACS Configurations", "operationId": "listTacacsConfigurations"}}, "/tacacs_configurations/{uuid}": {"put": {"responses": {"200": {"description": "TACACS Configuration Updated Successfully", "schema": {"$ref": "#/definitions/CreationWithIdResponse"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"schema": {"$ref": "#/definitions/tacacs_configuration_update"}, "description": "TACACS Configuration", "required": true, "name": "body", "in": "body"}, {"in": "path", "description": "UUID of TACACS Configuration to update", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "tags": ["tacacs_configurations"], "produces": ["application/json; version=1.0"], "operationId": "updateTacacsConfiguration", "consumes": ["application/json"], "summary": "Update a TACACS Configuration by UUID"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/tacacs_configuration_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of TACACS Configuration to retrieve", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["tacacs_configurations"], "summary": "Get an TACACS Configuration by UUID", "operationId": "getTacacsConfigurationByUuid"}, "delete": {"responses": {"200": {"description": "TACACS Configuration Deleted Successfully", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "* Deleting an TACACS configuration", "parameters": [{"in": "path", "description": "UUID of TACACS Configuration to delete", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["tacacs_configurations"], "summary": "Delete an TACACS configuration by UUID", "operationId": "deleteTacacsConfiguration"}}, "/tags": {"post": {"responses": {"200": {"description": "Tag Added Successfully", "schema": {"$ref": "#/definitions/CreationWithIdResponse"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"schema": {"$ref": "#/definitions/tag_create"}, "description": "Tags", "required": true, "name": "body", "in": "body"}], "tags": ["tags"], "produces": ["application/json; version=1.0"], "operationId": "createObjectTag", "consumes": ["application/json"], "summary": "Add a new tag"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/tag_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "Return only the count of tags in the `result` property of the response.", "required": false, "type": "boolean", "name": "count_only", "in": "query"}, {"description": "Return an array containing tags within the given namespace. \nThe following namespaces are reserved for internal use within Composable Fabric Manager integrations:\n* `kubernetes`\n* `nsx`\n* `nutanix`\n* `oneview`\n* `simplivity`\n* `vsphere`\n* `ilo_amplifier`", "required": false, "type": "string", "name": "namespace", "in": "query"}, {"enum": ["fabric", "lag", "port", "switch", "vlan_group"], "description": "Return an array containing tags with the given object type.", "required": false, "in": "query", "type": "string", "name": "object_type"}, {"in": "query", "description": "Return an array containing the tags related to the given object UUID", "minLength": 32, "required": false, "maxLength": 36, "type": "string", "name": "object_uuid"}, {"description": "Return the array of tags contained in the given page number", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of tags of the given size", "required": false, "type": "integer", "name": "page_size", "in": "query"}, {"description": "Return an array containing tags with the given tag key.", "required": false, "type": "string", "name": "key", "in": "query"}, {"description": "Return an array containing tags with the given tag value.", "required": false, "type": "string", "name": "value", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["tags"], "summary": "Get an array of tags", "operationId": "listObjectTags"}}, "/tags/{uuid}": {"put": {"responses": {"200": {"description": "Tag updated successfully", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of tag to update", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"schema": {"$ref": "#/definitions/tag_update"}, "description": "Tag", "required": true, "name": "body", "in": "body"}], "tags": ["tags"], "produces": ["application/json; version=1.0"], "operationId": "updateObjectTag", "consumes": ["application/json"], "summary": "Update a tag by UUID"}, "delete": {"responses": {"200": {"description": "Tag deleted successfully", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of tag to delete and remove from related objects", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["tags"], "summary": "Delete a tag by UUID and remove from related objects", "operationId": "deleteObjectTag"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/tag_response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of tag to return", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["tags"], "summary": "Get a tag by UUID", "operationId": "getObjectTag"}}, "/tags/{uuid}/{object_type}/uuids": {"put": {"responses": {"200": {"description": "Object UUIDs of tag with given object type updated (replaced) successfully", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Note: The object type will be added to the tag (show up in responses to `GET /tags`) if it does not already exist", "parameters": [{"schema": {"$ref": "#/definitions/tag_add_or_update_object_uuids"}, "description": "UUIDs of objects to relate to this tag for the given object type", "required": true, "name": "body", "in": "body"}], "tags": ["tags"], "produces": ["application/json; version=1.0"], "operationId": "addObjectUuidsToTag", "consumes": ["application/json"], "summary": "Update (replace) the set of object UUIDs for the object type of the given tag"}, "post": {"responses": {"200": {"description": "Object UUIDs of tag with given object type added successfully", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid UUID or object with UUID is already related to this tag", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Note: The object type will be added to the tag (show up in responses to `GET /tags`) if it does not already exist", "parameters": [{"schema": {"$ref": "#/definitions/tag_add_or_update_object_uuids"}, "description": "UUIDs of objects to add to this tag for the given object type", "required": true, "name": "body", "in": "body"}], "tags": ["tags"], "produces": ["application/json; version=1.0"], "operationId": "updateObjectUuidsToTag", "consumes": ["application/json"], "summary": "Add a set of object UUIDs to the object type of the given tag"}}, "/topologies": {"post": {"responses": {"200": {"description": "topology added successfully", "schema": {"$ref": "#/definitions/CreationWithIdResponse"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "The UUID of a successfully added topology will be returned.", "parameters": [{"description": "topology object.", "schema": {"$ref": "#/definitions/topology_create"}, "name": "body", "in": "body"}], "tags": ["topologies"], "produces": ["application/json; version=1.0"], "operationId": "addTopology", "consumes": ["application/json"], "summary": "Add a new topology object"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/topology_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Retrieve an array of topology objects", "parameters": [{"description": "Return topologies that match the fabric uuid", "required": false, "type": "string", "name": "fabric_uuid", "in": "query"}, {"description": "Return residual topologies if true", "required": false, "type": "boolean", "name": "residual", "in": "query"}, {"description": "Return only the count of Topology objects in the `result` property of the response.", "required": false, "type": "boolean", "name": "count_only", "in": "query"}, {"description": "Return the array of Topology objects contained in the given page number.", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of Topology objects of the given size.", "required": false, "type": "integer", "name": "page_size", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["topologies"], "summary": "Get an array of topology objects", "operationId": "listTopologies"}}, "/topologies/{uuid}": {"put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/topology_response"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Update a topology object by its UUID.", "parameters": [{"in": "path", "description": "UUID of topology object to update", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"schema": {"$ref": "#/definitions/topology_update"}, "description": "topology.", "required": true, "name": "body", "in": "body"}], "produces": ["application/json; version=1.0"], "tags": ["topologies"], "summary": "Update a topology by UUID", "operationId": "updateTopology"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/topology_response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Retrieve a topology object by its UUID.", "parameters": [{"in": "path", "description": "UUID of topology object to return", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["topologies"], "summary": "Get a topology by UUID", "operationId": "getTopology"}, "delete": {"responses": {"200": {"description": "topology deleted successfully", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Deletes a single provisioned topology object.", "parameters": [{"in": "path", "description": "UUID of topology to delete", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["topologies"], "summary": "Delete a topology by UUID", "operationId": "deleteTopology"}}, "/topologies/{uuid}/paths": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/topology_paths_response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Retrieve a collection of trees of links used by a topology given that topologies UUID.", "parameters": [{"in": "path", "description": "UUID of the topology's paths to return", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["topologies"], "summary": "Get links used by a topology using the topology UUID", "operationId": "getGraphForTopology"}}, "/topologies/{uuid}/paths_exploded": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/topology_paths_exploded_response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "**DEPRECATED API WARNING!**\n\nThis API will not perform well when the size of the network is large. This API wil return exponentially more JSON than `getGraphForTopology` while conveying the same information.Retrieve a collection of trees of links used by a topology given that topologies UUID.", "parameters": [{"in": "path", "description": "UUID of the topology's paths to return", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "tags": ["topologies"], "produces": ["application/json; version=1.0"], "deprecated": true, "operationId": "getGraphForTopologyExploded", "summary": "Get links used by a topology using the topology UUID"}}, "/traffic_matrices": {"post": {"responses": {"200": {"description": "traffic matrix added successfully", "schema": {"$ref": "#/definitions/CreationWithIdResponse"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "The UUID of a successfully added traffic matrix will be returned.", "parameters": [{"description": "traffic matrix object.", "schema": {"$ref": "#/definitions/traffic_matrix_create"}, "name": "body", "in": "body"}], "tags": ["traffic_matrices"], "produces": ["application/json; version=1.0"], "operationId": "addTrafficMatrix", "consumes": ["application/json"], "summary": "Add a new affinity traffic matrix object"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/traffic_matrix_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Retrieve an array of traffic matrix objects", "parameters": [{"description": "Return traffic matrix objects that match the fabric uuid", "required": false, "type": "string", "name": "fabric_uuid", "in": "query"}, {"description": "Return residual traffic matrices if true", "required": false, "type": "boolean", "name": "residual", "in": "query"}, {"enum": ["user", "system"], "description": "Return traffic matrices matching creator", "required": false, "in": "query", "type": "string", "name": "creator"}, {"description": "Return only the count of traffic matrix objects in the `result` property of the response.", "required": false, "type": "boolean", "name": "count_only", "in": "query"}, {"description": "Return the array of traffic matrix objects contained in the given page number.", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of traffic matrix objects of the given size.", "required": false, "type": "integer", "name": "page_size", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["traffic_matrices"], "summary": "Get an array of traffic matrix objects", "operationId": "listTrafficMatrices"}}, "/traffic_matrices/{uuid}": {"put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/traffic_matrix_response"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Update an traffic matrix object by its UUID.", "parameters": [{"in": "path", "description": "UUID of affinity traffic matrix object to update", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"schema": {"$ref": "#/definitions/traffic_matrix_update"}, "description": "affinity traffic matrix.", "required": true, "name": "body", "in": "body"}], "produces": ["application/json; version=1.0"], "tags": ["traffic_matrices"], "summary": "Update an traffic matrix by UUID", "operationId": "updateTrafficMatrix"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/traffic_matrix_response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Retrieve an traffic matrix object by its UUID.", "parameters": [{"in": "path", "description": "UUID of traffic matrix object to return", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["traffic_matrices"], "summary": "Get an traffic matrix by UUID", "operationId": "getTrafficMatrix"}, "delete": {"responses": {"200": {"description": "traffic matrix deleted successfully", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Deletes a single provisioned traffic matrix object.", "parameters": [{"in": "path", "description": "UUID of traffic matrix to delete", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["traffic_matrices"], "summary": "Delete a traffic matrix by UUID", "operationId": "deleteTrafficMatrix"}}, "/traffic_matrices/{uuid}/capacity": {"get": {"responses": {"200": {"description": "Success", "schema": {"type": "integer", "example": "10000"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "For the specified fabric, return lowest speed of all the fabric interconnects, this value is the suggested uniform load for a traffic matrix", "parameters": [{"description": "Return residual capacity if true", "required": false, "type": "boolean", "name": "residual", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["traffic_matrices"], "summary": "Get an capacity of fabric from traffic matrix uniform load", "operationId": "getTrafficMatrixCapacity"}}, "/transceivers": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/transceiver_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "Return the transceiver objects for the given Fabric UUID.", "required": false, "type": "uuid_opt_hyphenated", "name": "fabric_uuid", "in": "query"}, {"collectionFormat": "csv", "items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "description": "Return the transceiver objects for the given list of Switch UUIDs.\n* Note that while the data type is `Array[string]`, the parameter value constructed by clients must be a string representation: a comma-separated list of UUIDs.\n* Limiting the value of this parameter to one UUID is also valid.", "required": false, "in": "query", "type": "array", "name": "switches"}, {"description": "Return the transceiver object for the given Port UUID.", "required": false, "type": "string", "name": "port_uuid", "in": "query"}, {"description": "Return the transceiver object for the given Port Silkscreen and Switch UUID.", "required": false, "type": "string", "name": "port_silkscreen", "in": "query"}, {"description": "Return the transceiver information object for the given Port Silkscreen.", "required": false, "type": "boolean", "name": "only_info", "in": "query"}, {"description": "Return the transceiver status object for the given Port Silkscreen.", "required": false, "type": "boolean", "name": "only_status", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["transceivers"], "summary": "Get an array of transceiver objects.", "operationId": "listTransceivers"}}, "/users": {"post": {"responses": {"200": {"description": "User Added Successfully", "schema": {"$ref": "#/definitions/CreationWithIdResponse"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "* A user with the username `current` cannot be created.\n * The `password` property is only recognized when creating a user associated with the built-in `local` authentication source. It is silently ignored otherwise.\n * The UUID of a successfully added user is returned in the value of `result` in the response object.\n* For service accounts, setting the `token_lifetime` to `0` will cause a token to never expire. <strong>USE WITH CAUTION</strong>.", "parameters": [{"schema": {"$ref": "#/definitions/user_create"}, "description": "Composable Fabric Manager Users", "required": true, "name": "body", "in": "body"}], "tags": ["users"], "produces": ["application/json; version=1.0"], "operationId": "addUser", "consumes": ["application/json"], "summary": "Add a new user"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/user_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Note: requests using tokens for users without the Administrator role will return a list containing only the requesting user object.", "parameters": [{"description": "Return only the count of User objects in the `result` property of the response.", "required": false, "type": "boolean", "name": "count_only", "in": "query"}, {"description": "Return the array of User objects contained in the given page number", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of User objects of the given size", "required": false, "type": "integer", "name": "page_size", "in": "query"}, {"description": "Return an array containing the User object with the given username", "required": false, "type": "boolean", "name": "username", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["users"], "summary": "Get an array of users", "operationId": "listUsers"}}, "/users/current": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/user_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Returns the currently authenticated user.", "parameters": [{"enum": ["true", "false"], "name": "X-Auth-Refresh-Token", "default": "false", "required": false, "in": "header", "type": "string"}], "produces": ["application/json; version=1.0"], "tags": ["users"], "summary": "Get the current user", "operationId": "getCurrentUser"}}, "/users/current/change_password": {"post": {"responses": {"200": {"description": "Password successfully changed", "schema": {"allOf": [{"$ref": "#/definitions/Response"}, {"properties": {"result": {"type": "string", "description": "Authentication token", "example": "example_api-key_iZkjs8-Yc2LzRjpwKbai11kkPZg"}}}]}}, "400": {"description": "Invalid Input or Bad Current Password", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "* Given the (valid) current and new password, a new authentication token will be returned.", "parameters": [{"schema": {"$ref": "#/definitions/user_password_update"}, "required": true, "name": "body", "in": "body"}], "tags": ["users"], "produces": ["application/json; version=1.0"], "operationId": "changePassword", "consumes": ["application/json"], "summary": "Change the password of the logged in user"}}, "/users/current/update_preferences": {"put": {"responses": {"200": {"description": "Preferences successfully updated", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "<strong>*** For Composable Fabric Manager UI Use Only ***</strong>", "parameters": [{"schema": {"type": "object"}, "required": true, "name": "body", "in": "body"}], "tags": ["users"], "produces": ["application/json; version=1.0"], "operationId": "updatePreferences", "consumes": ["application/json"], "summary": "Update the preferences of the logged in user"}}, "/users/{uuid}": {"put": {"responses": {"200": {"description": "User Updated Successfully", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "* Any role or authentication source change that results in the absence of at least one `local` user with the `Administrator` role will result in the `HTTP 400 / Bad Request` response.\n* The `password` property is only recognized when creating a user associated with the `local` authentication source. It is silently ignored otherwise.\n* Changing the `username` property of an `ldap` user will cause a new token to be generated for that user (prompting a new login workflow if they are currently logged in to the UI).\n* For service accounts, setting the `token_lifetime` to `0` will cause a token to never expire. <strong>USE WITH CAUTION</strong>.", "parameters": [{"in": "path", "description": "UUID of user to update", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"schema": {"$ref": "#/definitions/user_update"}, "description": "Composable Fabric Manager Users", "required": true, "name": "body", "in": "body"}], "tags": ["users"], "produces": ["application/json; version=1.0"], "operationId": "updateUser", "consumes": ["application/json"], "summary": "Update a user by UUID"}, "delete": {"responses": {"200": {"description": "User Deleted Successfully", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid Username", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Username Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "* If there is only one user with the Administrator role remaining, it cannot be deleted as access to the Composable Fabric Manager API would no longer be possible.", "parameters": [{"in": "path", "description": "UUID of user to delete", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["users"], "summary": "Delete a user by UUID", "operationId": "deleteUser"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/user_response"}}, "400": {"description": "Invalid Username", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "User Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of user to return", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["users"], "summary": "Get a user by UUID", "operationId": "getUser"}}, "/versions": {"get": {"responses": {"200": {"description": "API Version", "schema": {"$ref": "#/definitions/version_response"}}}, "description": "This endpoint does not require authentication.", "produces": ["application/json"], "tags": ["versions"], "summary": "Get the Composable Fabric Manager API and Software Versions", "security": [], "operationId": "getVersion"}}, "/vlan_groups": {"post": {"responses": {"200": {"description": "VLAN Group added successfully", "schema": {"$ref": "#/definitions/CreationWithIdResponse"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "The UUID of a successfully added VLAN Group will be returned.", "parameters": [{"description": "VLAN Group object.", "schema": {"$ref": "#/definitions/vlan_group_create"}, "name": "body", "in": "body"}], "tags": ["vlan_groups"], "produces": ["application/json; version=1.0"], "operationId": "addVlanGroup", "consumes": ["application/json"], "summary": "Add a new VLAN Group object"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/vlan_group_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "202": {"description": "Success: Request has been accepted, but processing has not been completed.", "schema": {"$ref": "#/definitions/AcceptedResponse"}}}, "description": "Retrieve an array of VLAN Group objects, optionally including an array of Link Aggregation Group objects related to each VLAN Group.", "parameters": [{"description": "Return only the count of objects in the `result` property of the response.", "x-param-conflicts-with": ["lags"], "required": false, "in": "query", "type": "boolean", "name": "count_only"}, {"description": "Include an array of associated Link Aggregation Group objects.", "x-param-conflicts-with": ["count_only"], "required": false, "in": "query", "type": "boolean", "name": "lags"}, {"description": "Return VLAN groups exactly matching the given name.", "required": false, "type": "string", "name": "name", "in": "query"}, {"description": "Return the array of objects contained in the given page number.", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of objects of the given size.", "required": false, "type": "integer", "name": "page_size", "in": "query"}, {"description": "Include related tag list as a property of each object in the response body", "required": false, "type": "boolean", "name": "tags", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["vlan_groups"], "summary": "Get an array of VLAN group objects", "operationId": "listVlanGroups"}}, "/vlan_groups/{uuid}": {"put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/vlan_group_response"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Update a VLAN Group object by its UUID.", "parameters": [{"in": "path", "description": "UUID of VLAN Group to update", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"schema": {"$ref": "#/definitions/vlan_group_update"}, "description": "VLAN Group configuration.", "required": true, "name": "body", "in": "body"}], "produces": ["application/json; version=1.0"], "tags": ["vlan_groups"], "summary": "Update a VLAN Group by UUID", "operationId": "updateVlanGroup"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/vlan_group_response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "202": {"description": "Success: Request has been accepted, but processing has not been completed.", "schema": {"$ref": "#/definitions/AcceptedResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Retrieve a VLAN Group object by its UUID, optionally including an array of Link Aggregation Group objects related to the VLAN Group.", "parameters": [{"description": "Include an array of associated Link Aggregation Group objects.", "required": false, "type": "boolean", "name": "lags", "in": "query"}, {"description": "Include related tag list as a property of the object in the response body", "required": false, "type": "boolean", "name": "tags", "in": "query"}, {"in": "path", "description": "UUID of VLAN Group to return", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["vlan_groups"], "summary": "Get a VLAN group by UUID", "operationId": "getVlanGroup"}, "delete": {"responses": {"200": {"description": "VLAN Group deleted successfully", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "422": {"description": "Unprocessable request", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Deletes a VLAN Group object.\n If any related tags exist which will be orphaned as a result of deleting the object, those tags will also be deleted.", "parameters": [{"in": "path", "description": "UUID of VLAN Group to delete", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["vlan_groups"], "summary": "Delete a VLAN group by UUID", "operationId": "deleteVlanGroup"}}, "/vms": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/vm_generic_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "202": {"description": "Success: Request has been accepted, but processing has not been completed.", "schema": {"$ref": "#/definitions/AcceptedResponse"}}}, "description": "Note that each object's schema (including UUID pattern) will vary based on the value of its `vendor` property.\n\nDepending on enabled Packs, objects can be one of:\n* Object: Virtual Machine (discovered by Nutanix Pack)\n* Object: Virtual Machine (discovered by vSphere Pack)\n\nSee the `models` heading at the bottom of the page.\n\nThe following parameters are mutually exclusive: `hosts`, `manager`, `vendor`", "parameters": [{"in": "query", "description": "Return only virtual machines from the given cluster", "minLength": 32, "required": false, "maxLength": 36, "type": "string", "name": "cluster_uuid"}, {"description": "Return only virtual machines that are a member of given cluster.", "required": false, "type": "string", "name": "cluster_uuid", "in": "query"}, {"description": "Return only the count of virtual machine objects in the `result` property of the response.\n* With no other parameters, this returns an object with counts for each vendor.\n* When combined with the `vendor` parameter, this only returns the integer count of objects of that vendor.", "x-param-conflicts-with": ["nics"], "required": false, "in": "query", "type": "boolean", "name": "count_only"}, {"name": "hosts", "in": "query", "items": {"type": "string"}, "x-param-conflicts-with": ["manager", "type", "vendor"], "required": false, "type": "array", "collectionFormat": "csv", "description": "Return VMs for the given list of host UUIDs.\n* Note that while the data type is `Array[string]`, the parameter value constructed by clients must be a string representation: a comma-separated list of UUIDs.\n* Limiting the value of this parameter to one UUID is also valid.\n* To match `vm` objects which have an empty `host_uuid` property, use `null` as the value for this parameter. Note that in that case, other values will be ignored."}, {"description": "Return only virtual machines for the given virtualization manager (Nutanix Prism or VMware Virtual Center instance) UUID", "x-param-conflicts-with": ["hosts", "type", "vendor"], "required": false, "in": "query", "type": "string", "name": "manager"}, {"description": "Include array of virtual machine NICs with each virtual machine object", "x-param-conflicts-with": ["count_only"], "required": false, "in": "query", "type": "boolean", "name": "nics"}, {"description": "Return the array of virtual machine objects contained in the given page number", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of virtual machine objects of the given size", "required": false, "type": "integer", "name": "page_size", "in": "query"}, {"enum": ["nsx_controller", "nsx_distributed_router", "nsx_edge_gateway", "nutanix_controller", "simplivity_controller", "user"], "description": "Return only virtual machines of the specified type.", "x-param-conflicts-with": ["hosts", "manager", "vendor"], "required": false, "in": "query", "type": "string", "name": "type"}, {"enum": ["nutanix", "vmware", "simplivity"], "description": "Return only virtual machines hosted on the given vendor's hypervisor", "x-param-conflicts-with": ["hosts", "type", "manager"], "required": false, "in": "query", "type": "string", "name": "vendor"}], "produces": ["application/json; version=1.0"], "tags": ["vms"], "summary": "Get an array of virtual machines", "operationId": "listVms"}}, "/vms/{uuid}": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/vm_generic_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "202": {"description": "Success: Request has been accepted, but processing has not been completed.", "schema": {"$ref": "#/definitions/AcceptedResponse"}}, "404": {"description": "Virtual Machine Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Note that the object's schema (including UUID pattern) will vary based on the value of its `vendor` property.\n\nDepending on enabled Packs, objects can be one of:\n* Object: Virtual Machine (discovered by Nutanix Pack)\n* Object: Virtual Machine (discovered by vSphere Pack)\n\nSee the `models` heading at the bottom of the page.", "parameters": [{"description": "UUID of VM to return", "minLength": 32, "required": true, "in": "path", "type": "string", "name": "uuid"}, {"description": "Include array of virtual machine NICs with each virtual machine object", "required": false, "type": "boolean", "name": "nics", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["vms"], "summary": "Get a virtual machine by UUID", "operationId": "getVmByUuid"}}, "/vmware/nsxs": {"post": {"responses": {"200": {"description": "Configuration Added Successfully", "schema": {"allOf": [{"$ref": "#/definitions/Response"}, {"properties": {"result": {"type": "string", "description": "Empty if `verify_only=true`. UUID of the newly created configuration otherwise", "example": "5d6a00bd286a497581e8879a2ce333e1"}}}]}}, "400": {"description": "Invalid Input or Connection Verification Failed", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"schema": {"$ref": "#/definitions/nsx_pack_config_create"}, "description": "NSX", "required": true, "name": "body", "in": "body"}, {"description": "* Limits request to verification of config data by establishing a connection to the server.\n* The pack configuration will not be created.\n* The `result` property in a success response will be empty.", "required": false, "type": "boolean", "name": "verify_only", "in": "query"}], "tags": ["nsx"], "produces": ["application/json; version=1.0"], "operationId": "addNSXConfig", "consumes": ["application/json"], "summary": "Add a new VMware NSX configuration"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/nsx_pack_config_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "Return only the count of VMware NSX pack configurations (connected VMWare NSX instances).", "required": false, "type": "boolean", "name": "count_only", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["nsx"], "summary": "Get an array of VMware NSX configurations", "operationId": "listNSXConfig"}}, "/vmware/nsxs/{uuid}": {"put": {"responses": {"200": {"description": "Configuration Updated Successfully", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of configuration to update", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"description": "* Limits request to verification of config data by establishing a connection to the server.\n* The pack configuration will not be updated.\n* The `result` property in a success response will be empty.", "required": false, "type": "boolean", "name": "verify_only", "in": "query"}, {"schema": {"$ref": "#/definitions/nsx_pack_config_update"}, "description": "VMware NSX configuration", "required": true, "name": "body", "in": "body"}], "tags": ["nsx"], "produces": ["application/json; version=1.0"], "operationId": "updateNSXConfig", "consumes": ["application/json"], "summary": "Update a VMware NSX configuration by UUID"}, "delete": {"responses": {"200": {"description": "Configuration Deleted Successfully", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid ID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of configuration to delete", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["nsx"], "summary": "Delete a VMware NSX configuration by UUID", "operationId": "deleteNSXConfig"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/nsx_pack_config_response"}}, "400": {"description": "Invalid ID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of configuration to return", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["nsx"], "summary": "Get a VMware NSX configuration by UUID", "operationId": "getNSXConfig"}}, "/vmware/nsxs/{uuid}/verify": {"post": {"responses": {"200": {"description": "Connection Verification Succeeded", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Connection Verification Failed", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of configuration to verify", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"required": true, "type": "string", "name": "Content-Type", "enum": ["application/json"], "in": "header"}], "tags": ["nsx"], "produces": ["application/json; version=1.0"], "operationId": "verifyNSXConfig", "consumes": ["application/json"], "summary": "Verify connectivity of a VMware NSX configuration by UUID"}}, "/vmware/plugin/register": {"post": {"responses": {"200": {"description": "Registration Successful", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Registration Failed", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "* To register using the credentials of an existing registration, only provide the host.\n* The IP address of Composable Fabric Manager must be accessible to vCenter. If it is not the API may incorrectly report a successful response.", "parameters": [{"schema": {"$ref": "#/definitions/vsphere_plugin"}, "description": "vCenter Credentials", "required": true, "name": "body", "in": "body"}], "tags": ["vsphere"], "produces": ["application/json; version=1.0"], "operationId": "registerVspherePlugin", "consumes": ["application/json"], "summary": "Register the Composable Fabric Manager vSphere Web Client Plugin with vCenter"}}, "/vmware/vcenters": {"post": {"responses": {"200": {"description": "Configuration Added Successfully", "schema": {"allOf": [{"$ref": "#/definitions/Response"}, {"properties": {"result": {"type": "string", "description": "Empty if `verify_only=true`. UUID of the newly created configuration otherwise", "example": "5d6a00bd286a497581e8879a2ce333e1"}}}]}}, "400": {"description": "Invalid Input or Connection Verification Failed", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"schema": {"$ref": "#/definitions/vsphere_pack_config_create"}, "description": "vSphere", "required": true, "name": "body", "in": "body"}, {"description": "* Limits request to verification of config data by establishing a connection to the server.\n* The pack configuration will not be created.\n* The `result` property in a success response will be empty.", "required": false, "type": "boolean", "name": "verify_only", "in": "query"}], "tags": ["vsphere"], "produces": ["application/json; version=1.0"], "operationId": "addVsphereConfig", "consumes": ["application/json"], "summary": "Add a new VMware vSphere configuration"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/vsphere_pack_config_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "Return only the count of vSphere pack configurations (connected Virtual Centers).", "required": false, "type": "boolean", "name": "count_only", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["vsphere"], "summary": "Get an array of VMware vSphere configurations", "operationId": "listVsphereConfig"}}, "/vmware/vcenters/{uuid}": {"put": {"responses": {"200": {"description": "Configuration Updated Successfully", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of configuration to update", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"description": "* Limits request to verification of config data by establishing a connection to the server.\n* The pack configuration will not be updated.\n* The `result` property in a success response will be empty.", "required": false, "type": "boolean", "name": "verify_only", "in": "query"}, {"schema": {"$ref": "#/definitions/vsphere_pack_config_update"}, "description": "vSphere configuration", "required": true, "name": "body", "in": "body"}], "tags": ["vsphere"], "produces": ["application/json; version=1.0"], "operationId": "updateVsphereConfig", "consumes": ["application/json"], "summary": "Update a VMware vSphere configuration by UUID"}, "delete": {"responses": {"200": {"description": "Configuration Deleted Successfully", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of configuration to delete", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["vsphere"], "summary": "Delete a VMware vSphere configuration by UUID", "operationId": "deleteVsphereConfig"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/vsphere_pack_config_response"}}, "400": {"description": "Invalid UUID", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of configuration to return", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["vsphere"], "summary": "Get a VMware vSphere configuration by UUID", "operationId": "getVsphereConfig"}}, "/vmware/vcenters/{uuid}/refresh": {"post": {"responses": {"200": {"description": "Connection Verification Succeeded", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid UUID or Connection Verification Failed", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of VMware vSphere configuration to refresh", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"required": true, "type": "string", "name": "Content-Type", "enum": ["application/json"], "in": "header"}], "produces": ["application/json; version=1.0"], "tags": ["vsphere"], "summary": "Refresh data learned from a VMware vSphere instance by UUID", "operationId": "refreshVsphereData"}}, "/vmware/vcenters/{uuid}/register": {"post": {"responses": {"200": {"description": "Registration Successful", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Registration Failed", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "* To register using the credentials of an existing registration, only provide the UUID.\n* The IP address of Composable Fabric Manager must be accessible to vCenter. If it is not the API may incorrectly report a successful response.", "parameters": [{"in": "path", "description": "UUID of configuration to use for registration", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}], "tags": ["vsphere"], "produces": ["application/json; version=1.0"], "operationId": "registerVspherePluginById", "consumes": ["application/json"], "summary": "Register the Composable Fabric Manager vSphere Client Plugin by UUID"}}, "/vmware/vcenters/{uuid}/verify": {"post": {"responses": {"200": {"description": "Connection Verification Succeeded", "schema": {"$ref": "#/definitions/Response"}}, "400": {"description": "Invalid UUID or Connection Verification Failed", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "UUID Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"in": "path", "description": "UUID of configuration to verify", "minLength": 32, "required": true, "maxLength": 36, "type": "string", "name": "uuid"}, {"required": true, "type": "string", "name": "Content-Type", "enum": ["application/json"], "in": "header"}], "tags": ["vsphere"], "produces": ["application/json; version=1.0"], "operationId": "verifyVsphereConfig", "consumes": ["application/json"], "summary": "Verify connectivity of a VMware vSphere configuration by UUID"}}, "/vmware/vmkernel_adapters": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/vmkernel_adapter_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "202": {"description": "Success: Request has been accepted, but processing has not been completed.", "schema": {"$ref": "#/definitions/AcceptedResponse"}}}, "description": "", "parameters": [{"description": "Return only the count of objects in the `result` property of the response.", "required": false, "type": "boolean", "name": "count_only", "in": "query"}, {"description": "Return only VMKernel Adapters for the given host UUID", "required": false, "type": "string", "name": "host", "in": "query"}, {"enum": ["defaultTcpipStack", "vSphereProvisioning", "vmotion", "vxlan"], "description": "Return only VMKernel Adapters running the given TCP/IP stack", "required": false, "in": "query", "type": "string", "name": "tcp_ip_stack"}, {"enum": ["faultToleranceLogging", "management", "vSphereProvisioning", "vSphereReplication", "vSphereReplicationNFC", "vsan", "vmotion"], "description": "Return only VMKernel Adapters supporting the given VMKernel Services", "required": false, "in": "query", "type": "string", "name": "vmk_services"}, {"description": "Return the array of VMKernel Adapter objects contained in the given page number", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of VMKernel Adapter objects of the given size", "required": false, "type": "integer", "name": "page_size", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["vmkernel_adapters"], "summary": "Get an array of VMKernel Adapter objects", "operationId": "listVMKernelAdapters"}}, "/vmware/vmkernel_adapters/{uuid}": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/vmkernel_adapter_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "202": {"description": "Success: Request has been accepted, but processing has not been completed.", "schema": {"$ref": "#/definitions/AcceptedResponse"}}, "404": {"description": "VMKernel Adapter Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of VMKernel Adapter to return", "minLength": 32, "required": true, "in": "path", "type": "string", "name": "uuid"}], "produces": ["application/json; version=1.0"], "tags": ["vmkernel_adapters"], "summary": "Get a VMKernel Adapter object by UUID", "operationId": "getVMKernelAdapterByUuid"}}, "/vpcs": {"post": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/vpc_write_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "Virtual Private Cloud Create", "schema": {"$ref": "#/definitions/vpc_create"}, "name": "body", "in": "body"}], "tags": ["vpcs"], "produces": ["application/json; version=1.0"], "operationId": "createVPC", "consumes": ["application/json"], "summary": "Add a new VPC object"}, "delete": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Virtual Private Cloud Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "Deletes VPCs only for the fabric with the given UUID", "required": false, "type": "string", "name": "fabric_uuid", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["vpcs"], "summary": "Delete all VPCs", "operationId": "deleteAllVPCs"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/vpc_list_response"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "Return only the count of objects in the `result` property of the response.", "required": false, "type": "boolean", "name": "count_only", "in": "query"}, {"description": "Return VPCs only for the fabric with the given UUID", "required": false, "type": "string", "name": "fabric_uuid", "in": "query"}, {"description": "Include Interface information with each Virtual Private Cloud object in the response body.", "required": false, "type": "boolean", "name": "ip_interfaces", "in": "query"}, {"description": "Include static route information with each Virtual Private Cloud object in the response body.", "required": false, "type": "boolean", "name": "ip_static_routes", "in": "query"}, {"description": "If returning Virtual Private Cloud child objects in the response body, also include any objects referenced by those child objects in the response.For IP Interfaces of type 'routed', the LAG and switch objects on which the Interface was created will be included, along with the member ports of the LAG.", "required": false, "type": "boolean", "name": "include_referenced_objects", "in": "query"}, {"description": "Include only default Virtual Private Cloud objects in the response body.", "required": false, "type": "boolean", "name": "default_only", "in": "query"}, {"description": "Return the array of Virtual Private Cloud objects contained in the given page number", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of Virtual Private Cloud objects of the given size", "required": false, "type": "integer", "name": "page_size", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["vpcs"], "summary": "Get an array of VPC objects", "operationId": "listVPCs"}}, "/vpcs/mac_addresses": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/virtual_mac_address_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "If True, return only reserved MAC addresses assigned to a VPC; if False, return only reserved MAC addresses not assigned to any VPC ", "required": false, "type": "boolean", "name": "in_use", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["vpcs"], "summary": "Get a list of reserved Virtual MAC Addresses by UUID", "operationId": "getVPCMACAddressesByUuid"}}, "/vpcs/{vpc_uuid}": {"put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/vpc_write_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Virtual Private Cloud Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of Virtual Private Cloud to update", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "vpc_uuid"}, {"description": "Virtual Private Cloud Update", "schema": {"$ref": "#/definitions/vpc_update"}, "name": "body", "in": "body"}], "produces": ["application/json; version=1.0"], "tags": ["vpcs"], "summary": "Update a VPC object by UUID", "operationId": "updateVPCByUuid"}, "delete": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Virtual Private Cloud Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of Virtual Private Cloud to delete", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "vpc_uuid"}], "produces": ["application/json; version=1.0"], "tags": ["vpcs"], "summary": "Delete a VPC object by UUID", "operationId": "deleteVPCByUuid"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/vpc_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "400": {"description": "Invalid Input", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Virtual Private Cloud Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of Virtual Private Cloud to return", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "vpc_uuid"}, {"description": "Include Interface information with each Virtual Private Cloud object in the response body.", "required": false, "type": "boolean", "name": "ip_interfaces", "in": "query"}, {"description": "Include static route information with each Virtual Private Cloud object in the response body.", "required": false, "type": "boolean", "name": "ip_static_routes", "in": "query"}, {"description": "If returning Virtual Private Cloud child objects in the response body, also include any objects referenced by those child objects in the response.", "required": false, "type": "boolean", "name": "include_referenced_objects", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["vpcs"], "summary": "Get a VPC object by UUID", "operationId": "getVPCByUuid"}}, "/vpcs/{vpc_uuid}/bgp": {"put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/bgp_global_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of VPC on which to update configuration", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "vpc_uuid"}, {"description": "BGP Global Configuration", "schema": {"$ref": "#/definitions/bgp_global"}, "name": "body", "in": "body"}], "tags": ["vpcs"], "produces": ["application/json; version=1.0"], "operationId": "bgpGlobalUpdate", "consumes": ["application/json"], "summary": "Update VPC's global BGP configuration"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/bgp_global_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of VPC for which to retrieve configuration", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "vpc_uuid"}, {"description": "Include Intrafabric information with each switch object and network object in the response body.", "required": false, "type": "boolean", "name": "intra_fabric", "in": "query"}, {"description": "Include Switch information in the response body.", "required": false, "type": "boolean", "name": "switches", "in": "query"}, {"description": "Include Switch and Neighbor information in the response body.", "required": false, "type": "boolean", "name": "neighbors", "in": "query"}, {"description": "If true, returns only BGP intrafabric neighbors in the response body. If false, only return BGP neighbors. If not specified, returns all neighbors.", "required": false, "type": "boolean", "name": "intrafabric_neighbors", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["vpcs"], "summary": "Retrieve VPC's global configuration", "operationId": "bgpGlobalGet"}}, "/vpcs/{vpc_uuid}/bgp/intra_fabric": {"put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/bgp_intra_fabric_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of VPC for which to update BGP config", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "vpc_uuid"}, {"description": "UUID of switch for which BGP config is being updated", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "switch_uuid"}, {"description": "BGP Global Configuration", "schema": {"$ref": "#/definitions/bgp_intra_fabric"}, "name": "body", "in": "body"}], "tags": ["vpcs"], "produces": ["application/json; version=1.0"], "operationId": "bgpIntraFabricUpdate", "consumes": ["application/json"], "summary": "Update VPC's intra-fabric BGP configuration"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/bgp_intra_fabric_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of VPC for which to retrieve configuration", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "vpc_uuid"}], "produces": ["application/json; version=1.0"], "tags": ["vpcs"], "summary": "Retrieve VPC's intra-fabric BGP configuration", "operationId": "bgpIntraFabricGet"}}, "/vpcs/{vpc_uuid}/bgp/status": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/bgp_state_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of VPC for which to retrieve BGP configuration", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "vpc_uuid"}, {"description": "UUID of switch for which BGP state is being requested", "format": "uuid_opt_hyphenated", "required": false, "in": "query", "type": "string", "name": "switch_uuid"}, {"description": "Include networks information in the response body.", "required": false, "type": "boolean", "name": "networks", "in": "query"}, {"description": "Include neighbor information in the response body.", "required": false, "type": "boolean", "name": "neighbors", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["vpcs"], "summary": "Retrieve VPC's BGP state", "operationId": "bgpStateGet"}}, "/vpcs/{vpc_uuid}/bgp/{switch_uuid}": {"put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/bgp_switch_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of VPC for which to update BGP config", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "vpc_uuid"}, {"description": "UUID of switch for which BGP config is being updated", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "switch_uuid"}, {"description": "BGP Switch Configuration", "schema": {"$ref": "#/definitions/bgp_switch_update"}, "name": "body", "in": "body"}], "tags": ["vpcs"], "produces": ["application/json; version=1.0"], "operationId": "bgpSwitchUpdate", "consumes": ["application/json"], "summary": "Update VPC's switch-level BGP configuration"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/bgp_switch_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of VPC for which to retrieve BGP configuration", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "vpc_uuid"}, {"description": "UUID of switch for which BGP configuration is being retrieved", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "switch_uuid"}, {"description": "If true, returns only BGP intrafabric neighbors in the response body. If false, only return BGP neighbors. If not specified, returns all neighbors.", "required": false, "type": "boolean", "name": "intrafabric_neighbors", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["vpcs"], "summary": "Retrieve VPC's switch-level configuration", "operationId": "bgpSwitchGet"}}, "/vpcs/{vpc_uuid}/bgp/{switch_uuid}/neighbor_reset/{neighbor_ip_address}": {"put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of VPC on which update BGP neighbor is being reset", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "vpc_uuid"}, {"description": "UUID of switch on which BGP neighbor is being reset", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "switch_uuid"}, {"oneOf": [{"format": "ipv4"}, {"format": "ipv6"}], "description": "IP address of BGP neighbor to be reset", "required": true, "in": "path", "type": "string", "name": "neighbor_ip_address"}, {"description": "BGP Reset Parameters", "schema": {"$ref": "#/definitions/bgp_neighbor_reset"}, "name": "body", "in": "body"}], "tags": ["vpcs"], "produces": ["application/json; version=1.0"], "operationId": "bgpSwitchNeighborReset", "consumes": ["application/json"], "summary": "Perform reset on a BGP neighbor"}}, "/vpcs/{vpc_uuid}/ip_interfaces": {"post": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ip_interfaces_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of VPC in which interfaces are to be created", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "vpc_uuid"}, {"description": "IP Interface Create", "schema": {"$ref": "#/definitions/ip_interfaces_create"}, "name": "body", "in": "body"}], "tags": ["vpcs"], "produces": ["application/json; version=1.0"], "operationId": "createInterfaces", "consumes": ["application/json"], "summary": "Create one or more IP Interface objects"}, "delete": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of VPC on which to delete interfaces", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "vpc_uuid"}], "produces": ["application/json; version=1.0"], "tags": ["vpcs"], "summary": "Delete all IP Interfaces on a specified VPC", "operationId": "deleteInterfacesOnVpc"}}, "/vpcs/{vpc_uuid}/ip_interfaces/{if_uuid}": {"put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ip_interfaces_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Interface Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of VPC in which interface was created", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "vpc_uuid"}, {"description": "UUID of Interface to update", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "if_uuid"}, {"description": "IP Interface Update", "schema": {"$ref": "#/definitions/ip_interfaces_update"}, "name": "body", "in": "body"}], "tags": ["vpcs"], "produces": ["application/json; version=1.0"], "operationId": "updateInterface", "consumes": ["application/json"], "summary": "Update an Interface specified by unique identifier"}, "delete": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Interface Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of VPC in which interface was created", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "vpc_uuid"}, {"description": "UUID of Interface to delete", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "if_uuid"}], "produces": ["application/json; version=1.0"], "tags": ["vpcs"], "summary": "Delete an Interface specified by unique identifier", "operationId": "deleteInterfaceByUuid"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ip_interfaces_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Interface Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of VPC in which interface was created", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "vpc_uuid"}, {"description": "UUID of Interface to return", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "if_uuid"}], "produces": ["application/json; version=1.0"], "tags": ["vpcs"], "summary": "Get an Interface by unique identifier", "operationId": "getInterfaceByUuid"}}, "/vpcs/{vpc_uuid}/ip_static_routes": {"post": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ip_static_route_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of VPC in which route is to be created", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "vpc_uuid"}, {"description": "IP Static Route Create", "schema": {"$ref": "#/definitions/ip_static_route_create"}, "name": "body", "in": "body"}], "tags": ["vpcs"], "produces": ["application/json; version=1.0"], "operationId": "createIPStaticRoute", "consumes": ["application/json"], "summary": "Create one or more IP Static Route objects"}, "delete": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Route Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of VPC in which routes are to be deleted", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "vpc_uuid"}], "tags": ["vpcs"], "produces": ["application/json; version=1.0"], "operationId": "deleteIPStaticRoutes", "consumes": ["application/json"], "summary": "Delete all IP Static Routes to a VPC"}}, "/vpcs/{vpc_uuid}/ip_static_routes/{route_uuid}": {"put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Route Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of VPC in which route was created", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "vpc_uuid"}, {"description": "UUID of Route to modify", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "route_uuid"}, {"description": "IP Static Route Update", "schema": {"$ref": "#/definitions/ip_static_route_update"}, "name": "body", "in": "body"}], "produces": ["application/json; version=1.0"], "tags": ["vpcs"], "summary": "Update an IP Static Route object associated with a VPC by UUID", "operationId": "modifyIPStaticRouteByUuid"}, "delete": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Route Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of VPC in which route was created", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "vpc_uuid"}, {"description": "UUID of Route to delete", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "route_uuid"}], "produces": ["application/json; version=1.0"], "tags": ["vpcs"], "summary": "Delete an IP Static Route object associated with a VPC by UUID", "operationId": "deleteIPStaticRouteByUuid"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ip_static_route_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Route Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of VPC in which route was created", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "vpc_uuid"}, {"description": "UUID of Static Route to return", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "route_uuid"}], "produces": ["application/json; version=1.0"], "tags": ["vpcs"], "summary": "Get an IP Static Route object associated with a VPC by UUID", "operationId": "getIPStaticRouteByUuid"}}, "/vpcs/{vpc_uuid}/ip_tables/arp": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ip_tables_arp_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Error: Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of virtual private cloud for which to retrieve ARP table", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "vpc_uuid"}, {"description": "Return only the count of ARP in the `result` property of the response.", "required": false, "type": "boolean", "name": "count_only", "in": "query"}, {"description": "Return the array of ARP objects contained in the given page number", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of ARP entry objects of the given size", "required": false, "type": "integer", "name": "page_size", "in": "query"}, {"collectionFormat": "csv", "items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "description": "Return ARP tables for the given list of Switch UUIDs.\n* Note that while the data type is `Array[string]`, the parameter value constructed by clients must be a string representation: a comma-separated list of UUIDs.\n* Limiting the value of this parameter to one UUID is also valid.", "required": false, "in": "query", "type": "array", "name": "switches"}], "produces": ["application/json; version=1.0"], "tags": ["vpcs"], "summary": "Get ARP table for VPC switch", "operationId": "listArp"}}, "/vpcs/{vpc_uuid}/ip_tables/ip_route": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ip_tables_ip_route_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Error: Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of virtual private cloud for which to retrieve IP Routes", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "vpc_uuid"}, {"description": "Return only the count of the IP Routes in the `result` property of the response.", "required": false, "type": "boolean", "name": "count_only", "in": "query"}, {"description": "Return the array of IP Route objects contained in the given page number", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of IP Route entry objects of the given size", "required": false, "type": "integer", "name": "page_size", "in": "query"}, {"collectionFormat": "csv", "items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "description": "Return IP Routes for the given list of Switch UUIDs.\n* Note that while the data type is `Array[string]`, the parameter value constructed by clients must be a string representation: a comma-separated list of UUIDs.\n* Limiting the value of this parameter to one UUID is also valid.", "required": false, "in": "query", "type": "array", "name": "switches"}], "produces": ["application/json; version=1.0"], "tags": ["vpcs"], "summary": "Get ARP table for VPC switch", "operationId": "listIPRoute"}}, "/vpcs/{vpc_uuid}/ospf": {"put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ospf_global_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of virtual private cloud on which to update configuration", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "vpc_uuid"}, {"description": "OSPF Global Configuration", "schema": {"$ref": "#/definitions/ospf_global_update"}, "name": "body", "in": "body"}], "tags": ["vpcs"], "produces": ["application/json; version=1.0"], "operationId": "ospfGlobalUpdate", "consumes": ["application/json"], "summary": "Update global OSPF configuration for a virtual private cloud"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ospf_global_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of virtual private cloud for which to retrieve configuration", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "vpc_uuid"}, {"description": "Return only the count of objects in the `result` property of the response.", "required": false, "type": "boolean", "name": "count_only", "in": "query"}, {"description": "Return the OSPF interface objects in the `result` property of the response.", "required": false, "type": "boolean", "name": "interfaces", "in": "query"}, {"description": "Return the area objects in the `result` property of the response.", "required": false, "type": "boolean", "name": "areas", "in": "query"}, {"description": "Return the switch objects in the `result` property of the response.", "required": false, "type": "boolean", "name": "switches", "in": "query"}, {"description": "Return the array of ospf objects contained in the given page number", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of ospf objects of the given size", "required": false, "type": "integer", "name": "page_size", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["vpcs"], "summary": "Retrieve the global OSPF configuration for a Virtual Private Cloud", "operationId": "ospfGlobalGet"}}, "/vpcs/{vpc_uuid}/ospf/area": {"post": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ospf_area_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of virtual private cloud for which to create configuration", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "vpc_uuid"}, {"description": "OSPF Area Configuration", "schema": {"$ref": "#/definitions/ospf_area_create"}, "name": "body", "in": "body"}], "produces": ["application/json; version=1.0"], "tags": ["vpcs"], "summary": "Create OSPF area configuration for a virtual private cloud", "operationId": "ospfAreaPost"}}, "/vpcs/{vpc_uuid}/ospf/area/{area_uuid}": {"put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ospf_area_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of virtual private cloud for which to update configuration", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "vpc_uuid"}, {"description": "UUID of OSPF area for which to update configuration", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "area_uuid"}, {"description": "OSPF Area Configuration", "schema": {"$ref": "#/definitions/ospf_area_update"}, "name": "body", "in": "body"}], "produces": ["application/json; version=1.0"], "tags": ["vpcs"], "summary": "Update OSPF area configuration for a virtual private cloud", "operationId": "ospfAreaPut"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ospf_area_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of virtual private cloud for which to get configuration", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "vpc_uuid"}, {"description": "UUID of OSPF area for which to get configuration", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "area_uuid"}], "produces": ["application/json; version=1.0"], "tags": ["vpcs"], "summary": "Get OSPF areas configuration for a virtual private cloud", "operationId": "ospfAreaGet"}, "delete": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ospf_area_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of virtual private cloud for which to delete configuration", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "vpc_uuid"}, {"description": "UUID of OSPF area for which to delete configuration", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "area_uuid"}], "produces": ["application/json; version=1.0"], "tags": ["vpcs"], "summary": "Delete OSPF areas configuration for a virtual private cloud", "operationId": "ospfAreaDelete"}}, "/vpcs/{vpc_uuid}/ospf/status": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ospf_state_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Area Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of virtual private cloud for which to retrieve OSPF configuration", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "vpc_uuid"}, {"description": "UUID of Switch for which to retrieve OSPF configuration", "required": false, "type": "uuid_opt_hyphenated", "name": "switch_uuid", "in": "query"}, {"description": "Return the OSPF status in the `result` property of the response.", "required": false, "type": "boolean", "name": "ospf_status", "in": "query"}, {"description": "Return the OSPF interface status in the `result` property of the response.", "required": false, "type": "boolean", "name": "interface_status", "in": "query"}, {"description": "Return the OSPF database status in the `result` property of the response.", "required": false, "type": "boolean", "name": "database_status", "in": "query"}, {"description": "Return the OSPF neighbor status in the `result` property of the response.", "required": false, "type": "boolean", "name": "neighbor_status", "in": "query"}, {"description": "Return the array of OSPF status objects contained in the given page number", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of OSPF status objects of the given size", "required": false, "type": "integer", "name": "page_size", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["vpcs"], "summary": "Retrieve OSPF status information for a virtual private cloud", "operationId": "ospfStateGet"}}, "/vpcs/{vpc_uuid}/ospf/{switch_uuid}": {"put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ospf_network_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of virtual private cloud on which to update configuration", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "vpc_uuid"}, {"description": "switch UUID on which to update configuration", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "switch_uuid"}, {"description": "OSPF Network Statement Configuration", "schema": {"$ref": "#/definitions/ospf_network"}, "name": "body", "in": "body"}], "tags": ["vpcs"], "produces": ["application/json; version=1.0"], "operationId": "ospfNetworkStatementUpdate", "consumes": ["application/json"], "summary": "Update OSPF switch configuration for a virtual private cloud"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ospf_network_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of virtual private cloud for which to retrieve configuration", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "vpc_uuid"}, {"description": "UUID of switch for which to retrieve configuration", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "switch_uuid"}], "produces": ["application/json; version=1.0"], "tags": ["vpcs"], "summary": "Retrieve OSPF switch configuration for a virtual private cloud", "operationId": "ospfNetworkStatementGet"}}, "/vpcs/{vpc_uuid}/ospf/{switch_uuid}/interface/{if_uuid}": {"put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ospf_interface_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Area Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of virtual private cloud for which to update OSPF configuration", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "vpc_uuid"}, {"description": "UUID of switch for which to update OSPF configuration", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "switch_uuid"}, {"description": "UUID of interface for which OSPF config is being updated", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "if_uuid"}, {"description": "OSPF Interface Configuration", "schema": {"$ref": "#/definitions/ospf_interface_update"}, "name": "body", "in": "body"}], "tags": ["vpcs"], "produces": ["application/json; version=1.0"], "operationId": "ospfInterfaceUpdate", "consumes": ["application/json"], "summary": "Update OSPF interface configuration for a virtual private cloud"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ospf_interface_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Area Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of virtual private cloud for which to retrieve OSPF configuration", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "vpc_uuid"}, {"description": "UUID of switch for which to retrieve OSPF configuration", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "switch_uuid"}, {"description": "UUID of interface for which OSPF configuration is being retrieved", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "if_uuid"}], "produces": ["application/json; version=1.0"], "tags": ["vpcs"], "summary": "Retrieve OSPF interface configuration virtual private cloud", "operationId": "ospfInterfaceGet"}}, "/vpcs/{vpc_uuid}/ospf/{switch_uuid}/interface_reset/{if_uuid}": {"put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ospf_interface_reset_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Area Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of virtual private cloud for which to update OSPF configuration", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "vpc_uuid"}, {"description": "UUID of switch for which to update OSPF configuration", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "switch_uuid"}, {"description": "UUID of interface for which OSPF config is being updated", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "if_uuid"}, {"description": "OSPF Interface Configuration", "schema": {"$ref": "#/definitions/ospf_interface_reset"}, "name": "body", "in": "body"}], "tags": ["vpcs"], "produces": ["application/json; version=1.0"], "operationId": "ospfInterfaceReset", "consumes": ["application/json"], "summary": "Reset OSPF interface properties"}}, "/vpcs/{vpc_uuid}/pim": {"put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/pim_global_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of virtual private cloud on which to update configuration", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "vpc_uuid"}, {"description": "PIM Global Configuration", "schema": {"$ref": "#/definitions/pim_global"}, "name": "body", "in": "body"}], "tags": ["vpcs"], "produces": ["application/json; version=1.0"], "operationId": "pimGlobalUpdate", "consumes": ["application/json"], "summary": "Update global PIM configuration for a virtual private cloud"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/pim_global"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of virtual private cloud for which to retrieve configuration", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "vpc_uuid"}, {"description": "Return only the count of objects in the `result` property of the response.", "required": false, "type": "boolean", "name": "count_only", "in": "query"}, {"description": "Return the array of pim objects contained in the given page number", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of pim objects of the given size", "required": false, "type": "integer", "name": "page_size", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["vpcs"], "summary": "Retrieve the global PIM configuration for a Virtual Private Cloud", "operationId": "pimGlobalGet"}}, "/vpcs/{vpc_uuid}/pim/config": {"post": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/pim_config_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of virtual private cloud for which to create configuration", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "vpc_uuid"}, {"description": "PIM interface Configuration", "schema": {"$ref": "#/definitions/pim_config_create"}, "name": "body", "in": "body"}], "produces": ["application/json; version=1.0"], "tags": ["vpcs"], "summary": "Create PIM interface configuration for a virtual private cloud", "operationId": "pimConfigPost"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/pim_config_get_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of virtual private cloud for which to retrieve configuration", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "vpc_uuid"}, {"description": "Include all the interface UUIDs currently using this PIM config.", "required": false, "type": "boolean", "name": "include_interface_uuids", "in": "query"}, {"description": "Return only the count of objects in the `result` property of the response.", "required": false, "type": "boolean", "name": "count_only", "in": "query"}, {"description": "Return the array of pim objects contained in the given page number", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of pim objects of the given size", "required": false, "type": "integer", "name": "page_size", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["vpcs"], "summary": "Retrieve a list of PIM interface configurations for a Virtual Private Cloud", "operationId": "pimConfigGet"}}, "/vpcs/{vpc_uuid}/pim/config/{config_uuid}": {"put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/pim_config_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of virtual private cloud for which to create configuration", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "vpc_uuid"}, {"description": "UUID of PIM interface for which to update configuration", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "config_uuid"}, {"description": "PIM interface Configuration", "schema": {"$ref": "#/definitions/pim_config_update"}, "name": "body", "in": "body"}], "produces": ["application/json; version=1.0"], "tags": ["vpcs"], "summary": "Update PIM interface configuration for a virtual private cloud", "operationId": "pimConfigPut"}, "delete": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of virtual private cloud for which to delete configuration", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "vpc_uuid"}, {"description": "UUID of PIM interface for which to delete configuration", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "config_uuid"}, {"description": "Force removes the config from any interfaces it resides on and sets them back to the default. This will also remove the config from the system.", "required": false, "type": "boolean", "name": "force", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["vpcs"], "summary": "Delete PIM interface configuration for a virtual private cloud", "operationId": "pimConfigDelete"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/pim_config_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of virtual private cloud for which to retrieve configuration", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "vpc_uuid"}, {"description": "UUID of the PIM interface config to delete", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "config_uuid"}, {"description": "Return only the count of objects in the `result` property of the response.", "required": false, "type": "boolean", "name": "count_only", "in": "query"}, {"description": "Return the array of pim objects contained in the given page number", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of pim objects of the given size", "required": false, "type": "integer", "name": "page_size", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["vpcs"], "summary": "Retrieve a PIM interface configurations for a Virtual Private Cloud", "operationId": "pimConfigIndividualGet"}}, "/vpcs/{vpc_uuid}/pim/config/{config_uuid}/interfaces": {"put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/pim_interface_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of virtual private cloud for which to apply configuration", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "vpc_uuid"}, {"description": "UUID of PIM interface for which to update configuration", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "config_uuid"}, {"description": "PIM interface Configuration", "schema": {"$ref": "#/definitions/pim_interface"}, "name": "body", "in": "body"}], "produces": ["application/json; version=1.0"], "tags": ["vpcs"], "summary": "Assign a PIM interface configuration for an IP Interface", "operationId": "pimInterfacesPut"}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/pim_interface_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "", "parameters": [{"description": "UUID of virtual private cloud for which to retrieve configuration", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "vpc_uuid"}, {"description": "UUID of PIM interface for which to update configuration", "format": "uuid_opt_hyphenated", "required": true, "in": "path", "type": "string", "name": "config_uuid"}, {"description": "Return only the count of objects in the `result` property of the response.", "required": false, "type": "boolean", "name": "count_only", "in": "query"}, {"description": "Return the array of pim objects contained in the given page number", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of pim objects of the given size", "required": false, "type": "integer", "name": "page_size", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["vpcs"], "summary": "Retrieve a list of PIM interfaces for a Virtual Private Cloud", "operationId": "pimInterfacesGet"}}, "/vswitches": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/vswitch_list_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "202": {"description": "Success: Request has been accepted, but processing has not been completed.", "schema": {"$ref": "#/definitions/AcceptedResponse"}}}, "description": "Note that the pattern of the value of __`uuid`__ for each returned object will vary (correlated to the value of the __`vendor`__ property)", "parameters": [{"description": "Return only the count of virtual switch objects in the `result` property of the response\n* With no other parameters, this returns an object with counts for each vendor\n* When combined with the `vendor` parameter, this only returns the integer count of objects of that vendor", "x-param-conflicts-with": ["portgroups"], "required": false, "in": "query", "type": "boolean", "name": "count_only"}, {"description": "Return only virtual switches for the given host UUID.\n* The `uuid` property of each `vswitch` and related `portgroup` objects (if included) will consist of an ID relevant to the related `host` object.", "x-param-conflicts-with": ["manager", "vendor"], "required": false, "in": "query", "type": "string", "name": "host"}, {"description": "Return only virtual switches for the given virtualization manager UUID", "x-param-conflicts-with": ["host", "vendor"], "required": false, "in": "query", "type": "string", "name": "manager"}, {"description": "Include array of port groups with each virtual switch object", "x-param-conflicts-with": ["count_only"], "required": false, "in": "query", "type": "boolean", "name": "portgroups"}, {"description": "Return the array of virtual switch objects contained in the given page number", "required": false, "type": "integer", "name": "page", "in": "query"}, {"description": "Return an array of virtual switch objects of the given size", "required": false, "type": "integer", "name": "page_size", "in": "query"}, {"enum": ["kubernetes", "nutanix", "vmware"], "description": "Return only virtual switches hosted on the given vendor's hypervisor", "x-param-conflicts-with": ["host", "manager"], "required": false, "in": "query", "type": "string", "name": "vendor"}], "produces": ["application/json; version=1.0"], "tags": ["vswitches"], "summary": "Get an array of virtual switches", "operationId": "listVswitches"}}, "/vswitches/{uuid}": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/vswitch_response"}}, "401": {"description": "Error: Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "202": {"description": "Success: Request has been accepted, but processing has not been completed.", "schema": {"$ref": "#/definitions/AcceptedResponse"}}, "404": {"description": "Virtual Switch Not Found", "schema": {"$ref": "#/definitions/ErrorResponse"}}}, "description": "Note that the pattern of the value of __`uuid`__ for each returned object will vary (correlated to the value of the __`vendor`__ property)", "parameters": [{"description": "UUID of vSwitch to return", "minLength": 32, "required": true, "in": "path", "type": "string", "name": "uuid"}, {"description": "Include array of port groups with each virtual switch object", "required": false, "type": "boolean", "name": "portgroups", "in": "query"}], "produces": ["application/json; version=1.0"], "tags": ["vswitches"], "summary": "Get a virtual switch by UUID", "operationId": "getVswitchByUuid"}}}, "schemes": ["https"], "tags": [{"name": "acls", "description": "Access Control Lists (ACLs)"}, {"name": "affinities", "description": "Affinities"}, {"name": "audits", "description": "Audit Logs"}, {"name": "auth", "description": "Composable Fabric Manager User Authentication"}, {"name": "auth_sources", "description": "Composable Fabric Manager User Authentication Sources"}, {"name": "backups", "description": "Composable Fabric Manager Backup"}, {"name": "certificates", "description": "Composable Fabric Manager Certificate Management"}, {"name": "clusters", "description": "Clusters (Logical groups of physical servers)"}, {"name": "dhcp_relay", "description": "DHCP Relay"}, {"name": "dns_client_configurations", "description": "Domain Name System (DNS) Client Configurations"}, {"name": "fabric_ip_networks", "description": "Fabric IP Network"}, {"name": "fabrics", "description": "Fabrics"}, {"name": "fits", "description": "Fitting API"}, {"name": "high_availability", "description": "High Availability"}, {"name": "high_availability", "description": "High Availability"}, {"name": "hosts", "description": "Infrastructure Hosts (Physical Servers)"}, {"name": "igmp_snooping", "description": "IGMP Snooping"}, {"name": "ilo_amplifier", "description": "HPE iLO Amplifier Configuration"}, {"name": "integrations", "description": "Composable Fabric Manager Integrations"}, {"name": "ip_prefix_lists", "description": "IP Prefix Lists"}, {"name": "kubernetes", "description": "Kubernetes Master Configuration"}, {"name": "l2vpns", "description": "Layer 2 VPNs (L2VPNS)"}, {"name": "lags", "description": "Link Aggregation Groups (LAGs)"}, {"name": "mac_attachments", "description": "MAC Attachments"}, {"name": "neighbor_discovery", "description": "Neighbor Discovery"}, {"name": "neighbor_discovery", "description": "Neighbor Discovery"}, {"name": "nsx", "description": "VMware NSX Configuration"}, {"name": "ntp_client_configurations", "description": "Network Time Protocol (NTP) Client Configurations"}, {"name": "nutanix", "description": "Nutanix Prism Configuration"}, {"name": "oneview", "description": "HPE OneView Configuration"}, {"name": "openapi", "description": "Composable Fabric Manager OpenAPI Schema"}, {"name": "path_actors", "description": "Path Actors"}, {"name": "peers", "description": "Peers"}, {"name": "ping", "description": "Composable Fabric Manager API Status Check"}, {"name": "pods", "description": "Pods"}, {"name": "port_mirrors", "description": "Port Mirroring"}, {"name": "ports", "description": "Switch Ports"}, {"name": "qualifiers", "description": "Qualifiers"}, {"name": "settings", "description": "Composable Fabric Manager Settings"}, {"name": "sflow_configurations", "description": "sFlow Configurations"}, {"name": "simplivity", "description": "HPE Simplivity Configuration"}, {"name": "snmp_configurations", "description": "Switch Simple Network Management Protocol (SNMP)"}, {"name": "statistic_configurations", "description": "Statistic Configurations"}, {"name": "support_bundles", "description": "Composable Fabric Manager Support Bundles"}, {"name": "switches", "description": "Switches"}, {"name": "syslog_client_configurations", "description": "Syslog Client Configurations"}, {"name": "tacacs_configurations", "description": "Composable Fabric Manager TACACS Configurations"}, {"name": "tags", "description": "Key-value pairs that can be associated with any object"}, {"name": "topologies", "description": "Topologies"}, {"name": "traffic_matrices", "description": "Affinity Traffic Matrices"}, {"name": "transceivers", "description": "transceiver information"}, {"name": "users", "description": "Composable Fabric Manager Users"}, {"name": "versions", "description": "Composable Fabric Manager API and Software Versions"}, {"name": "vlan_groups", "description": "VLAN Groups"}, {"name": "vmkernel_adapters", "description": "VMKernel Adapters"}, {"name": "vms", "description": "Virtual Machines"}, {"name": "vpcs", "description": "Virtual Private Clouds (VPCs)"}, {"name": "vsphere", "description": "VMware vSphere Configuration"}, {"name": "vswitches", "description": "Virtual Switches"}], "definitions": {"PatchResponse": {"allOf": [{"$ref": "#/definitions/Response"}, {"properties": {"result": {"items": {"$ref": "#/definitions/patch_response"}, "type": "array", "description": "Result set containing the status of each affected resource"}}, "title": "Response: Patch Response"}]}, "AuthErrorMissingHeaderResponse": {"required": ["result", "time"], "type": "object", "properties": {"result": {"type": "string", "example": "Username and/or password not in request headers or no client certificate presented"}, "time": {"type": "string", "description": "Elapsed time for operation", "example": "1ms"}}, "title": "Response: Authentication headers missing"}, "CreationWithIdResponse": {"required": ["count", "result", "time"], "type": "object", "properties": {"count": {"minimum": 0, "type": "number", "description": "The number of objects created (if available)", "example": 1}, "result": {"type": "string", "description": "The UUID of the object created", "example": "94400a50427f45e3b5a8cbe592daaa66"}, "time": {"type": "string", "description": "Elapsed time for operation", "example": "1ms"}}, "title": "Response: Created Object returning ID"}, "NoVersionErrorResponse": {"required": ["result", "time"], "type": "object", "properties": {"result": {"type": "string", "example": "API version found in neither request path (/api/v#) nor 'Accept' header (version=#)"}, "time": {"type": "string", "description": "Elapsed time for operation", "example": "1ms"}}, "title": "Response: No API version specified"}, "version_response": {"required": ["count", "result", "time"], "type": "object", "properties": {"count": {"minimum": 0, "type": "number", "description": "The number of objects in `result` if it is an array; value is 1 if `result` is an object; value is 0 if `result` is empty", "example": 1}, "result": {"type": "object", "properties": {"current": {"type": "string", "description": "Most recent, published version of the Composable Fabric Manager API", "example": "1.0"}, "supported": {"items": {"type": "string"}, "type": "array", "description": "List of supported, published versions of the Composable Fabric Manager API", "example": ["1.0"]}, "software": {"type": "string", "description": "Version of the Composable Fabric Manager distribution", "example": "5.2.0"}}}, "time": {"type": "string", "description": "Elapsed time for operation", "example": "1ms"}}, "title": "Response: API Version"}, "ErrorResponse": {"allOf": [{"$ref": "#/definitions/Response"}, {"properties": {"result": {"type": "string", "description": "Error description", "example": "Description of the error"}}, "title": "Response: Error"}]}, "CreationWithIdArrayResponse": {"required": ["count", "result", "time"], "type": "object", "properties": {"count": {"minimum": 0, "type": "number", "description": "The number of objects created (if available)", "example": 1}, "result": {"items": {"type": "string", "example": "94400a50427f45e3b5a8cbe592daaa66"}, "type": "array", "description": "Array of UUIDs of objects created"}, "time": {"type": "string", "description": "Elapsed time for operation", "example": "1ms"}}, "title": "Response: Created Object returning ID"}, "AcceptedResponse": {"required": ["message", "result", "time"], "type": "object", "properties": {"message": {"type": "string", "description": "Description of current request status", "example": "Operation succeeded. System is busy"}, "result": {"items": {}, "type": "array", "description": "For AcceptedResponse (HTTP Status 202), this is an empty array"}, "time": {"type": "string", "description": "Elapsed time for operation", "example": "1ms"}}, "title": "Response: Accepted"}, "MultiStatusResponse": {"allOf": [{"$ref": "#/definitions/Response"}, {"properties": {"result": {"items": {"$ref": "#/definitions/multi_status_response"}, "type": "array", "description": "Result set containing the status of each affected resource"}}, "title": "Response: Multi-Status"}]}, "AuthErrorInvalidCredentialsResponse": {"required": ["result", "time"], "type": "object", "properties": {"result": {"type": "string", "example": "Invalid username and password combination or unknown client certificate identity"}, "time": {"type": "string", "description": "Elapsed time for operation", "example": "1ms"}}, "title": "Response: Invalid credentials"}, "AuthErrorResponse": {"allOf": [{"$ref": "#/definitions/ErrorResponse"}, {"properties": {"result": {"example": "Authentication credential is not valid; please log in again"}}, "title": "Response: Authentication Error"}]}, "NotJsonEncodedResponse": {"required": ["result", "time"], "type": "object", "properties": {"result": {"example": "Composable Fabric Manager API only supports JSON encoded requests"}, "time": {"type": "string", "description": "Elapsed time for operation", "example": "1ms"}}, "title": "Response: Request body not JSON encoded"}, "ping_response": {"allOf": [{"type": "object", "properties": {}, "title": "Response: API Ping"}]}, "RetrievalResponse": {"discriminator": "result", "required": ["count", "result", "time"], "type": "object", "properties": {"count": {"minimum": 0, "type": "number", "description": "The number of objects in `result` if it is an array; value is 1 if `result` is an object; value is 0 if `result` is empty", "example": 1}, "result": {}, "time": {"type": "string", "description": "Elapsed time for operation", "example": "1ms"}}, "title": "Response: Data Retrieval Request"}, "Response": {"discriminator": "result", "required": ["count", "result", "time"], "type": "object", "properties": {"count": {"minimum": 0, "type": "number", "description": "The number of objects in `result` if it is an array; value is 1 if `result` is an object; value is 0 if `result` is empty", "example": 1}, "result": {"example": "null"}, "time": {"type": "string", "description": "Elapsed time for operation", "example": "1ms"}}, "title": "Response: Request"}, "acl_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/acl"}}, "title": "Response: Retrieve acl item"}]}, "acl_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/acl"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/acls?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/acls?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/acls?page=1&page_size=10"}}}}, "title": "Response: Retrieve acl list"}]}, "acl_create_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/acl_create"}}, "title": "Response: Retrieve acl_create item"}]}, "acl_create_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/acl_create"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/acl_creates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/acl_creates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/acl_creates?page=1&page_size=10"}}}}, "title": "Response: Retrieve acl_create list"}]}, "acl_update_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/acl_update"}}, "title": "Response: Retrieve acl_update item"}]}, "acl_update_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/acl_update"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/acl_updates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/acl_updates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/acl_updates?page=1&page_size=10"}}}}, "title": "Response: Retrieve acl_update list"}]}, "affinity_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/affinity"}}, "title": "Response: Retrieve affinity item"}]}, "affinity_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/affinity"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/affinities?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/affinities?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/affinities?page=1&page_size=10"}}}}, "title": "Response: Retrieve affinity list"}]}, "affinity_create_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/affinity_create"}}, "title": "Response: Retrieve affinity_create item"}]}, "affinity_create_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/affinity_create"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/affinity_creates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/affinity_creates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/affinity_creates?page=1&page_size=10"}}}}, "title": "Response: Retrieve affinity_create list"}]}, "affinity_update_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/affinity_update"}}, "title": "Response: Retrieve affinity_update item"}]}, "affinity_update_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/affinity_update"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/affinity_updates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/affinity_updates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/affinity_updates?page=1&page_size=10"}}}}, "title": "Response: Retrieve affinity_update list"}]}, "audit_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/audit"}}, "title": "Response: Retrieve audit item"}]}, "audit_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/audit"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/audits?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/audits?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/audits?page=1&page_size=10"}}}}, "title": "Response: Retrieve audit list"}]}, "auth_source_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/auth_source"}}, "title": "Response: Retrieve auth_source item"}]}, "auth_source_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/auth_source"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/auth_sources?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/auth_sources?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/auth_sources?page=1&page_size=10"}}}}, "title": "Response: Retrieve auth_source list"}]}, "backup_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/backup"}}, "title": "Response: Retrieve backup item"}]}, "backup_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/backup"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/backups?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/backups?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/backups?page=1&page_size=10"}}}}, "title": "Response: Retrieve backup list"}]}, "backup_create_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/backup_create"}}, "title": "Response: Retrieve backup_create item"}]}, "backup_create_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/backup_create"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/backup_creates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/backup_creates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/backup_creates?page=1&page_size=10"}}}}, "title": "Response: Retrieve backup_create list"}]}, "backup_rule_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/backup_rule"}}, "title": "Response: Retrieve backup_rule item"}]}, "backup_rule_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/backup_rule"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/backup_rules?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/backup_rules?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/backup_rules?page=1&page_size=10"}}}}, "title": "Response: Retrieve backup_rule list"}]}, "backup_schedule_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/backup_schedule"}}, "title": "Response: Retrieve backup_schedule item"}]}, "backup_schedule_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/backup_schedule"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/backup_schedules?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/backup_schedules?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/backup_schedules?page=1&page_size=10"}}}}, "title": "Response: Retrieve backup_schedule list"}]}, "backup_schedule_create_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/backup_schedule_create"}}, "title": "Response: Retrieve backup_schedule_create item"}]}, "backup_schedule_create_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/backup_schedule_create"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/backup_schedule_creates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/backup_schedule_creates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/backup_schedule_creates?page=1&page_size=10"}}}}, "title": "Response: Retrieve backup_schedule_create list"}]}, "backup_schedule_update_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/backup_schedule_update"}}, "title": "Response: Retrieve backup_schedule_update item"}]}, "backup_schedule_update_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/backup_schedule_update"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/backup_schedule_updates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/backup_schedule_updates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/backup_schedule_updates?page=1&page_size=10"}}}}, "title": "Response: Retrieve backup_schedule_update list"}]}, "backup_update_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/backup_update"}}, "title": "Response: Retrieve backup_update item"}]}, "backup_update_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/backup_update"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/backup_updates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/backup_updates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/backup_updates?page=1&page_size=10"}}}}, "title": "Response: Retrieve backup_update list"}]}, "bgp_global_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/bgp_global"}}, "title": "Response: Retrieve bgp_global item"}]}, "bgp_global_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/bgp_global"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/bgp_globals?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/bgp_globals?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/bgp_globals?page=1&page_size=10"}}}}, "title": "Response: Retrieve bgp_global list"}]}, "bgp_intra_fabric_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/bgp_intra_fabric"}}, "title": "Response: Retrieve bgp_intra_fabric item"}]}, "bgp_intra_fabric_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/bgp_intra_fabric"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/bgp_intra_fabrics?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/bgp_intra_fabrics?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/bgp_intra_fabrics?page=1&page_size=10"}}}}, "title": "Response: Retrieve bgp_intra_fabric list"}]}, "bgp_neighbor_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/bgp_neighbor"}}, "title": "Response: Retrieve bgp_neighbor item"}]}, "bgp_neighbor_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/bgp_neighbor"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/bgp_neighbors?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/bgp_neighbors?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/bgp_neighbors?page=1&page_size=10"}}}}, "title": "Response: Retrieve bgp_neighbor list"}]}, "bgp_neighbor_reset_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/bgp_neighbor_reset"}}, "title": "Response: Retrieve bgp_neighbor_reset item"}]}, "bgp_neighbor_reset_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/bgp_neighbor_reset"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/bgp_neighbor_resets?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/bgp_neighbor_resets?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/bgp_neighbor_resets?page=1&page_size=10"}}}}, "title": "Response: Retrieve bgp_neighbor_reset list"}]}, "bgp_neighbor_state_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/bgp_neighbor_state"}}, "title": "Response: Retrieve bgp_neighbor_state item"}]}, "bgp_neighbor_state_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/bgp_neighbor_state"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/bgp_neighbor_states?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/bgp_neighbor_states?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/bgp_neighbor_states?page=1&page_size=10"}}}}, "title": "Response: Retrieve bgp_neighbor_state list"}]}, "bgp_state_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/bgp_state"}}, "title": "Response: Retrieve bgp_state item"}]}, "bgp_state_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/bgp_state"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/bgp_states?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/bgp_states?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/bgp_states?page=1&page_size=10"}}}}, "title": "Response: Retrieve bgp_state list"}]}, "bgp_switch_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/bgp_switch"}}, "title": "Response: Retrieve bgp_switch item"}]}, "bgp_switch_create_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/bgp_switch_create"}}, "title": "Response: Retrieve bgp_switch_create item"}]}, "bgp_switch_update_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/bgp_switch_update"}}, "title": "Response: Retrieve bgp_switch_update item"}]}, "certificate_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/certificate"}}, "title": "Response: Retrieve certificate item"}]}, "certificate_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/certificate"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/certificates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/certificates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/certificates?page=1&page_size=10"}}}}, "title": "Response: Retrieve certificate list"}]}, "cfm_cluster_status_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/cfm_cluster_status"}}, "title": "Response: Retrieve cfm_cluster_status item"}]}, "cluster_simplivity_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/cluster_simplivity"}}, "title": "Response: Retrieve cluster_simplivity item"}]}, "cluster_simplivity_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/cluster_simplivity"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/clusters?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/clusters?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/clusters?page=1&page_size=10"}}}}, "title": "Response: Retrieve cluster_simplivity list"}]}, "dhcp_relay_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/dhcp_relay"}}, "title": "Response: Retrieve dhcp_relay item"}]}, "dhcp_relay_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/dhcp_relay"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/dhcp_relay?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/dhcp_relay?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/dhcp_relay?page=1&page_size=10"}}}}, "title": "Response: Retrieve dhcp_relay list"}]}, "dns_client_configuration_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/dns_client_configuration"}}, "title": "Response: Retrieve dns_client_configuration item"}]}, "dns_client_configuration_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/dns_client_configuration"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/dns_client_configurations?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/dns_client_configurations?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/dns_client_configurations?page=1&page_size=10"}}}}, "title": "Response: Retrieve dns_client_configuration list"}]}, "dns_client_configuration_create_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/dns_client_configuration_create"}}, "title": "Response: Retrieve dns_client_configuration_create item"}]}, "dns_client_configuration_create_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/dns_client_configuration_create"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/dns_client_configuration_creates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/dns_client_configuration_creates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/dns_client_configuration_creates?page=1&page_size=10"}}}}, "title": "Response: Retrieve dns_client_configuration_create list"}]}, "dns_client_configuration_update_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/dns_client_configuration_update"}}, "title": "Response: Retrieve dns_client_configuration_update item"}]}, "dns_client_configuration_update_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/dns_client_configuration_update"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/dns_client_configuration_updates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/dns_client_configuration_updates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/dns_client_configuration_updates?page=1&page_size=10"}}}}, "title": "Response: Retrieve dns_client_configuration_update list"}]}, "downlink_switch_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/downlink_switch"}}, "title": "Response: Retrieve downlink_switch item"}]}, "downlink_switch_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/downlink_switch"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/switches/downlink?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/switches/downlink?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/switches/downlink?page=1&page_size=10"}}}}, "title": "Response: Retrieve downlink_switch list"}]}, "evpn_route_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/evpn_route"}}, "title": "Response: Retrieve evpn_route item"}]}, "evpn_route_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/evpn_route"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/evpn_routes?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/evpn_routes?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/evpn_routes?page=1&page_size=10"}}}}, "title": "Response: Retrieve evpn_route list"}]}, "fabric_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/fabric"}}, "title": "Response: Retrieve fabric item"}]}, "fabric_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/fabric"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/fabrics?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/fabrics?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/fabrics?page=1&page_size=10"}}}}, "title": "Response: Retrieve fabric list"}]}, "fabric_ip_network_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/fabric_ip_network"}}, "title": "Response: Retrieve fabric_ip_network item"}]}, "fabric_ip_network_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/fabric_ip_network"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/fabric_ip_networks?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/fabric_ip_networks?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/fabric_ip_networks?page=1&page_size=10"}}}}, "title": "Response: Retrieve fabric_ip_network list"}]}, "fabric_ip_network_create_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/fabric_ip_network_create"}}, "title": "Response: Retrieve fabric_ip_network_create item"}]}, "fabric_ip_network_create_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/fabric_ip_network_create"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/fabric_ip_network_creates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/fabric_ip_network_creates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/fabric_ip_network_creates?page=1&page_size=10"}}}}, "title": "Response: Retrieve fabric_ip_network_create list"}]}, "fabric_ip_network_update_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/fabric_ip_network_update"}}, "title": "Response: Retrieve fabric_ip_network_update item"}]}, "fabric_ip_network_update_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/fabric_ip_network_update"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/fabric_ip_network_updates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/fabric_ip_network_updates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/fabric_ip_network_updates?page=1&page_size=10"}}}}, "title": "Response: Retrieve fabric_ip_network_update list"}]}, "fabric_rediscover_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/fabric_rediscover"}}, "title": "Response: Retrieve fabric_rediscover item"}]}, "fabric_rediscover_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/fabric_rediscover"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/fabric_rediscovers?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/fabric_rediscovers?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/fabric_rediscovers?page=1&page_size=10"}}}}, "title": "Response: Retrieve fabric_rediscover list"}]}, "fabric_update_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/fabric_update"}}, "title": "Response: Retrieve fabric_update item"}]}, "fabric_update_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/fabric_update"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/fabric_updates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/fabric_updates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/fabric_updates?page=1&page_size=10"}}}}, "title": "Response: Retrieve fabric_update list"}]}, "file_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/file"}}, "title": "Response: Retrieve file item"}]}, "file_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/file"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/files?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/files?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/files?page=1&page_size=10"}}}}, "title": "Response: Retrieve file list"}]}, "fit_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/fit"}}, "title": "Response: Retrieve fit item"}]}, "fit_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/fit"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/fits?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/fits?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/fits?page=1&page_size=10"}}}}, "title": "Response: Retrieve fit list"}]}, "fit_create_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/fit_create"}}, "title": "Response: Retrieve fit_create item"}]}, "fit_create_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/fit_create"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/fit_creates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/fit_creates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/fit_creates?page=1&page_size=10"}}}}, "title": "Response: Retrieve fit_create list"}]}, "fit_update_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/fit_update"}}, "title": "Response: Retrieve fit_update item"}]}, "fit_update_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/fit_update"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/fit_updates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/fit_updates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/fit_updates?page=1&page_size=10"}}}}, "title": "Response: Retrieve fit_update list"}]}, "host_generic_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/host_generic"}}, "title": "Response: Retrieve host_generic item"}]}, "host_generic_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/host_generic"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/hosts?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/hosts?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/hosts?page=1&page_size=10"}}}}, "title": "Response: Retrieve host_generic list"}]}, "igmp_snooping_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/igmp_snooping"}}, "title": "Response: Retrieve igmp_snooping item"}]}, "igmp_snooping_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/igmp_snooping"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/igmp_snooping?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/igmp_snooping?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/igmp_snooping?page=1&page_size=10"}}}}, "title": "Response: Retrieve igmp_snooping list"}]}, "ilo_amplifier_pack_config_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/ilo_amplifier_pack_config"}}, "title": "Response: Retrieve ilo_amplifier_pack_config item"}]}, "ilo_amplifier_pack_config_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/ilo_amplifier_pack_config"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/ilo_amplifier_pack_configs?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/ilo_amplifier_pack_configs?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/ilo_amplifier_pack_configs?page=1&page_size=10"}}}}, "title": "Response: Retrieve ilo_amplifier_pack_config list"}]}, "integration_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/integration"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/integrations?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/integrations?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/integrations?page=1&page_size=10"}}}}, "title": "Response: Retrieve integration list"}]}, "integration_schema_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/integration_schema"}}, "title": "Response: Retrieve integration_schema item"}]}, "integration_set_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/integration_set"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/integration_sets?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/integration_sets?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/integration_sets?page=1&page_size=10"}}}}, "title": "Response: Retrieve integration_set list"}]}, "ip_interfaces_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/ip_interfaces"}}, "title": "Response: Retrieve ip_interfaces item"}]}, "ip_interfaces_create_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/ip_interfaces_create"}}, "title": "Response: Retrieve ip_interfaces_create item"}]}, "ip_interfaces_update_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/ip_interfaces_update"}}, "title": "Response: Retrieve ip_interfaces_update item"}]}, "ip_prefix_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/ip_prefix_list"}}, "title": "Response: Retrieve ip_prefix_list item"}]}, "ip_prefix_list_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/ip_prefix_list"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/ip_prefix_lists?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/ip_prefix_lists?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/ip_prefix_lists?page=1&page_size=10"}}}}, "title": "Response: Retrieve ip_prefix_list list"}]}, "ip_prefix_list_create_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/ip_prefix_list_create"}}, "title": "Response: Retrieve ip_prefix_list_create item"}]}, "ip_prefix_list_create_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/ip_prefix_list_create"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/ip_prefix_list_creates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/ip_prefix_list_creates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/ip_prefix_list_creates?page=1&page_size=10"}}}}, "title": "Response: Retrieve ip_prefix_list_create list"}]}, "ip_prefix_list_update_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/ip_prefix_list_update"}}, "title": "Response: Retrieve ip_prefix_list_update item"}]}, "ip_prefix_list_update_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/ip_prefix_list_update"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/ip_prefix_list_updates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/ip_prefix_list_updates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/ip_prefix_list_updates?page=1&page_size=10"}}}}, "title": "Response: Retrieve ip_prefix_list_update list"}]}, "ip_static_route_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/ip_static_route"}}, "title": "Response: Retrieve ip_static_route item"}]}, "ip_static_route_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/ip_static_route"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/ip_static_routes?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/ip_static_routes?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/ip_static_routes?page=1&page_size=10"}}}}, "title": "Response: Retrieve ip_static_route list"}]}, "ip_static_route_create_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/ip_static_route_create"}}, "title": "Response: Retrieve ip_static_route_create item"}]}, "ip_static_route_create_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/ip_static_route_create"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/ip_static_route_creates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/ip_static_route_creates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/ip_static_route_creates?page=1&page_size=10"}}}}, "title": "Response: Retrieve ip_static_route_create list"}]}, "ip_static_route_update_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/ip_static_route_update"}}, "title": "Response: Retrieve ip_static_route_update item"}]}, "ip_static_route_update_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/ip_static_route_update"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/ip_static_route_updates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/ip_static_route_updates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/ip_static_route_updates?page=1&page_size=10"}}}}, "title": "Response: Retrieve ip_static_route_update list"}]}, "ip_svi_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/ip_svi"}}, "title": "Response: Retrieve ip_svi item"}]}, "ip_svi_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/ip_svi"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/ip_svis?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/ip_svis?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/ip_svis?page=1&page_size=10"}}}}, "title": "Response: Retrieve ip_svi list"}]}, "ip_tables_arp_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/ip_tables_arp"}}, "title": "Response: Retrieve ip_tables_arp item"}]}, "ip_tables_arp_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/ip_tables_arp"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/ip_tables_arps?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/ip_tables_arps?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/ip_tables_arps?page=1&page_size=10"}}}}, "title": "Response: Retrieve ip_tables_arp list"}]}, "ip_tables_ip_route_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/ip_tables_ip_route"}}, "title": "Response: Retrieve ip_tables_ip_route item"}]}, "ip_tables_ip_route_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/ip_tables_ip_route"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/ip_tables_ip_routes?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/ip_tables_ip_routes?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/ip_tables_ip_routes?page=1&page_size=10"}}}}, "title": "Response: Retrieve ip_tables_ip_route list"}]}, "kubernetes_pack_config_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/kubernetes_pack_config"}}, "title": "Response: Retrieve kubernetes_pack_config item"}]}, "kubernetes_pack_config_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/kubernetes_pack_config"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/kubernetes_pack_configs?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/kubernetes_pack_configs?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/kubernetes_pack_configs?page=1&page_size=10"}}}}, "title": "Response: Retrieve kubernetes_pack_config list"}]}, "l2vpn_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/l2vpn"}}, "title": "Response: Retrieve l2vpn item"}]}, "l2vpn_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/l2vpn"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/l2vpns?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/l2vpns?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/l2vpns?page=1&page_size=10"}}}}, "title": "Response: Retrieve l2vpn list"}]}, "l2vpn_assignment_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/l2vpn_assignment"}}, "title": "Response: Retrieve l2vpn_assignment item"}]}, "l2vpn_assignment_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/l2vpn_assignment"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/l2vpn_assignments?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/l2vpn_assignments?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/l2vpn_assignments?page=1&page_size=10"}}}}, "title": "Response: Retrieve l2vpn_assignment list"}]}, "l2vpn_assignment_create_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/l2vpn_assignment_create"}}, "title": "Response: Retrieve l2vpn_assignment_create item"}]}, "l2vpn_assignment_create_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/l2vpn_assignment_create"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/l2vpn_assignment_creates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/l2vpn_assignment_creates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/l2vpn_assignment_creates?page=1&page_size=10"}}}}, "title": "Response: Retrieve l2vpn_assignment_create list"}]}, "l2vpn_assignment_update_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/l2vpn_assignment_update"}}, "title": "Response: Retrieve l2vpn_assignment_update item"}]}, "l2vpn_assignment_update_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/l2vpn_assignment_update"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/l2vpn_assignment_updates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/l2vpn_assignment_updates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/l2vpn_assignment_updates?page=1&page_size=10"}}}}, "title": "Response: Retrieve l2vpn_assignment_update list"}]}, "l2vpn_create_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/l2vpn_create"}}, "title": "Response: Retrieve l2vpn_create item"}]}, "l2vpn_create_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/l2vpn_create"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/l2vpn_creates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/l2vpn_creates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/l2vpn_creates?page=1&page_size=10"}}}}, "title": "Response: Retrieve l2vpn_create list"}]}, "l2vpn_update_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/l2vpn_update"}}, "title": "Response: Retrieve l2vpn_update item"}]}, "l2vpn_update_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/l2vpn_update"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/l2vpn_updates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/l2vpn_updates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/l2vpn_updates?page=1&page_size=10"}}}}, "title": "Response: Retrieve l2vpn_update list"}]}, "lacp_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/lacp"}}, "title": "Response: Retrieve lacp item"}]}, "lag_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/lag"}}, "title": "Response: Retrieve lag item"}]}, "lag_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/lag"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/lags?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/lags?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/lags?page=1&page_size=10"}}}}, "title": "Response: Retrieve lag list"}]}, "lag_create_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/lag_create"}}, "title": "Response: Retrieve lag_create item"}]}, "lag_create_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/lag_create"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/lag_creates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/lag_creates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/lag_creates?page=1&page_size=10"}}}}, "title": "Response: Retrieve lag_create list"}]}, "lag_update_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/lag_update"}}, "title": "Response: Retrieve lag_update item"}]}, "lag_update_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/lag_update"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/lag_updates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/lag_updates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/lag_updates?page=1&page_size=10"}}}}, "title": "Response: Retrieve lag_update list"}]}, "license_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/license"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/licenses?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/licenses?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/licenses?page=1&page_size=10"}}}}, "title": "Response: Retrieve license list"}]}, "licenses_request_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/licenses_request"}}, "title": "Response: Retrieve licenses_request item"}]}, "mac_address_with_mask_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/mac_address_with_mask"}}, "title": "Response: Retrieve mac_address_with_mask item"}]}, "mac_address_with_mask_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/mac_address_with_mask"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/mac_address_with_masks?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/mac_address_with_masks?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/mac_address_with_masks?page=1&page_size=10"}}}}, "title": "Response: Retrieve mac_address_with_mask list"}]}, "mac_attachment_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/mac_attachment"}}, "title": "Response: Retrieve mac_attachment item"}]}, "mac_attachment_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/mac_attachment"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/mac_attachments?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/mac_attachments?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/mac_attachments?page=1&page_size=10"}}}}, "title": "Response: Retrieve mac_attachment list"}]}, "mac_attachment_object_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/mac_attachment_object"}}, "title": "Response: Retrieve mac_attachment_object item"}]}, "mac_attachment_object_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/mac_attachment_object"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/mac_attachment_objects?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/mac_attachment_objects?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/mac_attachment_objects?page=1&page_size=10"}}}}, "title": "Response: Retrieve mac_attachment_object list"}]}, "mac_learning_config_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/mac_learning_config"}}, "title": "Response: Retrieve mac_learning_config item"}]}, "mac_learning_default_config_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/mac_learning_default_config"}}, "title": "Response: Retrieve mac_learning_default_config item"}]}, "neighbor_discovery_advertisement_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/neighbor_discovery_advertisement"}}, "title": "Response: Retrieve neighbor_discovery_advertisement item"}]}, "neighbor_discovery_advertisement_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/neighbor_discovery_advertisement"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/neighbor_discovery_advertisements?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/neighbor_discovery_advertisements?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/neighbor_discovery_advertisements?page=1&page_size=10"}}}}, "title": "Response: Retrieve neighbor_discovery_advertisement list"}]}, "neighbor_discovery_advertisement_create_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/neighbor_discovery_advertisement_create"}}, "title": "Response: Retrieve neighbor_discovery_advertisement_create item"}]}, "neighbor_discovery_advertisement_create_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/neighbor_discovery_advertisement_create"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/neighbor_discovery_advertisement_creates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/neighbor_discovery_advertisement_creates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/neighbor_discovery_advertisement_creates?page=1&page_size=10"}}}}, "title": "Response: Retrieve neighbor_discovery_advertisement_create list"}]}, "neighbor_discovery_advertisement_update_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/neighbor_discovery_advertisement_update"}}, "title": "Response: Retrieve neighbor_discovery_advertisement_update item"}]}, "neighbor_discovery_advertisement_update_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/neighbor_discovery_advertisement_update"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/neighbor_discovery_advertisement_updates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/neighbor_discovery_advertisement_updates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/neighbor_discovery_advertisement_updates?page=1&page_size=10"}}}}, "title": "Response: Retrieve neighbor_discovery_advertisement_update list"}]}, "neighbor_discovery_configuration_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/neighbor_discovery_configuration"}}, "title": "Response: Retrieve neighbor_discovery_configuration item"}]}, "neighbor_discovery_configuration_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/neighbor_discovery_configuration"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/neighbor_discovery_configurations?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/neighbor_discovery_configurations?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/neighbor_discovery_configurations?page=1&page_size=10"}}}}, "title": "Response: Retrieve neighbor_discovery_configuration list"}]}, "neighbor_discovery_configuration_create_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/neighbor_discovery_configuration_create"}}, "title": "Response: Retrieve neighbor_discovery_configuration_create item"}]}, "neighbor_discovery_configuration_create_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/neighbor_discovery_configuration_create"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/neighbor_discovery_configuration_creates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/neighbor_discovery_configuration_creates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/neighbor_discovery_configuration_creates?page=1&page_size=10"}}}}, "title": "Response: Retrieve neighbor_discovery_configuration_create list"}]}, "neighbor_discovery_configuration_update_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/neighbor_discovery_configuration_update"}}, "title": "Response: Retrieve neighbor_discovery_configuration_update item"}]}, "neighbor_discovery_configuration_update_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/neighbor_discovery_configuration_update"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/neighbor_discovery_configuration_updates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/neighbor_discovery_configuration_updates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/neighbor_discovery_configuration_updates?page=1&page_size=10"}}}}, "title": "Response: Retrieve neighbor_discovery_configuration_update list"}]}, "neighbor_discovery_statistic_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/neighbor_discovery_statistic"}}, "title": "Response: Retrieve neighbor_discovery_statistic item"}]}, "neighbor_discovery_statistic_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/neighbor_discovery_statistic"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/neighbor_discovery_statistics?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/neighbor_discovery_statistics?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/neighbor_discovery_statistics?page=1&page_size=10"}}}}, "title": "Response: Retrieve neighbor_discovery_statistic list"}]}, "nsx_pack_config_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/nsx_pack_config"}}, "title": "Response: Retrieve nsx_pack_config item"}]}, "nsx_pack_config_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/nsx_pack_config"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/nsx_pack_configs?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/nsx_pack_configs?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/nsx_pack_configs?page=1&page_size=10"}}}}, "title": "Response: Retrieve nsx_pack_config list"}]}, "ntp_client_configuration_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/ntp_client_configuration"}}, "title": "Response: Retrieve ntp_client_configuration item"}]}, "ntp_client_configuration_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/ntp_client_configuration"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/ntp_client_configurations?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/ntp_client_configurations?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/ntp_client_configurations?page=1&page_size=10"}}}}, "title": "Response: Retrieve ntp_client_configuration list"}]}, "ntp_client_configuration_create_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/ntp_client_configuration_create"}}, "title": "Response: Retrieve ntp_client_configuration_create item"}]}, "ntp_client_configuration_create_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/ntp_client_configuration_create"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/ntp_client_configuration_creates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/ntp_client_configuration_creates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/ntp_client_configuration_creates?page=1&page_size=10"}}}}, "title": "Response: Retrieve ntp_client_configuration_create list"}]}, "ntp_client_configuration_update_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/ntp_client_configuration_update"}}, "title": "Response: Retrieve ntp_client_configuration_update item"}]}, "ntp_client_configuration_update_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/ntp_client_configuration_update"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/ntp_client_configuration_updates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/ntp_client_configuration_updates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/ntp_client_configuration_updates?page=1&page_size=10"}}}}, "title": "Response: Retrieve ntp_client_configuration_update list"}]}, "nutanix_pack_config_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/nutanix_pack_config"}}, "title": "Response: Retrieve nutanix_pack_config item"}]}, "nutanix_pack_config_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/nutanix_pack_config"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/nutanix_pack_configs?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/nutanix_pack_configs?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/nutanix_pack_configs?page=1&page_size=10"}}}}, "title": "Response: Retrieve nutanix_pack_config list"}]}, "oneview_pack_config_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/oneview_pack_config"}}, "title": "Response: Retrieve oneview_pack_config item"}]}, "oneview_pack_config_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/oneview_pack_config"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/oneview_pack_configs?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/oneview_pack_configs?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/oneview_pack_configs?page=1&page_size=10"}}}}, "title": "Response: Retrieve oneview_pack_config list"}]}, "ospf_area_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/ospf_area"}}, "title": "Response: Retrieve ospf_area item"}]}, "ospf_area_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/ospf_area"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/ospf_areas?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/ospf_areas?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/ospf_areas?page=1&page_size=10"}}}}, "title": "Response: Retrieve ospf_area list"}]}, "ospf_area_create_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/ospf_area_create"}}, "title": "Response: Retrieve ospf_area_create item"}]}, "ospf_area_create_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/ospf_area_create"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/ospf_area_creates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/ospf_area_creates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/ospf_area_creates?page=1&page_size=10"}}}}, "title": "Response: Retrieve ospf_area_create list"}]}, "ospf_area_update_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/ospf_area_update"}}, "title": "Response: Retrieve ospf_area_update item"}]}, "ospf_area_update_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/ospf_area_update"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/ospf_area_updates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/ospf_area_updates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/ospf_area_updates?page=1&page_size=10"}}}}, "title": "Response: Retrieve ospf_area_update list"}]}, "ospf_database_state_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/ospf_database_state"}}, "title": "Response: Retrieve ospf_database_state item"}]}, "ospf_database_state_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/ospf_database_state"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/ospf_database_states?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/ospf_database_states?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/ospf_database_states?page=1&page_size=10"}}}}, "title": "Response: Retrieve ospf_database_state list"}]}, "ospf_global_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/ospf_global"}}, "title": "Response: Retrieve ospf_global item"}]}, "ospf_global_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/ospf_global"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/vpcs/{vpc_uuid}/ospf?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/vpcs/{vpc_uuid}/ospf?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/vpcs/{vpc_uuid}/ospf?page=1&page_size=10"}}}}, "title": "Response: Retrieve ospf_global list"}]}, "ospf_global_create_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/ospf_global_create"}}, "title": "Response: Retrieve ospf_global_create item"}]}, "ospf_global_create_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/ospf_global_create"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/vpcs/{vpc_uuid}/ospf?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/vpcs/{vpc_uuid}/ospf?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/vpcs/{vpc_uuid}/ospf?page=1&page_size=10"}}}}, "title": "Response: Retrieve ospf_global_create list"}]}, "ospf_global_state_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/ospf_global_state"}}, "title": "Response: Retrieve ospf_global_state item"}]}, "ospf_global_state_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/ospf_global_state"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/ospf_global_states?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/ospf_global_states?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/ospf_global_states?page=1&page_size=10"}}}}, "title": "Response: Retrieve ospf_global_state list"}]}, "ospf_global_update_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/ospf_global_update"}}, "title": "Response: Retrieve ospf_global_update item"}]}, "ospf_global_update_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/ospf_global_update"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/vpcs/{vpc_uuid}/ospf?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/vpcs/{vpc_uuid}/ospf?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/vpcs/{vpc_uuid}/ospf?page=1&page_size=10"}}}}, "title": "Response: Retrieve ospf_global_update list"}]}, "ospf_interface_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/ospf_interface"}}, "title": "Response: Retrieve ospf_interface item"}]}, "ospf_interface_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/ospf_interface"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/ospf_interfaces?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/ospf_interfaces?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/ospf_interfaces?page=1&page_size=10"}}}}, "title": "Response: Retrieve ospf_interface list"}]}, "ospf_interface_create_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/ospf_interface_create"}}, "title": "Response: Retrieve ospf_interface_create item"}]}, "ospf_interface_create_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/ospf_interface_create"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/ospf_interface_creates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/ospf_interface_creates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/ospf_interface_creates?page=1&page_size=10"}}}}, "title": "Response: Retrieve ospf_interface_create list"}]}, "ospf_interface_reset_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/ospf_interface_reset"}}, "title": "Response: Retrieve ospf_interface_reset item"}]}, "ospf_interface_reset_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/ospf_interface_reset"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/ospf_interface_resets?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/ospf_interface_resets?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/ospf_interface_resets?page=1&page_size=10"}}}}, "title": "Response: Retrieve ospf_interface_reset list"}]}, "ospf_interface_state_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/ospf_interface_state"}}, "title": "Response: Retrieve ospf_interface_state item"}]}, "ospf_interface_state_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/ospf_interface_state"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/ospf_interface_states?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/ospf_interface_states?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/ospf_interface_states?page=1&page_size=10"}}}}, "title": "Response: Retrieve ospf_interface_state list"}]}, "ospf_interface_update_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/ospf_interface_update"}}, "title": "Response: Retrieve ospf_interface_update item"}]}, "ospf_interface_update_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/ospf_interface_update"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/ospf_interface_updates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/ospf_interface_updates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/ospf_interface_updates?page=1&page_size=10"}}}}, "title": "Response: Retrieve ospf_interface_update list"}]}, "ospf_neighbor_state_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/ospf_neighbor_state"}}, "title": "Response: Retrieve ospf_neighbor_state item"}]}, "ospf_neighbor_state_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/ospf_neighbor_state"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/ospf_neighbor_states?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/ospf_neighbor_states?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/ospf_neighbor_states?page=1&page_size=10"}}}}, "title": "Response: Retrieve ospf_neighbor_state list"}]}, "ospf_network_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/ospf_network"}}, "title": "Response: Retrieve ospf_network item"}]}, "ospf_network_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/ospf_network"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/ospf_networks?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/ospf_networks?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/ospf_networks?page=1&page_size=10"}}}}, "title": "Response: Retrieve ospf_network list"}]}, "ospf_state_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/ospf_state"}}, "title": "Response: Retrieve ospf_state item"}]}, "ospf_state_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/ospf_state"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/vpcs/{vpc_uuid}/ospf/status?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/vpcs/{vpc_uuid}/ospf/status?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/vpcs/{vpc_uuid}/ospf/status?page=1&page_size=10"}}}}, "title": "Response: Retrieve ospf_state list"}]}, "password_policy_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/password_policy"}}, "title": "Response: Retrieve password_policy item"}]}, "path_actor_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/path_actor"}}, "title": "Response: Retrieve path_actor item"}]}, "path_actor_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/path_actor"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/path_actors?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/path_actors?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/path_actors?page=1&page_size=10"}}}}, "title": "Response: Retrieve path_actor list"}]}, "path_actor_create_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/path_actor_create"}}, "title": "Response: Retrieve path_actor_create item"}]}, "path_actor_create_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/path_actor_create"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/path_actor_creates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/path_actor_creates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/path_actor_creates?page=1&page_size=10"}}}}, "title": "Response: Retrieve path_actor_create list"}]}, "path_actor_update_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/path_actor_update"}}, "title": "Response: Retrieve path_actor_update item"}]}, "path_actor_update_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/path_actor_update"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/path_actor_updates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/path_actor_updates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/path_actor_updates?page=1&page_size=10"}}}}, "title": "Response: Retrieve path_actor_update list"}]}, "peer_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/peer"}}, "title": "Response: Retrieve peer item"}]}, "peer_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/peer"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/peers?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/peers?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/peers?page=1&page_size=10"}}}}, "title": "Response: Retrieve peer list"}]}, "pim_config_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/pim_config"}}, "title": "Response: Retrieve pim_config item"}]}, "pim_config_create_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/pim_config_create"}}, "title": "Response: Retrieve pim_config_create item"}]}, "pim_config_get_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/pim_config_get"}}, "title": "Response: Retrieve pim_config_get item"}]}, "pim_config_update_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/pim_config_update"}}, "title": "Response: Retrieve pim_config_update item"}]}, "pim_global_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/pim_global"}}, "title": "Response: Retrieve pim_global item"}]}, "pim_interface_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/pim_interface"}}, "title": "Response: Retrieve pim_interface item"}]}, "pim_interface_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/pim_interface"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/pim_interfaces?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/pim_interfaces?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/pim_interfaces?page=1&page_size=10"}}}}, "title": "Response: Retrieve pim_interface list"}]}, "pod_generic_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/pod_generic"}}, "title": "Response: Retrieve pod_generic item"}]}, "pod_generic_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/pod_generic"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/pods?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/pods?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/pods?page=1&page_size=10"}}}}, "title": "Response: Retrieve pod_generic list"}]}, "port_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/port"}}, "title": "Response: Retrieve port item"}]}, "port_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/port"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/ports?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/ports?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/ports?page=1&page_size=10"}}}}, "title": "Response: Retrieve port list"}]}, "port_mirror_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/port_mirror"}}, "title": "Response: Retrieve port_mirror item"}]}, "port_mirror_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/port_mirror"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/port_mirrors?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/port_mirrors?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/port_mirrors?page=1&page_size=10"}}}}, "title": "Response: Retrieve port_mirror list"}]}, "port_speed_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/port_speed"}}, "title": "Response: Retrieve port_speed item"}]}, "port_statistic_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/port_statistic"}}, "title": "Response: Retrieve port_statistic item"}]}, "port_statistic_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/port_statistic"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/port_statistics?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/port_statistics?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/port_statistics?page=1&page_size=10"}}}}, "title": "Response: Retrieve port_statistic list"}]}, "qualifier_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/qualifier"}}, "title": "Response: Retrieve qualifier item"}]}, "qualifier_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/qualifier"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/qualifiers?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/qualifiers?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/qualifiers?page=1&page_size=10"}}}}, "title": "Response: Retrieve qualifier list"}]}, "qualifier_create_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/qualifier_create"}}, "title": "Response: Retrieve qualifier_create item"}]}, "qualifier_create_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/qualifier_create"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/qualifier_creates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/qualifier_creates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/qualifier_creates?page=1&page_size=10"}}}}, "title": "Response: Retrieve qualifier_create list"}]}, "qualifier_update_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/qualifier_update"}}, "title": "Response: Retrieve qualifier_update item"}]}, "qualifier_update_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/qualifier_update"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/qualifier_updates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/qualifier_updates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/qualifier_updates?page=1&page_size=10"}}}}, "title": "Response: Retrieve qualifier_update list"}]}, "route_target_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/route_target"}}, "title": "Response: Retrieve route_target item"}]}, "route_target_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/route_target"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/route_targets?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/route_targets?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/route_targets?page=1&page_size=10"}}}}, "title": "Response: Retrieve route_target list"}]}, "setting_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/setting"}}, "title": "Response: Retrieve setting item"}]}, "setting_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/setting"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/settings?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/settings?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/settings?page=1&page_size=10"}}}}, "title": "Response: Retrieve setting list"}]}, "sflow_configuration_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/sflow_configuration"}}, "title": "Response: Retrieve sflow_configuration item"}]}, "sflow_configuration_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/sflow_configuration"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/sflow_configurations?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/sflow_configurations?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/sflow_configurations?page=1&page_size=10"}}}}, "title": "Response: Retrieve sflow_configuration list"}]}, "sflow_configuration_create_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/sflow_configuration_create"}}, "title": "Response: Retrieve sflow_configuration_create item"}]}, "sflow_configuration_create_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/sflow_configuration_create"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/sflow_configuration_creates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/sflow_configuration_creates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/sflow_configuration_creates?page=1&page_size=10"}}}}, "title": "Response: Retrieve sflow_configuration_create list"}]}, "sflow_configuration_update_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/sflow_configuration_update"}}, "title": "Response: Retrieve sflow_configuration_update item"}]}, "sflow_configuration_update_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/sflow_configuration_update"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/sflow_configuration_updates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/sflow_configuration_updates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/sflow_configuration_updates?page=1&page_size=10"}}}}, "title": "Response: Retrieve sflow_configuration_update list"}]}, "sflow_port_override_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/sflow_port_override"}}, "title": "Response: Retrieve sflow_port_override item"}]}, "sflow_port_override_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/sflow_port_override"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/sflow_port_overrides?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/sflow_port_overrides?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/sflow_port_overrides?page=1&page_size=10"}}}}, "title": "Response: Retrieve sflow_port_override list"}]}, "simplivity_pack_config_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/simplivity_pack_config"}}, "title": "Response: Retrieve simplivity_pack_config item"}]}, "simplivity_pack_config_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/simplivity_pack_config"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/simplivity_pack_configs?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/simplivity_pack_configs?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/simplivity_pack_configs?page=1&page_size=10"}}}}, "title": "Response: Retrieve simplivity_pack_config list"}]}, "snmp_configuration_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/snmp_configuration"}}, "title": "Response: Retrieve snmp_configuration item"}]}, "snmp_configuration_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/snmp_configuration"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/snmp_configurations?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/snmp_configurations?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/snmp_configurations?page=1&page_size=10"}}}}, "title": "Response: Retrieve snmp_configuration list"}]}, "software_image_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/software_image"}}, "title": "Response: Retrieve software_image item"}]}, "software_image_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/software_image"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/software_images?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/software_images?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/software_images?page=1&page_size=10"}}}}, "title": "Response: Retrieve software_image list"}]}, "software_state_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/software_state"}}, "title": "Response: Retrieve software_state item"}]}, "software_state_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/software_state"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/software_states?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/software_states?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/software_states?page=1&page_size=10"}}}}, "title": "Response: Retrieve software_state list"}]}, "staging_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/staging"}}, "title": "Response: Retrieve staging item"}]}, "staging_state_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/staging_state"}}, "title": "Response: Retrieve staging_state item"}]}, "staging_state_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/staging_state"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/staging_states?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/staging_states?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/staging_states?page=1&page_size=10"}}}}, "title": "Response: Retrieve staging_state list"}]}, "statistic_configuration_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/statistic_configuration"}}, "title": "Response: Retrieve statistic_configuration item"}]}, "statistic_configuration_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/statistic_configuration"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/statistic_configurations?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/statistic_configurations?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/statistic_configurations?page=1&page_size=10"}}}}, "title": "Response: Retrieve statistic_configuration list"}]}, "statistic_configuration_update_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/statistic_configuration_update"}}, "title": "Response: Retrieve statistic_configuration_update item"}]}, "statistic_configuration_update_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/statistic_configuration_update"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/statistic_configuration_updates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/statistic_configuration_updates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/statistic_configuration_updates?page=1&page_size=10"}}}}, "title": "Response: Retrieve statistic_configuration_update list"}]}, "support_bundle_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/support_bundle"}}, "title": "Response: Retrieve support_bundle item"}]}, "support_bundle_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/support_bundle"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/support_bundles?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/support_bundles?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/support_bundles?page=1&page_size=10"}}}}, "title": "Response: Retrieve support_bundle list"}]}, "support_bundle_create_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/support_bundle_create"}}, "title": "Response: Retrieve support_bundle_create item"}]}, "support_bundle_create_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/support_bundle_create"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/support_bundle_creates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/support_bundle_creates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/support_bundle_creates?page=1&page_size=10"}}}}, "title": "Response: Retrieve support_bundle_create list"}]}, "support_bundle_file_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/support_bundle_file"}}, "title": "Response: Retrieve support_bundle_file item"}]}, "support_bundle_file_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/support_bundle_file"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/support_bundle_files?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/support_bundle_files?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/support_bundle_files?page=1&page_size=10"}}}}, "title": "Response: Retrieve support_bundle_file list"}]}, "switch_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/switch"}}, "title": "Response: Retrieve switch item"}]}, "switch_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/switch"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/switches?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/switches?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/switches?page=1&page_size=10"}}}}, "title": "Response: Retrieve switch list"}]}, "switch_reconcile_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/switch_reconcile"}}, "title": "Response: Retrieve switch_reconcile item"}]}, "switch_reconcile_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/switch_reconcile"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/switches?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/switches?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/switches?page=1&page_size=10"}}}}, "title": "Response: Retrieve switch_reconcile list"}]}, "switch_replacement_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/switch_replacement"}}, "title": "Response: Retrieve switch_replacement item"}]}, "switch_replacement_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/switch_replacement"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/switches?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/switches?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/switches?page=1&page_size=10"}}}}, "title": "Response: Retrieve switch_replacement list"}]}, "switch_status_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/switch_status"}}, "title": "Response: Retrieve switch_status item"}]}, "switch_status_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/switch_status"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/switches/status?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/switches/status?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/switches/status?page=1&page_size=10"}}}}, "title": "Response: Retrieve switch_status list"}]}, "switch_status_disk_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/switch_status_disk"}}, "title": "Response: Retrieve switch_status_disk item"}]}, "switch_status_disk_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/switch_status_disk"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/switch_status_disks?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/switch_status_disks?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/switch_status_disks?page=1&page_size=10"}}}}, "title": "Response: Retrieve switch_status_disk list"}]}, "switch_status_fan_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/switch_status_fan"}}, "title": "Response: Retrieve switch_status_fan item"}]}, "switch_status_fan_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/switch_status_fan"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/switch_status_fans?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/switch_status_fans?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/switch_status_fans?page=1&page_size=10"}}}}, "title": "Response: Retrieve switch_status_fan list"}]}, "switch_status_temperature_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/switch_status_temperature"}}, "title": "Response: Retrieve switch_status_temperature item"}]}, "switch_status_temperature_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/switch_status_temperature"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/switch_status_temperatures?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/switch_status_temperatures?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/switch_status_temperatures?page=1&page_size=10"}}}}, "title": "Response: Retrieve switch_status_temperature list"}]}, "switch_upgrade_process_state_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/switch_upgrade_process_state"}}, "title": "Response: Retrieve switch_upgrade_process_state item"}]}, "switch_upgrade_process_state_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/switch_upgrade_process_state"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/switch_upgrade_process_states?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/switch_upgrade_process_states?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/switch_upgrade_process_states?page=1&page_size=10"}}}}, "title": "Response: Retrieve switch_upgrade_process_state list"}]}, "syslog_client_configuration_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/syslog_client_configuration"}}, "title": "Response: Retrieve syslog_client_configuration item"}]}, "syslog_client_configuration_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/syslog_client_configuration"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/syslog_client_configurations?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/syslog_client_configurations?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/syslog_client_configurations?page=1&page_size=10"}}}}, "title": "Response: Retrieve syslog_client_configuration list"}]}, "syslog_client_configuration_create_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/syslog_client_configuration_create"}}, "title": "Response: Retrieve syslog_client_configuration_create item"}]}, "syslog_client_configuration_create_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/syslog_client_configuration_create"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/syslog_client_configuration_creates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/syslog_client_configuration_creates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/syslog_client_configuration_creates?page=1&page_size=10"}}}}, "title": "Response: Retrieve syslog_client_configuration_create list"}]}, "syslog_client_configuration_update_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/syslog_client_configuration_update"}}, "title": "Response: Retrieve syslog_client_configuration_update item"}]}, "syslog_client_configuration_update_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/syslog_client_configuration_update"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/syslog_client_configuration_updates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/syslog_client_configuration_updates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/syslog_client_configuration_updates?page=1&page_size=10"}}}}, "title": "Response: Retrieve syslog_client_configuration_update list"}]}, "tacacs_configuration_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/tacacs_configuration"}}, "title": "Response: Retrieve tacacs_configuration item"}]}, "tacacs_configuration_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/tacacs_configuration"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/tacacs_configurations?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/tacacs_configurations?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/tacacs_configurations?page=1&page_size=10"}}}}, "title": "Response: Retrieve tacacs_configuration list"}]}, "tag_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/tag"}}, "title": "Response: Retrieve tag item"}]}, "tag_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/tag"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/tags?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/tags?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/tags?page=1&page_size=10"}}}}, "title": "Response: Retrieve tag list"}]}, "topology_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/topology"}}, "title": "Response: Retrieve topology item"}]}, "topology_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/topology"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/topologies?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/topologies?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/topologies?page=1&page_size=10"}}}}, "title": "Response: Retrieve topology list"}]}, "topology_create_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/topology_create"}}, "title": "Response: Retrieve topology_create item"}]}, "topology_create_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/topology_create"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/topology_creates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/topology_creates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/topology_creates?page=1&page_size=10"}}}}, "title": "Response: Retrieve topology_create list"}]}, "topology_paths_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/topology_paths"}}, "title": "Response: Retrieve topology_paths item"}]}, "topology_paths_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/topology_paths"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/topologies/{uuid}/paths?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/topologies/{uuid}/paths?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/topologies/{uuid}/paths?page=1&page_size=10"}}}}, "title": "Response: Retrieve topology_paths list"}]}, "topology_paths_exploded_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/topology_paths_exploded"}}, "title": "Response: Retrieve topology_paths_exploded item"}]}, "topology_paths_exploded_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/topology_paths_exploded"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/topologies/{uuid}/paths_exploded?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/topologies/{uuid}/paths_exploded?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/topologies/{uuid}/paths_exploded?page=1&page_size=10"}}}}, "title": "Response: Retrieve topology_paths_exploded list"}]}, "topology_update_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/topology_update"}}, "title": "Response: Retrieve topology_update item"}]}, "topology_update_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/topology_update"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/topology_updates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/topology_updates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/topology_updates?page=1&page_size=10"}}}}, "title": "Response: Retrieve topology_update list"}]}, "traffic_matrix_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/traffic_matrix"}}, "title": "Response: Retrieve traffic_matrix item"}]}, "traffic_matrix_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/traffic_matrix"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/traffic_matrices?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/traffic_matrices?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/traffic_matrices?page=1&page_size=10"}}}}, "title": "Response: Retrieve traffic_matrix list"}]}, "traffic_matrix_create_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/traffic_matrix_create"}}, "title": "Response: Retrieve traffic_matrix_create item"}]}, "traffic_matrix_create_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/traffic_matrix_create"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/traffic_matrix_creates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/traffic_matrix_creates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/traffic_matrix_creates?page=1&page_size=10"}}}}, "title": "Response: Retrieve traffic_matrix_create list"}]}, "traffic_matrix_update_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/traffic_matrix_update"}}, "title": "Response: Retrieve traffic_matrix_update item"}]}, "traffic_matrix_update_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/traffic_matrix_update"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/traffic_matrix_updates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/traffic_matrix_updates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/traffic_matrix_updates?page=1&page_size=10"}}}}, "title": "Response: Retrieve traffic_matrix_update list"}]}, "transceiver_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/transceiver"}}, "title": "Response: Retrieve transceiver item"}]}, "transceiver_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/transceiver"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/transceivers?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/transceivers?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/transceivers?page=1&page_size=10"}}}}, "title": "Response: Retrieve transceiver list"}]}, "upgrade_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/upgrade"}}, "title": "Response: Retrieve upgrade item"}]}, "upgrade_state_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/upgrade_state"}}, "title": "Response: Retrieve upgrade_state item"}]}, "upgrade_state_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/upgrade_state"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/upgrade_states?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/upgrade_states?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/upgrade_states?page=1&page_size=10"}}}}, "title": "Response: Retrieve upgrade_state list"}]}, "user_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/user"}}, "title": "Response: Retrieve user item"}]}, "user_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/user"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/users?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/users?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/users?page=1&page_size=10"}}}}, "title": "Response: Retrieve user list"}]}, "uuid_with_type_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/uuid_with_type"}}, "title": "Response: Retrieve uuid_with_type item"}]}, "uuid_with_type_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/uuid_with_type"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/uuid_with_types?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/uuid_with_types?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/uuid_with_types?page=1&page_size=10"}}}}, "title": "Response: Retrieve uuid_with_type list"}]}, "uuid_with_type_l2vpn_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/uuid_with_type_l2vpn"}}, "title": "Response: Retrieve uuid_with_type_l2vpn item"}]}, "uuid_with_type_l2vpn_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/uuid_with_type_l2vpn"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/uuid_with_type_l2vpns?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/uuid_with_type_l2vpns?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/uuid_with_type_l2vpns?page=1&page_size=10"}}}}, "title": "Response: Retrieve uuid_with_type_l2vpn list"}]}, "vip_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/vip"}}, "title": "Response: Retrieve vip item"}]}, "vip_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/vip"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/vips?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/vips?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/vips?page=1&page_size=10"}}}}, "title": "Response: Retrieve vip list"}]}, "vip_create_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/vip_create"}}, "title": "Response: Retrieve vip_create item"}]}, "vip_create_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/vip_create"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/vip_creates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/vip_creates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/vip_creates?page=1&page_size=10"}}}}, "title": "Response: Retrieve vip_create list"}]}, "vip_update_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/vip_update"}}, "title": "Response: Retrieve vip_update item"}]}, "vip_update_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/vip_update"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/vip_updates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/vip_updates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/vip_updates?page=1&page_size=10"}}}}, "title": "Response: Retrieve vip_update list"}]}, "virtual_mac_address_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/virtual_mac_address"}}, "title": "Response: Retrieve virtual_mac_address item"}]}, "vlan_group_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/vlan_group"}}, "title": "Response: Retrieve vlan_group item"}]}, "vlan_group_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/vlan_group"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/vlan_groups?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/vlan_groups?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/vlan_groups?page=1&page_size=10"}}}}, "title": "Response: Retrieve vlan_group list"}]}, "vlan_group_create_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/vlan_group_create"}}, "title": "Response: Retrieve vlan_group_create item"}]}, "vlan_group_create_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/vlan_group_create"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/vlan_group_creates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/vlan_group_creates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/vlan_group_creates?page=1&page_size=10"}}}}, "title": "Response: Retrieve vlan_group_create list"}]}, "vlan_group_update_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/vlan_group_update"}}, "title": "Response: Retrieve vlan_group_update item"}]}, "vlan_group_update_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/vlan_group_update"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/vlan_group_updates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/vlan_group_updates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/vlan_group_updates?page=1&page_size=10"}}}}, "title": "Response: Retrieve vlan_group_update list"}]}, "vm_generic_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/vm_generic"}}, "title": "Response: Retrieve vm_generic item"}]}, "vm_generic_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/vm_generic"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/vms?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/vms?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/vms?page=1&page_size=10"}}}}, "title": "Response: Retrieve vm_generic list"}]}, "vmkernel_adapter_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/vmkernel_adapter"}}, "title": "Response: Retrieve vmkernel_adapter item"}]}, "vmkernel_adapter_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/vmkernel_adapter"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/vmkernel_adapters?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/vmkernel_adapters?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/vmkernel_adapters?page=1&page_size=10"}}}}, "title": "Response: Retrieve vmkernel_adapter list"}]}, "vpc_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/vpc"}}, "title": "Response: Retrieve vpc item"}]}, "vpc_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/vpc"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/vpcs?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/vpcs?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/vpcs?page=1&page_size=10"}}}}, "title": "Response: Retrieve vpc list"}]}, "vpc_create_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/vpc_create"}}, "title": "Response: Retrieve vpc_create item"}]}, "vpc_create_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/vpc_create"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/vpc_creates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/vpc_creates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/vpc_creates?page=1&page_size=10"}}}}, "title": "Response: Retrieve vpc_create list"}]}, "vpc_update_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/vpc_update"}}, "title": "Response: Retrieve vpc_update item"}]}, "vpc_update_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/vpc_update"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/vpc_updates?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/vpc_updates?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/vpc_updates?page=1&page_size=10"}}}}, "title": "Response: Retrieve vpc_update list"}]}, "vpc_write_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/vpc_write"}}, "title": "Response: Retrieve vpc_write item"}]}, "vpc_write_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/vpc_write"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/vpc_writes?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/vpc_writes?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/vpc_writes?page=1&page_size=10"}}}}, "title": "Response: Retrieve vpc_write list"}]}, "vsphere_pack_config_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/vsphere_pack_config"}}, "title": "Response: Retrieve vsphere_pack_config item"}]}, "vsphere_pack_config_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/vsphere_pack_config"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/vsphere_pack_configs?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/vsphere_pack_configs?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/vsphere_pack_configs?page=1&page_size=10"}}}}, "title": "Response: Retrieve vsphere_pack_config list"}]}, "vsphere_plugin_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/vsphere_plugin"}}, "title": "Response: Retrieve vsphere_plugin item"}]}, "vsphere_plugin_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/vsphere_plugin"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/vsphere_plugins?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/vsphere_plugins?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/vsphere_plugins?page=1&page_size=10"}}}}, "title": "Response: Retrieve vsphere_plugin list"}]}, "vswitch_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"$ref": "#/definitions/vswitch"}}, "title": "Response: Retrieve vswitch item"}]}, "vswitch_list_response": {"allOf": [{"$ref": "#/definitions/RetrievalResponse"}, {"properties": {"result": {"items": {"$ref": "#/definitions/vswitch"}, "type": "array"}, "page": {"required": ["current_page", "next_page", "last_page"], "type": "object", "properties": {"last_page": {"type": "string", "example": "/api/v1/vswitches?page=10&page_size=10"}, "next_page": {"type": "string", "example": "/api/v1/vswitches?page=2&page_size=10"}, "current_page": {"type": "string", "example": "/api/v1/vswitches?page=1&page_size=10"}}}}, "title": "Response: Retrieve vswitch list"}]}, "acl": {"additionalProperties": false, "required": ["uuid", "scope_uuids", "name", "priority", "enable", "qualifier_uuids", "actors"], "type": "object", "properties": {"priority": {"minimum": 0, "type": "integer", "maximum": 4095, "example": 0}, "enable": {"type": "boolean", "example": true}, "actors": {"items": {"type": "object", "properties": {"action": {"enum": ["allow", "drop", "forward_topology", "output", "forwarding_priority", "forward_next_hop"], "type": "string", "example": "drop"}, "action_object": {"anyOf": [{"additionalProperties": false, "type": "object", "properties": {"topology_uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}}}, {"additionalProperties": false, "type": "object", "properties": {"forwarding_priority": {"enum": ["very_low", "low", "medium", "high", "very_high"], "type": "string"}}}, {"additionalProperties": false, "type": "object", "properties": {"lag_uuids": {"items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array"}, "ports": {"items": {"$ref": "#/definitions/port_flat"}, "type": "array"}, "port_uuids": {"items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array"}, "lags": {"items": {"$ref": "#/definitions/lag"}, "type": "array"}}}, {"additionalProperties": false, "type": "object", "properties": {"forward_next_hop": {"oneOf": [{"format": "ipv4"}, {"format": "ipv6"}], "type": "string", "example": "192.168.1.1"}}}, {"type": "null"}]}}}, "type": "array"}, "uuid": {"min_length": 32, "description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": false, "max_length": 36, "maxLength": 36, "type": "string", "example": "313eff3f768f434399f8379ad93a8348"}, "qualifiers": {"items": {"$ref": "#/definitions/qualifier"}, "type": "array"}, "scope": {"anyOf": [{"additionalProperties": false, "type": "object", "properties": {"fabric": {"$ref": "#/definitions/fabric"}}}, {"additionalProperties": false, "type": "object", "properties": {"switches": {"items": {"$ref": "#/definitions/switch"}, "type": "array"}}}, {"additionalProperties": false, "type": "object", "properties": {"ports": {"items": {"$ref": "#/definitions/port_flat"}, "type": "array"}, "lags": {"items": {"$ref": "#/definitions/lag"}, "type": "array"}}}]}, "description": {"type": "string", "example": "ACL Description"}, "qualifier_uuids": {"items": {"min_length": 32, "description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": false, "max_length": 36, "maxLength": 36, "type": "string", "example": "183eff3f768f434399d7379ad93a8397"}, "type": "array"}, "scope_uuids": {"anyOf": [{"additionalProperties": false, "type": "object", "properties": {"fabric_uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}}}, {"additionalProperties": false, "type": "object", "properties": {"switch_uuids": {"items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array"}}}, {"additionalProperties": false, "type": "object", "properties": {"lag_uuids": {"items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array"}, "port_uuids": {"items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array"}}}]}, "name": {"type": "string", "example": "ACL"}}, "title": "Object: ACL"}, "acl_create": {"additionalProperties": false, "required": ["scope_uuids", "name", "priority", "enable", "qualifier_uuids", "actors"], "type": "object", "properties": {"enable": {"type": "boolean", "example": true}, "scope_uuids": {"anyOf": [{"additionalProperties": false, "type": "object", "properties": {"fabric_uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}}}, {"additionalProperties": false, "type": "object", "properties": {"switch_uuids": {"items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array"}}}, {"additionalProperties": false, "type": "object", "properties": {"lag_uuids": {"items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array"}, "port_uuids": {"items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array"}}}]}, "name": {"type": "string", "example": "ACL"}, "priority": {"minimum": 0, "type": "integer", "maximum": 4095, "example": 0}, "actors": {"items": {"type": "object", "properties": {"action": {"enum": ["allow", "drop", "forward_topology", "output", "forwarding_priority", "forward_next_hop"], "type": "string", "example": "drop"}, "action_object": {"anyOf": [{"additionalProperties": false, "type": "object", "properties": {"topology_uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}}}, {"additionalProperties": false, "type": "object", "properties": {"forwarding_priority": {"enum": ["very_low", "low", "medium", "high", "very_high"], "type": "string"}}}, {"additionalProperties": false, "type": "object", "properties": {"lag_uuids": {"items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array"}, "ports": {"items": {"$ref": "#/definitions/port_flat"}, "type": "array"}, "port_uuids": {"items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array"}, "lags": {"items": {"$ref": "#/definitions/lag"}, "type": "array"}}}, {"additionalProperties": false, "type": "object", "properties": {"forward_next_hop": {"oneOf": [{"format": "ipv4"}, {"format": "ipv6"}], "type": "string", "example": "192.168.1.1"}}}, {"type": "null"}]}}}, "type": "array"}, "qualifier_uuids": {"items": {"min_length": 32, "description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": false, "max_length": 36, "maxLength": 36, "type": "string", "example": "183eff3f768f434399d7379ad93a8397"}, "type": "array"}, "description": {"type": "string", "example": "ACL Description"}}, "title": "Object: ACL (create)"}, "acl_update": {"additionalProperties": false, "required": ["scope_uuids", "name", "priority", "enable", "qualifier_uuids", "actors"], "type": "object", "properties": {"enable": {"type": "boolean", "example": true}, "scope_uuids": {"anyOf": [{"additionalProperties": false, "type": "object", "properties": {"fabric_uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}}}, {"additionalProperties": false, "type": "object", "properties": {"switch_uuids": {"items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array"}}}, {"additionalProperties": false, "type": "object", "properties": {"lag_uuids": {"items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array"}, "port_uuids": {"items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array"}}}]}, "name": {"type": "string", "example": "ACL"}, "priority": {"minimum": 0, "type": "integer", "maximum": 4095, "example": 0}, "actors": {"items": {"type": "object", "properties": {"action": {"enum": ["allow", "drop", "forward_topology", "output", "forwarding_priority", "forward_next_hop"], "type": "string", "example": "drop"}, "action_object": {"anyOf": [{"additionalProperties": false, "type": "object", "properties": {"topology_uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}}}, {"additionalProperties": false, "type": "object", "properties": {"forwarding_priority": {"enum": ["very_low", "low", "medium", "high", "very_high"], "type": "string"}}}, {"additionalProperties": false, "type": "object", "properties": {"lag_uuids": {"items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array"}, "ports": {"items": {"$ref": "#/definitions/port_flat"}, "type": "array"}, "port_uuids": {"items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array"}, "lags": {"items": {"$ref": "#/definitions/lag"}, "type": "array"}}}, {"additionalProperties": false, "type": "object", "properties": {"forward_next_hop": {"oneOf": [{"format": "ipv4"}, {"format": "ipv6"}], "type": "string", "example": "192.168.1.1"}}}, {"type": "null"}]}}}, "type": "array"}, "qualifier_uuids": {"items": {"min_length": 32, "description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": false, "max_length": 36, "maxLength": 36, "type": "string", "example": "183eff3f768f434399d7379ad93a8397"}, "type": "array"}, "description": {"type": "string", "example": "ACL Description"}}, "title": "Object: ACL (update)"}, "affinity": {"additionalProperties": false, "required": ["name", "uuid", "groups", "fabric_uuid"], "type": "object", "properties": {"groups": {"items": {"type": "object", "$ref": "#/definitions/affinity_group"}, "type": "array"}, "admin_state": {"enum": ["disabled", "enabled"], "type": "string", "description": "Enable or disable affinity. Disabled affinities will not be included in full fits, and will be removed from partial fits", "example": "disabled"}, "name": {"type": "string", "example": "Affinity Foo", "format": "non_empty_or_whitespace_string"}, "precedence": {"description": "Precedence for affinity. The lower the number the higher the precedence", "default": 0, "maximum": 4294967295, "minimum": 0, "type": "integer", "example": 100}, "tags": {"$ref": "#/definitions/tags_on_object"}, "fabric_uuid": {"readOnly": true, "description": "Fabric uuid", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "actors": {"items": {"type": "object", "$ref": "#/definitions/uuid_with_type"}, "type": "array", "description": "List of actors. "}, "uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "description": {"type": "string", "example": "Affinity Foo"}}, "title": "Object: Affinity"}, "affinity_actor": {"additionalProperties": false, "required": ["type", "actor_uuid"], "type": "object", "properties": {"type": {"enum": ["path"], "type": "string", "description": "Actor's type.", "example": "path"}, "actor_uuid": {"readOnly": true, "description": "UUID of actor", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}}, "title": "Object: Affinity Actor"}, "affinity_create": {"additionalProperties": false, "required": ["name", "groups", "fabric_uuid"], "type": "object", "properties": {"fabric_uuid": {"description": "Fabric uuid", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "description": {"type": "string", "example": "Affinity Foo"}, "precedence": {"description": "Precedence for affinity. The lower the number the higher the precedence", "default": 0, "maximum": 4294967295, "minimum": 0, "type": "integer", "example": 100}, "tags": {"$ref": "#/definitions/tags_on_object"}, "admin_state": {"enum": ["disabled", "enabled"], "type": "string", "description": "Enable or disable affinity. Disabled affinities will not be included in full fits, and will be removed from partial fits", "example": "disabled"}, "groups": {"items": {"type": "object", "$ref": "#/definitions/affinity_group"}, "type": "array"}, "actors": {"items": {"type": "object", "$ref": "#/definitions/uuid_with_type"}, "type": "array", "description": "List of actors. "}, "name": {"type": "string", "example": "Affinity Foo", "format": "non_empty_or_whitespace_string"}}, "title": "Object: Affinity (Create)"}, "affinity_domain": {"additionalProperties": false, "required": ["sources", "destinations", "traffic_matrix_uuid"], "type": "object", "properties": {"sources": {"items": {"type": "object", "$ref": "#/definitions/affinity_fabric_endpoint"}, "type": "array", "description": "Source endpoints"}, "traffic_matrix_uuid": {"readOnly": true, "description": "UUID of traffic matrix to associate with this domain", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "destinations": {"items": {"type": "object", "$ref": "#/definitions/affinity_fabric_endpoint"}, "type": "array", "description": "Destination endpoints"}, "name": {"type": "string", "example": "Affinity Domain Foo"}, "description": {"type": "string", "example": "Affinity Domain Foo"}}, "title": "Object: Affinity Domain"}, "affinity_endpoint": {"type": "object", "properties": {"vlans": {"format": "vlan-range", "type": "string", "description": "The VLANs assigned to this Endpoint, presented as a sorted set of ranges.", "example": "5, 10-20, 30, 40, 50-60"}, "name": {"type": "string", "example": "Affinity Endpoint A"}, "description": {"type": "string", "example": "Affinity Endpoint A"}}, "title": "Object: Affinity Endpoint"}, "affinity_fabric_endpoint": {"oneOf": [{"$ref": "#/definitions/affinity_mlag_fabric_endpoint"}, {"$ref": "#/definitions/affinity_switch_fabric_endpoint"}], "description": "An Endpoint is an entity connected to a Fabric. \nValid values are switch_id or lag_id keys with\nuuids as values ", "title": "Object: Affinity Fabric Endpoint"}, "affinity_group": {"additionalProperties": false, "required": ["name", "description", "position", "endpoints"], "type": "object", "properties": {"position": {"enum": ["dest"], "type": "string", "description": "Group's position in the affinity model. ", "example": "dest"}, "endpoints": {"items": {"type": "object", "$ref": "#/definitions/affinity_endpoint"}, "type": "array"}, "name": {"type": "string", "example": "Affinity Group A", "format": "non_empty_or_whitespace_string"}, "description": {"type": "string", "example": "Affinity Group A"}}, "title": "Object: Affinity Group"}, "affinity_mlag_fabric_endpoint": {"description": "An MLAG attached to one or more switches.", "title": "Object: Affinity MLAG fabric endpoint", "required": ["mlag_id"], "additionalProperties": false, "type": "object", "properties": {"mlag_id": {"type": "string", "description": "The identifier used to identify this MLAG.", "example": "302"}}}, "affinity_peer_destination": {"additionalProperties": false, "required": ["to_endpoint"], "type": "object", "properties": {"load": {"minimum": 0, "type": "integer", "description": "The load to expect between the source (from_endpoint) to the destination (to_endpoint). Units are Mbps.", "maximum": 1000000, "example": 10}, "to_endpoint": {"type": "object", "description": "Destinations", "$ref": "#/definitions/affinity_fabric_endpoint"}}, "title": "Object: Affinity Peer Destination"}, "affinity_switch_fabric_endpoint": {"description": "A switch attached to one or more switches.", "title": "Object: Affinity switch fabric endpoint", "required": ["switch_id"], "additionalProperties": false, "type": "object", "properties": {"switch_id": {"readOnly": true, "description": "UUID of switch", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}}}, "affinity_update": {"additionalProperties": false, "required": ["name", "groups", "fabric_uuid"], "type": "object", "properties": {"fabric_uuid": {"description": "Fabric uuid", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "name": {"type": "string", "example": "Affinity Foo", "format": "non_empty_or_whitespace_string"}, "precedence": {"description": "Precedence for affinity. The lower the number the higher the precedence", "default": 0, "maximum": 4294967295, "minimum": 0, "type": "integer", "example": 100}, "tags": {"$ref": "#/definitions/tags_on_object"}, "description": {"type": "string", "example": "Affinity Foo"}, "admin_state": {"enum": ["disabled", "enabled"], "type": "string", "description": "Enable or disable affinity. Disabled affinities will not be included in full fits, and will be removed from partial fits", "example": "disabled"}, "groups": {"items": {"type": "object", "$ref": "#/definitions/affinity_group"}, "type": "array"}, "actors": {"items": {"type": "object", "$ref": "#/definitions/uuid_with_type"}, "type": "array", "description": "List of actors. "}, "uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}}, "title": "Object: Affinity (Update)"}, "audit": {"additionalProperties": false, "required": ["uuid", "stream_id", "record_type", "severity", "description", "data", "log_date"], "type": "object", "properties": {"description": {"type": "string", "description": "Details about the audit object"}, "record_type": {"enum": ["ALARM", "EVENT"], "type": "string", "description": "Type of audit", "example": "EVENT"}, "severity": {"enum": ["EMERGENCY", "CRITICAL", "ERROR", "WARNING", "ALERT", "INFORMATIONAL", "NOTICE", "DEBUG", "UNSPECIFIED"], "type": "string", "example": "INFORMATIONAL"}, "stream_id": {"enum": ["fabric_events", "general_events", "switch_alarm_events", "sensor_events"], "type": "string", "description": "Event stream this audit object belongs to", "example": "fabric_events"}, "log_date": {"description": "Epoch time in milliseconds when audit object was created.", "type": "integer", "example": "1514764800004", "format": "int64"}, "data": {"additionalProperties": false, "required": ["event_object", "event_type", "object_type", "object_name"], "type": "object", "description": "Additional audit data.", "properties": {"object_name": {"type": "string", "description": "Name of object", "example": "Fabric1"}, "event_object": {"additionalProperties": true, "type": "object", "description": "Current state of the object affected by this event.", "properties": {"uuid": {"min_length": 32, "description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "max_length": 36, "maxLength": 36, "type": "string", "example": "e91a3086a23f4821bc37cf3d479e4a41"}}}, "object_type": {"enum": ["Alarm", "LinkAggregationGroup", "Fabric", "Port", "Switch", "NeighborDiscovery", "AuditNotification", "ReconcileNotification", "CfmAlarm", "UpgradeNotification", "PortSecurity", "IntegrationPackStatus", "AccessControlLists", "Transceivers", "IPEvent", "Syslog", "PasswordPolicy", "BackupEvent"], "type": "string", "example": "Alarm", "description": "Type of object"}, "event_type": {"enum": ["ObjectCreated", "ObjectDeleted", "ObjectModified", "ObjectNotify", "ObjectReplaced", "AlarmReceived"], "type": "string", "example": "ObjectCreated", "description": "Type of event"}}}, "uuid": {"min_length": 32, "description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "max_length": 36, "maxLength": 36, "type": "string", "example": "0373410000030000399e081dc0ca985b"}}, "title": "Object: Audit"}, "auth_source": {"additionalProperties": false, "required": ["config", "name", "type", "uuid"], "type": "object", "properties": {"type": {"enum": ["local", "ldap", "pki"], "type": "string"}, "uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "config": {"type": "object", "description": "Authentication source configuration object will vary by the value of `type`. See model definitions for the following: \n* Object: Composable Fabric Manager Authentication Source (LDAP)"}, "description": {"type": "string", "example": ""}, "name": {"format": "non_empty_or_whitespace_string", "type": "string", "description": "Authentication source name (displayed in UI)", "example": ""}}, "title": "Object: Authentication Source"}, "auth_source_ldap": {"additionalProperties": false, "required": ["config", "name", "uuid"], "type": "object", "properties": {"type": {"readOnly": true, "enum": ["ldap"], "type": "string"}, "config": {"additional_properties": false, "required": ["ssl", "tls_reqcert", "uri"], "type": "object", "description": "This defines an LDAP client configuration for:\n* Management software LDAP - defines management software LDAP Users on CFM and its relationship to a single local or remote LDAP Server.\n* Switches LDAP - defines relationship between fabrics and/or switches, and remote LDAP server(s).\nBoth management software and switches may share the same configuration.", "properties": {"ns_switch": {"type": "boolean", "example": true, "description": "If True enables ns_switch to use LDAP as a backend for password, group and shadow databases.\nOnly applicable to switches."}, "verify_ssl": {"default": false, "type": "boolean", "description": "When true along with `ssl == on or start_tls `, validates the LDAP Server certificate signing chain against the list of trusted CA certificates in /etc/pki/ca-trust/extracted/pem/tls-ca-bundle.pem. See details in https://www.unix.com/man-page/centos/8/update-ca-trust/ for more information regarding trusted CA certificate management.\nOnly applicable to management software."}, "pam_enable": {"type": "boolean", "example": true, "description": "If True enables the LDAP PAM module.\nOnly applicable to switches."}, "tls_reqcert": {"default": "never", "enum": ["allow", "demand", "hard", "never", "try"], "type": "string", "example": "never", "description": "Mode for SSL / TLS.\nOnly applicable to switches.\nIf any accepted value except `never` and ssl is `on` or `start_tls` will verify tls files specified in tls_cacertfile, tls_cert and tls_key file paths."}, "dn_template": {"default": "{{username}}", "type": "string", "description": "LDAP user Distinguished Name template.\nOnly applicable to management software.\n* The substring {{username}} will be replaced with the username when an LDAP user attempts to authenticate and retrieve an authorization token.\n\nExample values based on server type:\n* Active directory: `{{username}}`\n* OpenLDAP: `uid={{username}}, ou=Admins, dc=example` dc=com`", "example": "{{username}}"}, "tls_cacertfile": {"type": "string", "example": "/etc/certs/x509.cert", "description": "X.509 certificate file path.\nOnly applicable to switches."}, "bind_dn": {"type": "string", "description": "LDAP default bind dn that is used in a create or update.\nOnly applicable to switches.", "example": "CN=user1,CN=Users,DC=example,DC=com"}, "uri": {"minItems": 1, "items": {"type": "string", "description": "Full URI spec for Host name or IP of LDAP server. Adding a port suffix e.g. ':636' is optional.\n For switch or management software configurations.\nFor management software, with a local ldap server, use ['//localhost']", "example": "[ '//my-ldap-server.server.com' ]"}, "type": "array"}, "management_software": {"type": "boolean", "example": false, "description": "If True enables management software LDAP"}, "ssl": {"default": "off", "enum": ["off", "on", "start_tls"], "type": "string", "example": "off", "description": "Startup mode for SSL / TLS.\nApplicable to both management software and switches.\n* For management software, if `on` or `start_tls`\nthis will enable SSL secure mode.\n* For switches, if `on` or `start_tls` this will enable SSL or TLS, respectively."}, "fabric_uuids": {"items": {"readOnly": true, "description": "Fabric UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array", "description": "UUIDs of fabrics this LDAP client configuration is applied to.\nOnly applicable to switches.\nWhen using `fabric_uuids` the configuration will be applied to all switches in the fabric. If the fabric is expanded the new switch will automatically pick up the new settings covered by `fabric_uuids`. \nTo exclude, specify value as the empty array: __`[]`__"}, "switch_uuids": {"items": {"readOnly": true, "description": "Switch UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array", "description": "UUIDs of switches this LDAP Client Configuration is applied to. \nOnly applicable to switches.\nTo exclude, specify value as the empty array: __`[]`__."}, "base_dn": {"type": "string", "description": "Specifies the base distinguished name (DN) to use as an LDAP search base.\nOnly applicable to switches.", "example": "ou=admins, dc=example"}, "bind_pw": {"type": "string", "description": "LDAP default bind password.\nOnly applicable to switches.", "example": "tooManySecrets"}, "tls_key": {"type": "string", "example": "/etc/certs/tls_private_key.dat", "description": "TLS private key file path.\nOnly applicable to switches."}, "tls_cert": {"type": "string", "example": "/etc/certs/tls_cert_file.dat", "description": "TLS certification file path.\nOnly applicable to switches."}}}, "uuid": {"min_length": 32, "description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "max_length": 36, "maxLength": 36, "type": "string", "example": "f9193086a23f4821bb27cfad449e4a42"}, "name": {"format": "non_empty_or_whitespace_string", "type": "string", "description": "LDAP source name (displayed in UI)", "example": "Enterprise Directory Service for Management Software"}, "description": {"type": "string", "example": "LDAP Configuration for management software"}}, "title": "Object: Authentication Source (LDAP)"}, "auth_source_ldap_create": {"additionalProperties": false, "required": ["config", "name"], "type": "object", "properties": {"type": {"readOnly": true, "enum": ["ldap"], "type": "string"}, "config": {"additional_properties": false, "required": ["ssl", "tls_reqcert", "uri"], "type": "object", "description": "This defines an LDAP client configuration for:\n* Management software LDAP - defines management software LDAP Users on CFM and its relationship to a single local or remote LDAP Server.\n* Switches LDAP - defines relationship between fabrics and/or switches, and remote LDAP server(s).\nBoth management software and switches may share the same configuration.", "properties": {"ns_switch": {"type": "boolean", "example": true, "description": "If True enables ns_switch to use LDAP as a backend for password, group and shadow databases.\nOnly applicable to switches."}, "verify_ssl": {"default": false, "type": "boolean", "description": "When true along with `ssl == on or start_tls `, validates the LDAP Server certificate signing chain against the list of trusted CA certificates in /etc/pki/ca-trust/extracted/pem/tls-ca-bundle.pem. See details in https://www.unix.com/man-page/centos/8/update-ca-trust/ for more information regarding trusted CA certificate management.\nOnly applicable to management software."}, "tls_key": {"type": "string", "example": "/etc/certs/tls_private_key.dat", "description": "TLS private key file path.\nOnly applicable to switches."}, "tls_reqcert": {"default": "never", "enum": ["allow", "demand", "hard", "never", "try"], "type": "string", "example": "never", "description": "Mode for SSL / TLS.\nOnly applicable to switches.\nIf any accepted value except `never` and ssl is `on` or `start_tls` will verify tls files specified in tls_cacertfile, tls_cert and tls_key file paths."}, "dn_template": {"default": "{{username}}", "type": "string", "description": "LDAP user Distinguished Name template.\nOnly applicable to management software.\n* The substring {{username}} will be replaced with the username when an LDAP user attempts to authenticate and retrieve an authorization token.\n\nExample values based on server type:\n* Active directory: `{{username}}`\n* OpenLDAP: `uid={{username}}, ou=Admins, dc=example` dc=com`", "example": "{{username}}"}, "tls_cacertfile": {"type": "string", "example": "/etc/certs/x509.cert", "description": "X.509 certificate file path.\nOnly applicable to switches."}, "uri": {"minItems": 1, "items": {"type": "string", "description": "Full URI spec for Host name or IP of LDAP server. Adding a port suffix e.g. ':636' is optional.\n For switch or management software configurations.\nFor management software, with a local ldap server, use ['//localhost']", "example": "[ '//my-ldap-server.server.com' ]"}, "type": "array"}, "bind_dn": {"type": "string", "description": "LDAP default bind dn that is used in a create or update.\nOnly applicable to switches.", "example": "CN=user1,CN=Users,DC=example,DC=com"}, "management_software": {"type": "boolean", "example": false, "description": "If True enables management software LDAP"}, "ssl": {"default": "off", "enum": ["off", "on", "start_tls"], "type": "string", "example": "off", "description": "Startup mode for SSL / TLS.\nApplicable to both management software and switches.\n* For management software, if `on` or `start_tls`\nthis will enable SSL secure mode.\n* For switches, if `on` or `start_tls` this will enable SSL or TLS, respectively."}, "pam_enable": {"type": "boolean", "example": true, "description": "If True enables the LDAP PAM module.\nOnly applicable to switches."}, "switch_uuids": {"items": {"description": "Switch UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array", "description": "UUIDs of switches this LDAP Client Configuration is applied to. \nOnly applicable to switches.\nTo exclude, specify value as the empty array: __`[]`__."}, "fabric_uuids": {"items": {"description": "Fabric UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array", "description": "UUIDs of fabrics this LDAP client configuration is applied to.\nOnly applicable to switches.\nWhen using `fabric_uuids` the configuration will be applied to all switches in the fabric. If the fabric is expanded the new switch will automatically pick up the new settings covered by `fabric_uuids`. \nTo exclude, specify value as the empty array: __`[]`__"}, "base_dn": {"type": "string", "description": "Specifies the base distinguished name (DN) to use as an LDAP search base.\nOnly applicable to switches.", "example": "ou=admins, dc=example"}, "bind_pw": {"type": "string", "description": "LDAP default bind password.\nOnly applicable to switches.", "example": "tooManySecrets"}, "tls_cert": {"type": "string", "example": "/etc/certs/tls_cert_file.dat", "description": "TLS certification file path.\nOnly applicable to switches."}}}, "description": {"type": "string", "example": "LDAP Configuration for management software"}, "name": {"format": "non_empty_or_whitespace_string", "type": "string", "example": "Enterprise Directory Service for Management Software", "description": "LDAP source name (displayed in UI)"}}, "title": "Object: Authentication Source (LDAP) (create)"}, "auth_source_ldap_create_verify_only": {"additionalProperties": false, "required": [], "type": "object", "properties": {"config": {"type": "object", "required": ["ssl", "tls_reqcert", "uri"], "additional_properties": false, "description": "This defines an LDAP client configuration for:\n* Management software LDAP - defines management software LDAP Users on CFM and its relationship to a single local or remote LDAP Server.\n* Switches LDAP - defines relationship between fabrics and/or switches, and remote LDAP server(s).\nBoth management software and switches may share the same configuration.", "properties": {"ns_switch": {"type": "boolean", "example": true, "description": "If True enables ns_switch to use LDAP as a backend for password, group and shadow databases.\nOnly applicable to switches."}, "tls_key": {"type": "string", "example": "/etc/certs/tls_private_key.dat", "description": "TLS private key file path.\nOnly applicable to switches."}, "tls_reqcert": {"default": "never", "enum": ["allow", "demand", "hard", "never", "try"], "type": "string", "example": "never", "description": "Mode for SSL / TLS.\nOnly applicable to switches.\nIf any accepted value except `never` and ssl is `on` or `start_tls` will verify tls files specified in tls_cacertfile, tls_cert and tls_key file paths."}, "dn_template": {"default": "{{username}}", "type": "string", "description": "LDAP user Distinguished Name template.\nOnly applicable to management software.\n* The substring {{username}} will be replaced with the username when an LDAP user attempts to authenticate and retrieve an authorization token.\n\nExample values based on server type:\n* Active directory: `{{username}}`\n* OpenLDAP: `uid={{username}}, ou=Admins, dc=example` dc=com`", "example": "{{username}}"}, "uri": {"minItems": 1, "items": {"type": "string", "description": "Full URI spec for Host name or IP of LDAP server. Adding a port suffix e.g. ':636' is optional.\n For switch or management software configurations.\nFor management software, with a local ldap server, use ['//localhost']", "example": "[ '//my-ldap-server.server.com' ]"}, "type": "array"}, "tls_cacertfile": {"type": "string", "example": "/etc/certs/x509.cert", "description": "X.509 certificate file path.\nOnly applicable to switches."}, "pam_enable": {"type": "boolean", "example": true, "description": "If True enables the LDAP PAM module.\nOnly applicable to switches."}, "bind_dn": {"type": "string", "description": "LDAP default bind dn that is used in a create or update.\nOnly applicable to switches.", "example": "CN=user1,CN=Users,DC=example,DC=com"}, "management_software": {"type": "boolean", "example": false, "description": "If True enables management software LDAP"}, "ssl": {"default": "off", "enum": ["off", "on", "start_tls"], "type": "string", "example": "off", "description": "Startup mode for SSL / TLS.\nApplicable to both management software and switches.\n* For management software, if `on` or `start_tls`\nthis will enable SSL secure mode.\n* For switches, if `on` or `start_tls` this will enable SSL or TLS, respectively."}, "verify_ssl": {"default": false, "type": "boolean", "description": "When true along with `ssl == on or start_tls `, validates the LDAP Server certificate signing chain against the list of trusted CA certificates in /etc/pki/ca-trust/extracted/pem/tls-ca-bundle.pem. See details in https://www.unix.com/man-page/centos/8/update-ca-trust/ for more information regarding trusted CA certificate management.\nOnly applicable to management software."}, "switch_uuids": {"items": {"description": "Switch UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array", "description": "UUIDs of switches this LDAP Client Configuration is applied to. \nOnly applicable to switches.\nTo exclude, specify value as the empty array: __`[]`__."}, "fabric_uuids": {"items": {"description": "Fabric UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array", "description": "UUIDs of fabrics this LDAP client configuration is applied to.\nOnly applicable to switches.\nWhen using `fabric_uuids` the configuration will be applied to all switches in the fabric. If the fabric is expanded the new switch will automatically pick up the new settings covered by `fabric_uuids`. \nTo exclude, specify value as the empty array: __`[]`__"}, "base_dn": {"type": "string", "description": "Specifies the base distinguished name (DN) to use as an LDAP search base.\nOnly applicable to switches.", "example": "ou=admins, dc=example"}, "bind_pw": {"type": "string", "description": "LDAP default bind password.\nOnly applicable to switches.", "example": "tooManySecrets"}, "tls_cert": {"type": "string", "example": "/etc/certs/tls_cert_file.dat", "description": "TLS certification file path.\nOnly applicable to switches."}}}, "description": {"type": "string", "example": "LDAP Configuration for management software"}, "type": {"readOnly": true, "enum": ["ldap"], "type": "string"}, "uuid": {"min_length": 32, "description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "max_length": 36, "maxLength": 36, "type": "string", "example": "f9193086a23f4821bb27cfad449e4a42"}, "name": {"example": "Enterprise Directory Service for Management Software", "type": "string", "description": "LDAP source name (displayed in UI)", "format": "non_empty_or_whitespace_string"}}, "title": "Object: Authentication Source (LDAP) (create verify only)"}, "auth_source_ldap_update": {"additionalProperties": false, "required": ["config", "name"], "type": "object", "properties": {"config": {"type": "object", "required": ["ssl", "tls_reqcert", "uri"], "additional_properties": false, "description": "This defines an LDAP client configuration for:\n* Management software LDAP - defines management software LDAP Users on CFM and its relationship to a single local or remote LDAP Server.\n* Switches LDAP - defines relationship between fabrics and/or switches, and remote LDAP server(s).\nBoth management software and switches may share the same configuration.", "properties": {"ns_switch": {"type": "boolean", "example": true, "description": "If True enables ns_switch to use LDAP as a backend for password, group and shadow databases.\nOnly applicable to switches."}, "tls_key": {"type": "string", "example": "/etc/certs/tls_private_key.dat", "description": "TLS private key file path.\nOnly applicable to switches."}, "tls_reqcert": {"default": "never", "enum": ["allow", "demand", "hard", "never", "try"], "type": "string", "example": "never", "description": "Mode for SSL / TLS.\nOnly applicable to switches.\nIf any accepted value except `never` and ssl is `on` or `start_tls` will verify tls files specified in tls_cacertfile, tls_cert and tls_key file paths."}, "dn_template": {"default": "{{username}}", "type": "string", "description": "LDAP user Distinguished Name template.\nOnly applicable to management software.\n* The substring {{username}} will be replaced with the username when an LDAP user attempts to authenticate and retrieve an authorization token.\n\nExample values based on server type:\n* Active directory: `{{username}}`\n* OpenLDAP: `uid={{username}}, ou=Admins, dc=example` dc=com`", "example": "{{username}}"}, "uri": {"minItems": 1, "items": {"type": "string", "description": "Full URI spec for Host name or IP of LDAP server. Adding a port suffix e.g. ':636' is optional.\n For switch or management software configurations.\nFor management software, with a local ldap server, use ['//localhost']", "example": "[ '//my-ldap-server.server.com' ]"}, "type": "array"}, "tls_cacertfile": {"type": "string", "example": "/etc/certs/x509.cert", "description": "X.509 certificate file path.\nOnly applicable to switches."}, "pam_enable": {"type": "boolean", "example": true, "description": "If True enables the LDAP PAM module.\nOnly applicable to switches."}, "bind_dn": {"type": "string", "description": "LDAP default bind dn that is used in a create or update.\nOnly applicable to switches.", "example": "CN=user1,CN=Users,DC=example,DC=com"}, "management_software": {"type": "boolean", "example": false, "description": "If True enables management software LDAP"}, "ssl": {"default": "off", "enum": ["off", "on", "start_tls"], "type": "string", "example": "off", "description": "Startup mode for SSL / TLS.\nApplicable to both management software and switches.\n* For management software, if `on` or `start_tls`\nthis will enable SSL secure mode.\n* For switches, if `on` or `start_tls` this will enable SSL or TLS, respectively."}, "verify_ssl": {"default": false, "type": "boolean", "description": "When true along with `ssl == on or start_tls `, validates the LDAP Server certificate signing chain against the list of trusted CA certificates in /etc/pki/ca-trust/extracted/pem/tls-ca-bundle.pem. See details in https://www.unix.com/man-page/centos/8/update-ca-trust/ for more information regarding trusted CA certificate management.\nOnly applicable to management software."}, "switch_uuids": {"items": {"description": "Switch UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array", "description": "UUIDs of switches this LDAP Client Configuration is applied to. \nOnly applicable to switches.\nTo exclude, specify value as the empty array: __`[]`__."}, "fabric_uuids": {"items": {"description": "Fabric UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array", "description": "UUIDs of fabrics this LDAP client configuration is applied to.\nOnly applicable to switches.\nWhen using `fabric_uuids` the configuration will be applied to all switches in the fabric. If the fabric is expanded the new switch will automatically pick up the new settings covered by `fabric_uuids`. \nTo exclude, specify value as the empty array: __`[]`__"}, "base_dn": {"type": "string", "description": "Specifies the base distinguished name (DN) to use as an LDAP search base.\nOnly applicable to switches.", "example": "ou=admins, dc=example"}, "bind_pw": {"type": "string", "description": "LDAP default bind password.\nOnly applicable to switches.", "example": "tooManySecrets"}, "tls_cert": {"type": "string", "example": "/etc/certs/tls_cert_file.dat", "description": "TLS certification file path.\nOnly applicable to switches."}}}, "description": {"type": "string", "example": "LDAP Configuration for management software"}, "type": {"readOnly": true, "enum": ["ldap"], "type": "string"}, "uuid": {"min_length": 32, "description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "max_length": 36, "maxLength": 36, "type": "string", "example": "f9193086a23f4821bb27cfad449e4a42"}, "name": {"example": "Enterprise Directory Service for Management Software", "type": "string", "description": "LDAP source name (displayed in UI)", "format": "non_empty_or_whitespace_string"}}, "title": "Object: Authentication Source (LDAP) (update)"}, "auth_source_pki": {"additionalProperties": false, "required": ["config", "name", "type", "uuid"], "type": "object", "properties": {"type": {"readOnly": true, "enum": ["pki"], "type": "string"}, "config": {"additionalProperties": false, "required": ["trusted_certs"], "type": "object", "properties": {"trusted_certs": {"type": "string", "description": "PEM-encoded string with all certificates (newline delimited) capable of client certificate verification"}}}, "uuid": {"min_length": 32, "description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "max_length": 36, "maxLength": 36, "type": "string", "example": "e91a3086a23f4821bc37cf3d479e4a41"}, "name": {"format": "non_empty_or_whitespace_string", "type": "string", "description": "PKI source name (displayed in UI)", "example": "Enterprise Certificate Authority"}, "description": {"type": "string", "example": ""}}, "title": "Object: Authentication Source (PKI)"}, "auth_source_pki_create": {"additionalProperties": false, "required": ["config", "name"], "type": "object", "properties": {"config": {"additionalProperties": false, "required": ["trusted_certs"], "type": "object", "properties": {"trusted_certs": {"type": "string", "description": "PEM-encoded string with all certificates (newline delimited) capable of client certificate verification"}}}, "description": {"type": "string", "example": ""}, "name": {"format": "non_empty_or_whitespace_string", "type": "string", "example": "Enterprise Certificate Authority", "description": "PKI source name (displayed in UI)"}}, "title": "Object: Authentication Source (PKI) (create)"}, "auth_source_pki_create_verify_only": {"additionalProperties": false, "required": ["config"], "type": "object", "properties": {"config": {"additionalProperties": false, "required": ["trusted_certs"], "type": "object", "properties": {"trusted_certs": {"type": "string", "description": "PEM-encoded string with all certificates (newline delimited) capable of client certificate verification"}}}, "description": {"type": "string", "example": ""}, "type": {"readOnly": true, "enum": ["pki"], "type": "string"}, "uuid": {"min_length": 32, "description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "max_length": 36, "maxLength": 36, "type": "string", "example": "e91a3086a23f4821bc37cf3d479e4a41"}, "name": {"example": "Enterprise Certificate Authority", "type": "string", "description": "PKI source name (displayed in UI)", "format": "non_empty_or_whitespace_string"}}, "title": "Object: Authentication Source (PKI) (create verify only)"}, "auth_source_pki_update": {"additionalProperties": false, "required": ["config", "name"], "type": "object", "properties": {"config": {"additionalProperties": false, "required": ["trusted_certs"], "type": "object", "properties": {"trusted_certs": {"type": "string", "description": "PEM-encoded string with all certificates (newline delimited) capable of client certificate verification"}}}, "description": {"type": "string", "example": ""}, "type": {"readOnly": true, "enum": ["pki"], "type": "string"}, "uuid": {"min_length": 32, "description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "max_length": 36, "maxLength": 36, "type": "string", "example": "e91a3086a23f4821bc37cf3d479e4a41"}, "name": {"example": "Enterprise Certificate Authority", "type": "string", "description": "PKI source name (displayed in UI)", "format": "non_empty_or_whitespace_string"}}, "title": "Object: Authentication Source (PKI) (update)"}, "backup": {"additionalProperties": false, "required": ["checksum", "date_created", "name", "uuid"], "type": "object", "properties": {"status": {"readOnly": true, "enum": ["available", "in progress"], "type": "string", "description": "indicates current state of backup.", "example": "available"}, "image_version": {"readOnly": true, "type": "string", "description": "Software version", "example": "5.1.0-4385"}, "name": {"readOnly": true, "type": "string", "description": "Backup file name", "example": "composable-fabric-manager-backup-2017-09-21-221648000021.tar.gz"}, "date_created": {"description": "Backup file creation epoch time", "minLength": 9, "readOnly": true, "maxLength": 11, "type": "integer", "example": "1497602656"}, "url": {"readOnly": true, "type": "string", "description": "Download URL", "example": "/api/v1/files/backups/1c35f4450e2c4d0ab8fddae75924567e?Authorization=0c44bd1ae93b72bd0059ca95101185a313f52722a477839babff9a672931a52351e1cde5d9bc2a1cc0c71551efbaa6e5"}, "checksum": {"readOnly": true, "description": "SHA256 checksum", "maxLength": 64, "minLength": 64, "type": "string", "example": "e27a77a283f2097657b74f6c24c4a21f0e9cf45e4e7139af81a573096c0b2570"}, "supported": {"readOnly": true, "type": "boolean", "description": "True if this backup is supported on this image", "example": true}, "retention_hours": {"default": 0, "minimum": 0, "type": "integer", "description": "Number of hours to retain this backup from date_created.After which this backup is automatically deleted.If value = 0 backup is retained forever.", "example": 0}, "uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}}, "title": "Object: Backup"}, "backup_create": {"additionalProperties": false, "required": ["retention_hours"], "type": "object", "properties": {"status": {"readOnly": true, "enum": ["available", "in progress"], "type": "string", "description": "indicates current state of backup.", "example": "available"}, "image_version": {"readOnly": true, "type": "string", "description": "Software version", "example": "5.1.0-4385"}, "name": {"readOnly": true, "type": "string", "description": "Backup file name", "example": "composable-fabric-manager-backup-2017-09-21-221648000021.tar.gz"}, "url": {"readOnly": true, "type": "string", "description": "Download URL", "example": "/api/v1/files/backups/1c35f4450e2c4d0ab8fddae75924567e?Authorization=0c44bd1ae93b72bd0059ca95101185a313f52722a477839babff9a672931a52351e1cde5d9bc2a1cc0c71551efbaa6e5"}, "checksum": {"description": "SHA256 checksum", "minLength": 64, "readOnly": true, "maxLength": 64, "type": "string", "example": "e27a77a283f2097657b74f6c24c4a21f0e9cf45e4e7139af81a573096c0b2570"}, "supported": {"readOnly": true, "type": "boolean", "description": "True if this backup is supported on this image", "example": true}, "retention_hours": {"default": 0, "minimum": 0, "type": "integer", "description": "Number of hours to retain this backup from date_created.After which this backup is automatically deleted.If value = 0 backup is retained forever.", "example": 0}, "date_created": {"description": "Backup file creation epoch time", "minLength": 9, "readOnly": true, "maxLength": 11, "type": "integer", "example": "1497602656"}}, "title": "Object: Backup (Create)"}, "backup_rule": {"additionalProperties": false, "required": ["minute", "hour", "day_of_month", "month", "day_of_week", "retention"], "type": "object", "properties": {"uuid": {"readOnly": false, "description": "UUID of an existing schedule rule; omit field for new rules.", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "day_of_week": {"type": "string", "description": "day or days range: 'sun' or '0' - Sunday. 'mon-fri' or '1-5' - Monday through Friday. '*' - repeat every day.", "example": "*"}, "name": {"minLength": 1, "example": "Nightly backup Mon-Fri at midnight.", "type": "string", "description": "Unique name for backup rule.", "maxLength": 256}, "hour": {"type": "string", "description": "hour or hour range: '1' - one am '3-6' - 3, 4, 5 6 am '*' - repeat every hour", "example": "12"}, "year": {"type": "string", "description": "Year in which to run backup - for one time execution.", "example": "2020"}, "retention_unit": {"enum": ["month", "week", "day", "hour"], "type": "string", "description": "Label set by caller to track display units for retention values. Has no bearing on retention values.", "example": "month"}, "retention": {"type": "integer", "description": "Value in hours for when to delete old backups.", "example": 6}, "day_of_month": {"type": "string", "description": "day of month at - range 1-31 '1' - one am '3-6' - 3, 4, 5 6 am '*' - repeat every day of month", "example": "*"}, "minute": {"type": "string", "description": "minute value or minute range: '20' - 20 minutes after the hour'40, 60' - 3, 4, 5 6 am '*' - repeat every minute", "example": "00"}, "month": {"type": "string", "description": "month or month range: '3' - march '7-9' - July, August, Sept '*' - repeat every month", "example": "*"}}, "title": "Object: Backup Schedule Rule"}, "backup_schedule": {"additionalProperties": false, "required": ["rules", "name", "description", "uuid"], "type": "object", "properties": {"rules": {"default": "", "min_length": 1, "type": "array", "description": "Set of Backup Schedule Rules", "items": {"$ref": "#/definitions/backup_rule"}}, "uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "description": {"type": "string", "example": "Nightly Schedule - includes Pod 1 backup details."}, "name": {"type": "string", "description": "Backup Schedule Name", "example": "Composable Fabric Manager for Pod 1 Backup Schedule"}}, "title": "Object: Backup Schedule"}, "backup_schedule_create": {"additionalProperties": false, "required": ["rules"], "type": "object", "properties": {"rules": {"default": "", "min_length": 1, "type": "array", "description": "Set of Backup Schedule Rules", "items": {"$ref": "#/definitions/backup_rule"}}, "description": {"type": "string", "example": "Nightly Schedule - includes Pod 1 backup details."}, "uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "name": {"type": "string", "description": "Backup Schedule Name", "example": "Composable Fabric Manager for Pod 1 Backup Schedule"}}, "title": "Object: Backup Schedule (Create)"}, "backup_schedule_update": {"additionalProperties": false, "required": ["rules"], "type": "object", "properties": {"rules": {"default": "", "min_length": 1, "type": "array", "description": "Set of Backup Schedule Rules", "items": {"$ref": "#/definitions/backup_rule"}}, "uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "name": {"type": "string", "description": "Backup Schedule Name", "example": "Composable Fabric Manager for Pod 1 Backup Schedule"}, "description": {"type": "string", "example": "Nightly Schedule - includes Pod 1 backup details."}}, "title": "Object: Backup Schedule (Update)"}, "backup_update": {"additionalProperties": false, "required": ["retention_hours"], "type": "object", "properties": {"status": {"readOnly": true, "enum": ["available", "in progress"], "type": "string", "description": "indicates current state of backup.", "example": "available"}, "image_version": {"readOnly": true, "type": "string", "description": "Software version", "example": "5.1.0-4385"}, "name": {"readOnly": true, "type": "string", "description": "Backup file name", "example": "composable-fabric-manager-backup-2017-09-21-221648000021.tar.gz"}, "url": {"readOnly": true, "type": "string", "description": "Download URL", "example": "/api/v1/files/backups/1c35f4450e2c4d0ab8fddae75924567e?Authorization=0c44bd1ae93b72bd0059ca95101185a313f52722a477839babff9a672931a52351e1cde5d9bc2a1cc0c71551efbaa6e5"}, "checksum": {"description": "SHA256 checksum", "minLength": 64, "readOnly": true, "maxLength": 64, "type": "string", "example": "e27a77a283f2097657b74f6c24c4a21f0e9cf45e4e7139af81a573096c0b2570"}, "supported": {"readOnly": true, "type": "boolean", "description": "True if this backup is supported on this image", "example": true}, "retention_hours": {"default": 0, "minimum": 0, "type": "integer", "description": "Number of hours to retain this backup from date_created.After which this backup is automatically deleted.If value = 0 backup is retained forever.", "example": 0}, "date_created": {"description": "Backup file creation epoch time", "minLength": 9, "readOnly": true, "maxLength": 11, "type": "integer", "example": "1497602656"}, "uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}}, "title": "Object: Backup (Update)"}, "backup_upload": {"type": "file", "title": "Object: Backup (upload)"}, "bgp_global": {"additionalProperties": false, "required": ["as_number", "enable", "holddown_timer", "intra_fabric", "keepalive_timer", "redistribute_ospf", "redistribute_connected", "redistribute_static", "switches"], "type": "object", "properties": {"as_number": {"minimum": 1, "description": "Fabric's BGP AS Number", "type": "integer", "example": 64002, "maximum": 65535}, "holddown_timer": {"example": 90, "minimum": 0, "type": "integer", "description": "Holddown timer, default value 90 seconds.", "maximum": 65535}, "redistribute_static": {"type": "boolean", "description": "True if static routes should be redistributed; false otherwise.", "example": true}, "description": {"type": "string", "example": "Description of BGP global config"}, "redistribute_connected": {"type": "boolean", "description": "True if local routes should be redistributed; false otherwise.", "example": true}, "enable": {"type": "boolean", "description": "Enable BGP for this Virtual Private Cloud."}, "intra_fabric": {"$ref": "#/definitions/bgp_intra_fabric"}, "keepalive_timer": {"example": 30, "minimum": 0, "type": "integer", "description": "Keepalive timer, default value 30 seconds", "maximum": 65535}, "redistribute_ospf": {"type": "boolean", "description": "True if OSPF should be redistributed; false otherwise.", "example": true}, "switches": {"items": {"$ref": "#/definitions/bgp_switch"}, "type": "array", "description": "BGP Switches", "title": "BGP Neighbors"}, "name": {"type": "string", "example": "My BGP global config"}}, "title": "Object: BGP Global Configuration"}, "bgp_intra_fabric": {"additionalProperties": false, "required": ["mode", "keepalive_timer", "holddown_timer", "switches", "address_families", "admin_state_enabled"], "type": "object", "properties": {"switches": {"items": {"readOnly": false, "description": "Switch UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array", "description": "List of switch UUIDs\nIn 'partial_mesh' mode, all other switches will establish an IBGP session with the switches specified here\nIn 'route_reflector' mode, this list should select exactly two switches to act as route reflectors\nIn 'full_mesh' mode, or when intra-fabric BGP is disabled, the contents of this list are ignored"}, "admin_state_enabled": {"default": true, "type": "boolean", "description": "Enable admin state for intrafabric neighbors.", "example": true}, "authentication_password": {"type": "string", "maxLength": 80}, "name": {"type": "string", "example": "My BGP switch"}, "holddown_timer": {"example": 90, "minimum": 0, "type": "integer", "description": "Hold down timer, default value will be used if zero is specified.", "maximum": 65535}, "mode": {"enum": ["disabled", "full_mesh", "route_reflector"], "type": "string", "description": "Intra-fabric BGP mode of operation", "example": "full_mesh"}, "keepalive_timer": {"example": 30, "minimum": 0, "type": "integer", "description": "Keep alive timer, default value will be used if zero is specified.", "maximum": 65535}, "address_families": {"items": {"enum": ["evpn", "ipv4", "ipv6", "vpnv4"], "example": "ipv4"}, "type": "array", "description": "BGP Address Families for intrafabric neighbors."}, "description": {"type": "string", "example": "Description of BGP switch"}}, "title": "Object: BGP Intra-Fabric Routing Configuration"}, "bgp_neighbor": {"additionalProperties": false, "required": ["name", "description", "neighbor_as_number", "neighbor_ip_address", "weight", "route_reflector_client", "soft_reconfiguration_inbound", "address_families", "holddown_timer", "keepalive_timer", "route_filter_list_in", "route_filter_list_out", "admin_state_enable"], "type": "object", "properties": {"neighbor_type": {"readOnly": true, "type": "string", "description": "Indicates if neighbor is internal (ibgp) neighbor or external"}, "keepalive_timer": {"description": "Keepalive timer (secs), default value (30) will be used if zero is specified.", "maximum": 65535, "readOnly": false, "minimum": 0, "type": "integer", "example": 30}, "uuid": {"readOnly": false, "description": "Neighbor UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "weight": {"example": 1, "minimum": 0, "type": "integer", "description": "Neighbor weight", "maximum": 65535}, "external_bgp_multihop": {"description": "Number of hops to ebgp peer. Default value zero (not in use)", "maximum": 255, "readOnly": false, "minimum": 0, "type": "integer", "example": 179}, "soft_reconfiguration_inbound": {"type": "boolean", "description": "True if this neighbor accepts incoming soft reconfiguration, false otherwise.", "example": false}, "description": {"type": "string", "example": "Description of BGP neighbor"}, "holddown_timer": {"description": "Holddown timer (secs), default value (90) will be used if zero is specified.", "maximum": 65535, "readOnly": false, "minimum": 0, "type": "integer", "example": 90}, "neighbor_as_number": {"minimum": 1, "description": "Neighbor BGP AS ID, if this AS ID matches the global AS ID,the switch's fabric IP network ID will be used", "type": "integer", "example": 64000, "maximum": 65535}, "update_source_interface": {"default": "", "oneOf": [{"type": "string", "format": "uuid_opt_hyphenated"}, {"type": "string", "format": "empty_or_whitespace_string"}], "description": "IP interface UUID - loopback only supported at present", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "update_source_address": {"default": "", "oneOf": [{"type": "string", "format": "ipv4"}, {"type": "string", "format": "empty_or_whitespace_string"}], "description": "IPv4 address to be used as source in BGP updates", "example": "10.10.1.0"}, "neighbor_ip_address": {"oneOf": [{"format": "ipv4"}, {"format": "ipv6"}], "type": "string", "example": "192.168.1.1", "description": "BGP Neighbor IP Address"}, "authentication_password": {"type": "string", "maxLength": 80}, "default_originate": {"default": false, "type": "boolean", "description": "Advertise default route", "example": false}, "admin_state_enable": {"default": true, "type": "boolean", "description": "Disable or enable the bgp neighbor", "example": true}, "route_reflector_client": {"type": "boolean", "description": "True if this neighbor is a route-reflector client, false otherwise.", "example": false}, "route_filter_list_out": {"oneOf": [{"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, {"type": "null"}], "description": "UUID of an IP prefix list, to be used as an output filter. If this parameter is not supplied, or the Nil UUID is specified, filtering will be disabled", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "route_filter_list_in": {"oneOf": [{"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, {"type": "null"}], "description": "UUID of an IP prefix list, to be used an input filter. If this parameter is not supplied, or the Nil UUID is specified, filtering will be disabled", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "address_families": {"items": {"enum": ["evpn", "ipv4", "ipv6", "vpnv4"], "example": "ipv4"}, "type": "array", "description": "BGP Address Families"}, "name": {"type": "string", "example": "My BGP neighbor"}}, "title": "Object: BGP Neighbor Configuration"}, "bgp_neighbor_reset": {"additionalProperties": false, "required": ["type", "direction"], "type": "object", "properties": {"direction": {"required": true, "type": "string", "description": "Neighbor reset direction, 'both' only applicable if reset type hard.", "enum": ["in", "out", "both"]}, "type": {"required": true, "type": "string", "description": "Neighbor reset type.", "enum": ["hard", "soft"]}}, "title": "Object: BGP Neighbor Reset Configuration"}, "bgp_neighbor_state": {"additionalProperties": false, "required": [], "type": "object", "properties": {"local_host": {"type": "string", "maxLength": 256}, "bgp_state_time": {"minimum": 0, "type": "integer", "description": "Time in seconds since last BGP state change", "example": 3600}, "neighbor_name": {"type": "string", "maxLength": 256}, "neighbor_router_id": {"oneOf": [{"format": "ipv4"}, {"format": "ipv6"}], "type": "string", "example": "192.168.1.1", "description": "BGP Neighbor Router ID"}, "neighbor_as_number": {"minimum": 1, "description": "Neighbor BGP AS ID", "type": "integer", "example": 64002, "maximum": 65535}, "foreign_port": {"minimum": 0, "type": "integer", "description": "Foreign TCP Port used for neighbor connection", "example": 58798}, "bgp_version": {"example": 4, "minimum": 0, "type": "integer", "description": "BGP Version ID", "maximum": 64}, "next_hop": {"type": "string", "maxLength": 256}, "bgp_state": {"type": "string", "maxLength": 256}, "local_port": {"minimum": 0, "type": "integer", "description": "Local TCP Port used for neighbor connection", "example": 179}, "foreign_host": {"type": "string", "maxLength": 256}, "counters": {"type": "object", "properties": {"rx_route_refresh": {"minimum": 0, "type": "integer", "description": "Received Route Refresh Requests Counter", "example": 5}, "tx_notifications": {"minimum": 0, "type": "integer", "description": "BGP Transmitted Notifications Counter", "example": 11}, "rx_messages": {"minimum": 0, "type": "integer", "description": "BGP Received Messages Counter", "example": 120}, "rx_notifications": {"minimum": 0, "type": "integer", "description": "BGP Received Notifications Counter", "example": 17}, "tx_route_refresh": {"minimum": 0, "type": "integer", "description": "Transmitted Route Refresh Requests Counter", "example": 8}, "tx_messages": {"minimum": 0, "type": "integer", "description": "BGP Transmitted Messages Counter", "example": 150}}}}, "title": "Object: BGP Neighbor State"}, "bgp_state": {"additionalProperties": false, "required": [], "type": "object", "properties": {"switches": {"items": {"type": "object", "properties": {"neighbors": {"items": {"type": "object", "properties": {"local_host": {"type": "string", "description": "Local host name", "example": "my-host"}, "update_source": {"type": "string"}, "last_read_time": {"type": "integer", "example": 0}, "next_hop_global": {"type": "string"}, "neighbor_name": {"type": "string", "description": "BGP neighbor name", "example": "192.168.1.120"}, "min_adv_time": {"type": "integer", "example": 0}, "ipv4_multicast_address_family_info": {"type": "object", "properties": {"outbound_path_policy": {"type": "boolean", "example": true}, "announced_prefixes": {"type": "integer", "example": 0}, "incoming_prefix_filt_list": {"type": "string"}, "offset": {"type": "integer", "example": 0}, "bgp_tbl_ver": {"type": "integer", "example": 0}, "accepted_prefixes": {"type": "integer", "example": 0}, "index": {"type": "integer", "example": 0}, "inbound_path_policy": {"type": "boolean", "example": true}, "mask": {"type": "integer", "example": 0}, "community_attr": {"type": "string"}, "neighbor_ver": {"type": "integer", "example": 0}, "outgoing_prefix_filt_list": {"type": "string"}}}, "local_as": {"type": "integer", "example": 0}, "rx_route_refresh_req": {"type": "integer", "description": "Received route refresh count", "example": 11}, "foreign_port": {"type": "integer", "description": "Foreign port number", "example": 179}, "l2vpn_evpn_address_family_info": {"type": "object", "properties": {"outbound_path_policy": {"type": "boolean", "example": true}, "announced_prefixes": {"type": "integer", "example": 0}, "incoming_prefix_filt_list": {"type": "string"}, "offset": {"type": "integer", "example": 0}, "bgp_tbl_ver": {"type": "integer", "example": 0}, "accepted_prefixes": {"type": "integer", "example": 0}, "index": {"type": "integer", "example": 0}, "inbound_path_policy": {"type": "boolean", "example": true}, "mask": {"type": "integer", "example": 0}, "community_attr": {"type": "string"}, "neighbor_ver": {"type": "integer", "example": 0}, "outgoing_prefix_filt_list": {"type": "string"}}}, "bgp_version": {"type": "integer", "description": "Current BGP version", "example": 4}, "next_hop": {"type": "string", "description": "BGP next hop", "example": "10.10.0.2"}, "vpnv4_unicast_address_family_info": {"type": "object", "properties": {"outbound_path_policy": {"type": "boolean", "example": true}, "announced_prefixes": {"type": "integer", "example": 0}, "incoming_prefix_filt_list": {"type": "string"}, "offset": {"type": "integer", "example": 0}, "bgp_tbl_ver": {"type": "integer", "example": 0}, "accepted_prefixes": {"type": "integer", "example": 0}, "index": {"type": "integer", "example": 0}, "inbound_path_policy": {"type": "boolean", "example": true}, "mask": {"type": "integer", "example": 0}, "community_attr": {"type": "string"}, "neighbor_ver": {"type": "integer", "example": 0}, "outgoing_prefix_filt_list": {"type": "string"}}}, "tx_messages": {"type": "integer", "description": "Transmitted messages count", "example": 83}, "remote_as": {"type": "integer", "description": "Neighbor AS number", "example": 65010}, "remote_router_id": {"type": "string", "description": "Neighbor router ID", "example": "0.0.0.120"}, "hold_time": {"type": "integer", "example": 0}, "ipv6_unicast_address_family_info": {"type": "object", "properties": {"outbound_path_policy": {"type": "boolean", "example": true}, "announced_prefixes": {"type": "integer", "example": 0}, "incoming_prefix_filt_list": {"type": "string"}, "offset": {"type": "integer", "example": 0}, "bgp_tbl_ver": {"type": "integer", "example": 0}, "accepted_prefixes": {"type": "integer", "example": 0}, "index": {"type": "integer", "example": 0}, "inbound_path_policy": {"type": "boolean", "example": true}, "mask": {"type": "integer", "example": 0}, "community_attr": {"type": "string"}, "neighbor_ver": {"type": "integer", "example": 0}, "outgoing_prefix_filt_list": {"type": "string"}}}, "connections_established": {"type": "integer", "example": 0}, "keepalive_interval": {"type": "integer", "example": 0}, "tx_notifications": {"type": "integer", "description": "Transmitted notifications count", "example": 22}, "bgp_state": {"type": "string", "description": "BGP neighbor state", "example": "Active"}, "ipv4_unicast_address_family_info": {"type": "object", "properties": {"outbound_path_policy": {"type": "boolean", "example": true}, "announced_prefixes": {"type": "integer", "example": 0}, "incoming_prefix_filt_list": {"type": "string"}, "offset": {"type": "integer", "example": 0}, "bgp_tbl_ver": {"type": "integer", "example": 0}, "accepted_prefixes": {"type": "integer", "example": 0}, "index": {"type": "integer", "example": 0}, "inbound_path_policy": {"type": "boolean", "example": true}, "mask": {"type": "integer", "example": 0}, "community_attr": {"type": "string"}, "neighbor_ver": {"type": "integer", "example": 0}, "outgoing_prefix_filt_list": {"type": "string"}}}, "state_time": {"type": "integer", "description": "Time in current state (seconds)", "example": 1664}, "foreign_host": {"type": "string", "description": "Foreign host name", "example": "foreign-host"}, "tx_route_refresh_req": {"type": "integer", "description": "Transmitted route refresh count", "example": 3}, "bgp_connection": {"type": "string"}, "capabilities": {"type": "object", "properties": {"ipv6_unicast": {"type": "string", "description": "IPv6 Unicast capability", "example": "none"}, "vpnv4_tbl_ver": {"type": "integer", "description": "VPNv4 Table Version", "example": 1}, "ipv4_unicast_tbl_ver": {"type": "integer", "description": "IPv4 Multicast Table Version", "example": 1}, "l2vpn_evpn_tbl_ver": {"type": "integer", "description": "L2VPN EVPN Table Version", "example": 1}, "ipv6_unicast_tbl_ver": {"type": "integer", "description": "IPv6 Unicast Table Version", "example": 1}, "vpnv4": {"type": "string", "description": "VPNv4 capability", "example": "none"}, "dynamic": {"type": "string", "description": "Dynamic", "example": "none"}, "vpnv6_unicast": {"type": "string", "description": "VPNv4 unicast capability", "example": "none"}, "l2vpn_evpn": {"type": "string", "description": "L2VPN EVPN capability", "example": "none"}, "vpnv4_unicast": {"type": "string", "description": "VPNv4 unicast capability", "example": "none"}, "vpnv4_unicast_tbl_ver": {"type": "integer", "description": "VPNv4 unicast Table Version", "example": 1}, "ipv4_multicast": {"type": "string", "description": "IPv4 Multicast capability", "example": "none"}, "ipv4_multicast_tbl_ver": {"type": "integer", "description": "IPv4 Multicast Table Version", "example": 1}, "ipv6_multicast": {"type": "string", "description": "IPv6 Multicast capability", "example": "none"}, "ipv6_multicast_tbl_ver": {"type": "integer", "description": "IPv6 Multicast Table Version", "example": 1}, "route_refresh_capability": {"type": "string", "description": "Route refresh capability", "example": "none"}, "ext_asn": {"type": "string", "description": "Extended ASN capability", "example": "none"}, "vpnv6_unicast_tbl_ver": {"type": "integer", "description": "VPNv4 unicast Table Version", "example": 1}, "ipv4_unicast": {"type": "string", "description": "IPv4 Unicast capability", "example": "none"}}}, "min_evpn_adv_time": {"type": "integer", "example": 0}, "rx_notifications": {"type": "integer", "description": "Received notifications count", "example": 150}, "vpnv6_unicast_address_family_info": {"type": "object", "properties": {"outbound_path_policy": {"type": "boolean", "example": true}, "announced_prefixes": {"type": "integer", "example": 0}, "incoming_prefix_filt_list": {"type": "string"}, "offset": {"type": "integer", "example": 0}, "bgp_tbl_ver": {"type": "integer", "example": 0}, "accepted_prefixes": {"type": "integer", "example": 0}, "index": {"type": "integer", "example": 0}, "inbound_path_policy": {"type": "boolean", "example": true}, "mask": {"type": "integer", "example": 0}, "community_attr": {"type": "string"}, "neighbor_ver": {"type": "integer", "example": 0}, "outgoing_prefix_filt_list": {"type": "string"}}}, "next_hop_local": {"type": "string"}, "rx_messages": {"type": "integer", "description": "Received messages count", "example": 55}, "ipv6_multicast_address_family_info": {"type": "object", "properties": {"outbound_path_policy": {"type": "boolean", "example": true}, "announced_prefixes": {"type": "integer", "example": 0}, "incoming_prefix_filt_list": {"type": "string"}, "offset": {"type": "integer", "example": 0}, "bgp_tbl_ver": {"type": "integer", "example": 0}, "accepted_prefixes": {"type": "integer", "example": 0}, "index": {"type": "integer", "example": 0}, "inbound_path_policy": {"type": "boolean", "example": true}, "mask": {"type": "integer", "example": 0}, "community_attr": {"type": "string"}, "neighbor_ver": {"type": "integer", "example": 0}, "outgoing_prefix_filt_list": {"type": "string"}}}, "external_bgp_neighbor_max_hops": {"type": "integer", "example": 0}, "link_type": {"type": "string", "description": "Neighbor link type", "example": "external"}, "connections_dropped": {"type": "integer", "example": 0}}}, "type": "array", "description": "List of neighbor states"}, "uuid": {"readOnly": true, "description": "Switch UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "networks": {"items": {"type": "object", "properties": {"origin": {"type": "string", "description": "Route origin", "example": "IGP"}, "weight": {"type": "integer", "description": "Route weight", "example": 32768}, "metric": {"type": "integer", "description": "Route metric", "example": 0}, "is_internal": {"type": "boolean", "description": "True if internal", "example": true}, "is_labelled": {"type": "boolean", "description": "True if labelled", "example": true}, "is_suppressed": {"type": "boolean", "description": "True if suppressed", "example": false}, "next_hop": {"type": "string", "description": "Route next hop", "example": "10.0.0.1"}, "is_damped": {"type": "boolean", "description": "True if damped", "example": true}, "network": {"type": "object", "properties": {"prefix": {"minimum": 0, "type": "integer", "maximum": 32, "example": 24}, "address": {"type": "string", "example": "172.10.10.10", "format": "ipv4"}}}, "is_best": {"type": "boolean", "description": "True if best route", "example": true}, "is_history": {"type": "boolean", "description": "True if history", "example": true}, "is_stale": {"type": "boolean", "description": "True if stale", "example": false}, "is_valid": {"type": "boolean", "description": "True if valid", "example": true}, "local_pref": {"type": "integer", "description": "Route local preference value", "example": 100}}}, "type": "array", "description": "List of neighbor states"}}}, "type": "array", "description": "List of neighbor states"}}, "title": "Object: BGP State"}, "bgp_switch": {"additionalProperties": false, "required": ["networks", "neighbors", "holddown_timer", "keepalive_timer", "redistribute_connected", "redistribute_static", "redistribute_ospf", "router_id", "uuid"], "type": "object", "properties": {"router_id": {"description": "Router ID to be used for BGP configuration, empty if using Fabric IP Network.", "type": "string", "example": "172.10.10.10", "format": "ipv4"}, "neighbors": {"items": {"$ref": "#/definitions/bgp_neighbor"}, "type": "array", "description": "BGP Neighbors configured on this switch", "title": "BGP Neighbors"}, "holddown_timer": {"description": "Holddown timer in seconds.Default value will be used if zero is specified.", "maximum": 65535, "readOnly": false, "minimum": 0, "type": "integer", "example": 90}, "redistribute_static": {"readOnly": false, "type": "boolean", "description": "True if static routes should be redistributed; false otherwise.", "example": true}, "description": {"type": "string", "example": "Description of BGP switch"}, "redistribute_connected": {"readOnly": false, "type": "boolean", "description": "True if local routes should be redistributed; false otherwise.", "example": true}, "keepalive_timer": {"description": "Keepalive timer in seconds.Default value will be used if zero is specified.", "maximum": 65535, "readOnly": false, "minimum": 0, "type": "integer", "example": 30}, "redistribute_ospf": {"readOnly": false, "type": "boolean", "description": "True if OSPF routes should be redistributed; false otherwise.", "example": false}, "networks": {"items": {"required": ["network", "description", "name"], "properties": {"description": {"type": "string", "example": "Description of BGP switch network prefix"}, "network": {"required": ["address", "prefix_length"], "type": "object", "properties": {"prefix_length": {"minimum": 0, "type": "integer", "maximum": 32, "example": 24}, "address": {"type": "string", "example": "172.10.10.10", "format": "ipv4"}}}, "name": {"type": "string", "example": "My BGP switch network prefix"}}}, "type": "array", "description": "Networks to be advertised by this switch"}, "name": {"type": "string", "example": "My BGP switch"}, "uuid": {"readOnly": false, "description": "Switch UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}}, "title": "Object: BGP Switch Configuration"}, "bgp_switch_create": {"additionalProperties": false, "required": ["networks", "neighbors", "holddown_timer", "keepalive_timer", "redistribute_connected", "redistribute_static", "redistribute_ospf", "router_id", "uuid"], "type": "object", "properties": {"router_id": {"format": "ipv4", "type": "string", "description": "Router ID to be used for BGP configuration, empty if using Fabric IP Network.", "example": "172.10.10.10"}, "neighbors": {"items": {"$ref": "#/definitions/bgp_neighbor"}, "type": "array", "description": "BGP Neighbors configured on this switch", "title": "BGP Neighbors"}, "holddown_timer": {"description": "Holddown timer in seconds.Default value will be used if zero is specified.", "maximum": 65535, "readOnly": false, "minimum": 0, "type": "integer", "example": 90}, "redistribute_static": {"readOnly": false, "type": "boolean", "description": "True if static routes should be redistributed; false otherwise.", "example": true}, "description": {"type": "string", "example": "Description of BGP switch"}, "uuid": {"description": "Switch UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": false, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "redistribute_connected": {"readOnly": false, "type": "boolean", "description": "True if local routes should be redistributed; false otherwise.", "example": true}, "keepalive_timer": {"description": "Keepalive timer in seconds.Default value will be used if zero is specified.", "maximum": 65535, "readOnly": false, "minimum": 0, "type": "integer", "example": 30}, "redistribute_ospf": {"readOnly": false, "type": "boolean", "description": "True if OSPF routes should be redistributed; false otherwise.", "example": false}, "networks": {"items": {"required": ["network", "description", "name"], "properties": {"description": {"type": "string", "example": "Description of BGP switch network prefix"}, "name": {"type": "string", "example": "My BGP switch network prefix"}, "network": {"required": ["address", "prefix_length"], "type": "object", "properties": {"prefix_length": {"minimum": 0, "type": "integer", "maximum": 32, "example": 24}, "address": {"type": "string", "example": "172.10.10.10", "format": "ipv4"}}}}}, "type": "array", "description": "Networks to be advertised by this switch"}, "name": {"type": "string", "example": "My BGP switch"}}, "title": "Object: BGP Switch (create)"}, "bgp_switch_update": {"additionalProperties": false, "required": ["networks", "neighbors", "holddown_timer", "keepalive_timer", "redistribute_connected", "redistribute_static", "redistribute_ospf", "router_id"], "type": "object", "properties": {"router_id": {"format": "ipv4", "type": "string", "description": "Router ID to be used for BGP configuration, empty if using Fabric IP Network.", "example": "172.10.10.10"}, "neighbors": {"items": {"$ref": "#/definitions/bgp_neighbor"}, "type": "array", "description": "BGP Neighbors configured on this switch", "title": "BGP Neighbors"}, "holddown_timer": {"description": "Holddown timer in seconds.Default value will be used if zero is specified.", "maximum": 65535, "readOnly": false, "minimum": 0, "type": "integer", "example": 90}, "redistribute_static": {"readOnly": false, "type": "boolean", "description": "True if static routes should be redistributed; false otherwise.", "example": true}, "description": {"type": "string", "example": "Description of BGP switch"}, "uuid": {"description": "Switch UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": false, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "redistribute_connected": {"readOnly": false, "type": "boolean", "description": "True if local routes should be redistributed; false otherwise.", "example": true}, "keepalive_timer": {"description": "Keepalive timer in seconds.Default value will be used if zero is specified.", "maximum": 65535, "readOnly": false, "minimum": 0, "type": "integer", "example": 30}, "redistribute_ospf": {"readOnly": false, "type": "boolean", "description": "True if OSPF routes should be redistributed; false otherwise.", "example": false}, "networks": {"items": {"required": ["network", "description", "name"], "properties": {"description": {"type": "string", "example": "Description of BGP switch network prefix"}, "name": {"type": "string", "example": "My BGP switch network prefix"}, "network": {"required": ["address", "prefix_length"], "type": "object", "properties": {"prefix_length": {"minimum": 0, "type": "integer", "maximum": 32, "example": 24}, "address": {"type": "string", "example": "172.10.10.10", "format": "ipv4"}}}}}, "type": "array", "description": "Networks to be advertised by this switch"}, "name": {"type": "string", "example": "My BGP switch"}}, "title": "Object: BGP Switch (update)"}, "certificate": {"additionalProperties": false, "required": ["common_name", "issuer", "not_before", "not_after", "self_signed", "subject_alternative_name"], "type": "object", "properties": {"self_signed": {"type": "boolean", "description": "Certificate is self signed", "example": true}, "not_after": {"minLength": 9, "description": "Certificate expiration epoch time", "type": "integer", "example": "1497602656", "maxLength": 11}, "subject_alternative_name": {"items": {"type": "string", "example": "192.168.1.10"}, "type": "array", "description": "Array of Certificate Subject Alternative Names (SANs)"}, "common_name": {"type": "string", "description": "Certificate Common Name (CN)", "example": "connect.example.com"}, "not_before": {"minLength": 9, "description": "Certificate validity start epoch time", "type": "integer", "example": "1497602656", "maxLength": 11}, "issuer": {"type": "string", "description": "Certificate Issuer Distinguished Name (DN)", "example": "cn=Example CA,dc=example,dc=com"}}, "title": "Object: Certificate"}, "certificate_update": {"additionalProperties": false, "required": ["certificate", "private_key"], "type": "object", "properties": {"private_key": {"minLength": 1, "type": "string", "description": "PEM encoded unencrypted private key", "example": ""}, "certificate": {"minLength": 1, "type": "string", "description": "PEM encoded X.509 certificate", "example": ""}}, "title": "Object: Certificate (update)"}, "cfm_cluster_status": {"additionalProperties": false, "required": ["active_member_count", "mode", "health", "members"], "type": "object", "properties": {"health": {"readOnly": true, "$ref": "#/definitions/health_object"}, "active_member_count": {"readOnly": true, "type": "integer", "description": "The current number of active, participating cluster members.", "example": 3}, "mode": {"readOnly": true, "enum": ["standalone", "HA"], "type": "string", "description": "The current HA configuration.", "example": "HA"}, "members": {"items": {"type": "object", "properties": {"status": {"readOnly": true, "enum": ["online", "offline"], "type": "string", "description": "The status of this cluster member", "example": "online"}, "ip_address": {"readOnly": true, "oneOf": [{"type": "string", "example": "172.10.10.10", "format": "ipv4"}, {"type": "string", "example": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", "format": "ipv6"}], "description": "IP address of the cluster member.", "example": "10.10.10.3"}, "name": {"readOnly": true, "type": "string", "description": "The name of this cluster member", "example": "node0"}, "active_services": {"items": {"readOnly": true, "enum": ["cfm", "fitting", "statistics_poller", "vip"], "type": "string", "example": "cfm", "description": "The name of the 'active' application running on this member."}, "type": "array"}}}, "type": "array", "description": "The is the list of all configured nodes in the cluster."}}, "title": "Object: CFM Cluster Status"}, "cluster": {"oneOf": [{"$ref": "#/definitions/cluster_simplivity"}], "description": "Depending on enabled Packs, can be one of:\n* Object: Cluster (discovered by Simplivity Pack)", "title": "Object: Cluster"}, "cluster_simplivity": {"additionalProperties": false, "required": ["cluster_moref", "host_uuids", "hypervisor_management_system", "hypervisor_type", "name", "uuid", "vsphere_uuid"], "type": "object", "properties": {"vsphere_uuid": {"type": "string", "example": "a3cb9e3a-127c-45b5-ada3-001b90b71bc2", "description": "Identifies a unique vSphere (Virtual Center) instance (known to vSphere API)"}, "hosts": {"items": {"$ref": "#/definitions/host_vsphere"}, "type": "array", "description": "Simplivity Hosts"}, "host_uuids": {"items": {"type": "string", "example": "3bd30842-82f7-8ea4-eef8-f715da564892"}, "type": "array", "description": "UUIDs of the host(s) belonging to this cluster"}, "name": {"type": "string", "example": "Simplivity-Local"}, "hypervisor_type": {"enum": ["VSPHERE", "HYPERV"], "type": "string"}, "cluster_moref": {"type": "string", "description": "The moref of the cluster object in vSphere", "example": "domain-c1505"}, "vms": {"items": {"$ref": "#/definitions/vm_vsphere"}, "type": "array", "description": "Simplivity Virtual Machines"}, "uuid": {"type": "string", "description": "The UUID of the Cluster assigned by Simplivity", "example": "623fa14a-e3f4-4724-937d-6debf90fa03b"}, "hypervisor_management_system": {"type": "string", "description": "The name or IP address of the hypervisor management system. For example, if the hypervisor type is VSPHERE, then this is the name/ip address of vCenter Server", "example": "10.10.10.1"}}, "title": "Object: Cluster (discovered by Simplivity pack)"}, "dhcp_relay": {"required": ["dhcp_relay"], "type": "object", "properties": {"dhcp_relay": {"items": {"required": ["vlans", "ipv4_dhcp_server_addresses"], "type": "object", "properties": {"switch_uuids": {"read_only": true, "items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array", "description": "DHCP relay configuration switches."}, "vlans": {"read_only": false, "example": "5, 10-20, 30, 40, 50-60", "type": "string", "description": "VLAN range(s)", "format": "vlan-range"}, "ipv6_dhcp_server_addresses": {"read_only": false, "items": {"type": "string", "example": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", "format": "ipv6"}, "type": "array"}, "ipv4_dhcp_server_addresses": {"read_only": false, "items": {"type": "string", "example": "172.10.10.10", "format": "ipv4"}, "type": "array"}}}, "type": "array"}}}, "dns_client_configuration": {"additionalProperties": false, "required": ["description", "domain_name", "fabric_uuids", "management_software", "name", "name_servers", "search_path", "switch_uuids", "uuid"], "type": "object", "properties": {"management_software": {"type": "boolean", "description": "Whether or not Management Software uses this DNS client configuration. To exclude, specify value as__`False`__.", "example": true}, "set_by_dhcp": {"readOnly": true, "type": "boolean", "description": "Whether or not DHCP created this DNS client configuration.", "example": false}, "fabric_uuids": {"items": {"readOnly": true, "description": "Fabric UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array", "description": "UUIDs of fabrics this DNS client configuration is applied to. When using `fabric_uuid` the configuration will be applied to all switches in the fabric. If the fabric is expanded the new switch will automatically pick up the new settings covered by `fabric_uuid`. To exclude, specify value as the empty array: __`[]`__"}, "description": {"type": "string", "example": "DNS Client Configuration for Building #1, Floor #2"}, "search_path": {"items": {"type": "string", "example": "mydomain.com"}, "type": "array", "description": "Search list of default local domain names. To exclude, specify value as the empty array: __`[]`__"}, "switch_uuids": {"items": {"readOnly": true, "description": "Switch UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array", "description": "UUIDs of switches this DNS Client Configuration is applied to. To exclude, specify value as the empty array: __`[]`__"}, "name_servers": {"minItems": 1, "items": {"type": "string", "example": "10.10.0.1 or 2001:cdba::3257:9652"}, "type": "array", "description": "List of name servers in ipv4 or ipv6 format."}, "uuid": {"readOnly": true, "description": "UUID of DNS configuration.", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "domain_name": {"type": "string", "description": "Specifies the domain name - RFC 1035. To exclude, specify value as empty string.", "example": "anywhere.com"}, "name": {"type": "string", "example": "My DNS Client Configuration", "format": "non_empty_or_whitespace_string"}}, "title": "Object: DNS Client Configuration"}, "dns_client_configuration_create": {"additionalProperties": false, "required": ["domain_name", "fabric_uuids", "management_software", "name", "name_servers", "search_path", "switch_uuids"], "type": "object", "properties": {"description": {"type": "string", "example": "DNS Client Configuration for Building #1, Floor #2"}, "domain_name": {"type": "string", "description": "Specifies the domain name - RFC 1035. To exclude, specify value as empty string.", "example": "anywhere.com"}, "search_path": {"items": {"type": "string", "example": "mydomain.com"}, "type": "array", "description": "Search list of default local domain names. To exclude, specify value as the empty array: __`[]`__"}, "management_software": {"type": "boolean", "description": "Whether or not Management Software uses this DNS client configuration. To exclude, specify value as__`False`__.", "example": true}, "switch_uuids": {"items": {"description": "Switch UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array", "description": "UUIDs of switches this DNS Client Configuration is applied to. To exclude, specify value as the empty array: __`[]`__"}, "fabric_uuids": {"items": {"description": "Fabric UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array", "description": "UUIDs of fabrics this DNS client configuration is applied to. When using `fabric_uuid` the configuration will be applied to all switches in the fabric. If the fabric is expanded the new switch will automatically pick up the new settings covered by `fabric_uuid`. To exclude, specify value as the empty array: __`[]`__"}, "name_servers": {"minItems": 1, "items": {"type": "string", "example": "10.10.0.1 or 2001:cdba::3257:9652"}, "type": "array", "description": "List of name servers in ipv4 or ipv6 format."}, "name": {"type": "string", "example": "My DNS Client Configuration", "format": "non_empty_or_whitespace_string"}}, "title": "Object: DNS Client Configuration (Create)"}, "dns_client_configuration_update": {"additionalProperties": false, "required": ["domain_name", "fabric_uuids", "management_software", "name", "name_servers", "search_path", "switch_uuids"], "type": "object", "properties": {"set_by_dhcp": {"readOnly": true, "type": "boolean", "description": "Whether or not DHCP created this DNS client configuration.", "example": false}, "description": {"type": "string", "example": "DNS Client Configuration for Building #1, Floor #2"}, "name": {"type": "string", "example": "My DNS Client Configuration", "format": "non_empty_or_whitespace_string"}, "search_path": {"items": {"type": "string", "example": "mydomain.com"}, "type": "array", "description": "Search list of default local domain names. To exclude, specify value as the empty array: __`[]`__"}, "domain_name": {"type": "string", "description": "Specifies the domain name - RFC 1035. To exclude, specify value as empty string.", "example": "anywhere.com"}, "management_software": {"type": "boolean", "description": "Whether or not Management Software uses this DNS client configuration. To exclude, specify value as__`False`__.", "example": true}, "switch_uuids": {"items": {"description": "Switch UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array", "description": "UUIDs of switches this DNS Client Configuration is applied to. To exclude, specify value as the empty array: __`[]`__"}, "fabric_uuids": {"items": {"description": "Fabric UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array", "description": "UUIDs of fabrics this DNS client configuration is applied to. When using `fabric_uuid` the configuration will be applied to all switches in the fabric. If the fabric is expanded the new switch will automatically pick up the new settings covered by `fabric_uuid`. To exclude, specify value as the empty array: __`[]`__"}, "name_servers": {"minItems": 1, "items": {"type": "string", "example": "10.10.0.1 or 2001:cdba::3257:9652"}, "type": "array", "description": "List of name servers in ipv4 or ipv6 format."}, "uuid": {"description": "UUID of DNS configuration.", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}}, "title": "Object: DNS Client Configuration (Update)"}, "downlink_switch": {"additionalProperties": false, "required": ["mac_address", "name", "product", "vendor", "uuid"], "type": "object", "properties": {"product": {"type": "string", "example": "Synergy"}, "vendor": {"type": "string", "example": "HPE"}, "uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "name": {"type": "string", "example": "host.hpe.com", "maxLength": 255}, "mac_address": {"example": "F4:03:43:00:00:01", "format": "mac_address"}, "description": {"type": "string", "example": "HPE Synergy switch"}}, "title": "Object: Downlink Switch"}, "downlink_switch_create": {"additionalProperties": false, "required": ["mac_address", "name", "product", "vendor"], "type": "object", "properties": {"product": {"type": "string", "example": "Synergy"}, "vendor": {"type": "string", "example": "HPE"}, "description": {"type": "string", "example": "HPE Synergy switch"}, "name": {"type": "string", "example": "host.hpe.com", "maxLength": 255}, "mac_address": {"example": "F4:03:43:00:00:01", "format": "mac_address"}}, "title": "Object: Downlink Switch (Create)"}, "downlink_switch_update": {"additionalProperties": false, "required": ["name", "product", "vendor"], "type": "object", "properties": {"product": {"type": "string", "example": "Synergy"}, "vendor": {"type": "string", "example": "HPE"}, "description": {"type": "string", "example": "HPE Synergy switch"}, "name": {"type": "string", "example": "host.hpe.com", "maxLength": 255}, "uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}}, "title": "Object: Downlink Switch (Update)"}, "evpn_route": {"additionalProperties": false, "type": "object", "properties": {"l2vpn_uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "switch_uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "route_distinguisher": {"type": "string", "example": "1.1.1.1:38000"}, "table_version": {"type": "int", "example": 3}, "routes": {"items": {"type": "object", "properties": {"route_info": {"items": {"type": "object", "properties": {"route_targets": {"items": {"type": "string", "example": "65000:53"}, "type": "array"}, "next_hop": {"type": "string", "example": "10.1.1.4"}}}, "type": "array"}, "prefix": {"type": "string", "example": "[2]:[05:00:00:fd:e8:00:00:00:37:00]:[0]:[48]:[0b0c:0d0e:0f10]", "description": "EVPN type-1 prefix: [1]:[ESI]:[EthTag]\nEVPN type-2 prefix: [2]:[ESI]:[EthTag]:[MAC_length]:[MAC]:[IP_length]:[IP]"}}}, "type": "array"}, "local_router_id": {"type": "string", "example": "10.10.0.1 / 2001:0db8:85a3:0000:0000:8a2e:0370:7334"}}, "title": "EVPN Route"}, "fabric": {"additionalProperties": false, "required": ["description", "is_stable", "name", "uuid"], "type": "object", "properties": {"description": {"type": "string", "example": ""}, "foreign_manager_id": {"default": "", "type": "string", "example": "00000111111000000000000000000001"}, "tags": {"$ref": "#/definitions/tags_on_object"}, "foreign_fabric_state": {"enum": ["Adding", "Unmanaged", "Configured"], "type": "string", "example": "Configured"}, "switches": {"items": {"$ref": "#/definitions/switch_flat"}, "readOnly": true, "type": "array"}, "foreign_management_state": {"readOnly": true, "enum": ["Available", "Claimed", "Unavailable"], "type": "string", "example": "Claimed"}, "uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "name": {"type": "string", "example": "fabric-01", "format": "non_empty_or_whitespace_string"}, "settings": {"readOnly": true, "$ref": "#/definitions/fabric_settings"}, "segments": {"$ref": "#/definitions/fabric_segments"}, "segmented": {"readOnly": true, "type": "boolean", "example": false}, "health": {"readOnly": true, "$ref": "#/definitions/health_object"}, "is_stable": {"readOnly": true, "type": "boolean", "example": true}, "foreign_manager_url": {"default": "", "type": "string", "example": "https://remote-manager-address.domain"}, "password_update_required": {"readOnly": true, "type": "boolean", "description": "True if a fabric administrator password update is needed", "example": false}}, "title": "Object: Fabric"}, "fabric_create": {"additionalProperties": false, "required": ["host", "name"], "type": "object", "properties": {"host": {"oneOf": [{"format": "hostname"}, {"format": "ipv6"}], "type": "string", "example": "192.168.1.1"}, "password": {"writeOnly": true, "type": "string", "description": "Fabric password. This password will be applied to all switches in the fabric in need of a password update.", "example": "2jBTy@kwxpR=MSdC"}, "name": {"type": "string", "example": "fabric-01", "format": "non_empty_or_whitespace_string"}, "tags": {"$ref": "#/definitions/tags_on_object"}, "description": {"type": "string", "example": ""}}, "title": "Object: Fabric Discovery"}, "fabric_ip_network": {"additionalProperties": false, "required": ["fabric_uuid", "mode"], "type": "object", "properties": {"ipv6_subnet": {"required": ["address", "prefix_length"], "type": "object", "properties": {"prefix_length": {"minimum": 0, "type": "integer", "maximum": 128, "example": 64}, "address": {"type": "string", "example": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", "format": "ipv6"}}, "description": "IPv6 subnet to provision Fabric IP network addresses from."}, "fabric_uuid": {"readOnly": true, "description": "UUID of the fabric on which this fabric IP network config should be created.Note that a fabric IP network config cannot be associated with a different fabric after creation", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "name": {"type": "string", "description": "Fabric IP Network name (displayed in UI)", "example": ""}, "ipv4_subnet": {"required": ["address", "prefix_length"], "type": "object", "properties": {"prefix_length": {"minimum": 0, "type": "integer", "maximum": 32, "example": 24}, "address": {"type": "string", "example": "172.10.10.10", "format": "ipv4"}}, "description": "IPv4 subnet to provision Fabric IP network addresses from."}, "description": {"type": "string", "example": ""}, "vlan": {"minimum": 0, "description": "VLAN to use for Fabric IP Network; 0 used by default", "default": 0, "type": "integer", "maximum": 4000, "example": 10}, "switch_addresses": {"items": {"additionalProperties": false, "required": ["switch_uuid", "ipv4_address", "ipv6_address"], "type": "object", "properties": {"ipv4_address": {"required": ["address", "prefix_length"], "type": "object", "properties": {"prefix_length": {"minimum": 0, "type": "integer", "maximum": 32, "example": 24}, "address": {"type": "string", "example": "172.10.10.10", "format": "ipv4"}}}, "switch_uuid": {"min_length": 32, "description": "Switch UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "max_length": 36, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "ipv6_address": {"required": ["address", "prefix_length"], "type": "object", "properties": {"prefix_length": {"minimum": 0, "type": "integer", "maximum": 128, "example": 64}, "address": {"type": "string", "example": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", "format": "ipv6"}}}}}, "type": "array", "description": "List of switch fabric IP network address assignments read-write in manual mode, read-only in automatic mode. "}, "mode": {"enum": ["automatic", "manual"], "type": "string", "description": "Fabric IP Network mode of operation", "example": "manual"}}, "title": "Object: Fabric IP Network Configuration"}, "fabric_ip_network_create": {"additionalProperties": false, "required": ["fabric_uuid", "mode", "switch_addresses", "ipv4_subnet"], "type": "object", "properties": {"fabric_uuid": {"description": "UUID of the fabric on which this fabric IP network config should be created.Note that a fabric IP network config cannot be associated with a different fabric after creation", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "description": {"type": "string", "example": ""}, "vlan": {"description": "VLAN to use for Fabric IP Network; 0 used by default", "default": 0, "maximum": 4000, "minimum": 0, "type": "integer", "example": 10}, "name": {"type": "string", "description": "Fabric IP Network name (displayed in UI)", "example": ""}, "ipv6_subnet": {"required": ["address", "prefix_length"], "type": "object", "properties": {"prefix_length": {"minimum": 0, "type": "integer", "maximum": 128, "example": 64}, "address": {"type": "string", "example": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", "format": "ipv6"}}, "description": "IPv6 subnet to provision Fabric IP network addresses from."}, "switch_addresses": {"items": {"additionalProperties": false, "required": ["switch_uuid", "ipv4_address"], "type": "object", "properties": {"ipv4_address": {"required": ["address", "prefix_length"], "type": "object", "properties": {"prefix_length": {"minimum": 0, "type": "integer", "maximum": 32, "example": 24}, "address": {"type": "string", "example": "172.10.10.10", "format": "ipv4"}}}, "switch_uuid": {"min_length": 32, "description": "Switch UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": false, "max_length": 36, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "ipv6_address": {"required": ["address", "prefix_length"], "type": "object", "properties": {"prefix_length": {"minimum": 0, "type": "integer", "maximum": 128, "example": 64}, "address": {"type": "string", "example": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", "format": "ipv6"}}}}}, "type": "array", "description": "List of switch fabric IP network address assignments read-write in manual mode, read-only in automatic mode. "}, "ipv4_subnet": {"required": ["address", "prefix_length"], "type": "object", "properties": {"prefix_length": {"minimum": 0, "type": "integer", "maximum": 32, "example": 24}, "address": {"type": "string", "example": "172.10.10.10", "format": "ipv4"}}, "description": "IPv4 subnet to provision Fabric IP network addresses from."}, "mode": {"enum": ["automatic", "manual"], "type": "string", "description": "Fabric IP Network mode of operation", "example": "manual"}}, "title": "Object: Fabric IP Network Configuration (create)"}, "fabric_ip_network_update": {"additionalProperties": false, "required": ["mode", "switch_addresses", "ipv4_subnet"], "type": "object", "properties": {"description": {"type": "string", "example": ""}, "vlan": {"description": "VLAN to use for Fabric IP Network; 0 used by default", "default": 0, "maximum": 4000, "minimum": 0, "type": "integer", "example": 10}, "name": {"type": "string", "description": "Fabric IP Network name (displayed in UI)", "example": ""}, "ipv6_subnet": {"required": ["address", "prefix_length"], "type": "object", "properties": {"prefix_length": {"minimum": 0, "type": "integer", "maximum": 128, "example": 64}, "address": {"type": "string", "example": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", "format": "ipv6"}}, "description": "IPv6 subnet to provision Fabric IP network addresses from."}, "switch_addresses": {"items": {"additionalProperties": false, "required": ["switch_uuid", "ipv4_address"], "type": "object", "properties": {"ipv4_address": {"required": ["address", "prefix_length"], "type": "object", "properties": {"prefix_length": {"minimum": 0, "type": "integer", "maximum": 32, "example": 24}, "address": {"type": "string", "example": "172.10.10.10", "format": "ipv4"}}}, "switch_uuid": {"min_length": 32, "description": "Switch UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": false, "max_length": 36, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "ipv6_address": {"required": ["address", "prefix_length"], "type": "object", "properties": {"prefix_length": {"minimum": 0, "type": "integer", "maximum": 128, "example": 64}, "address": {"type": "string", "example": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", "format": "ipv6"}}}}}, "type": "array", "description": "List of switch fabric IP network address assignments read-write in manual mode, read-only in automatic mode. "}, "ipv4_subnet": {"required": ["address", "prefix_length"], "type": "object", "properties": {"prefix_length": {"minimum": 0, "type": "integer", "maximum": 32, "example": 24}, "address": {"type": "string", "example": "172.10.10.10", "format": "ipv4"}}, "description": "IPv4 subnet to provision Fabric IP network addresses from."}, "mode": {"enum": ["automatic", "manual"], "type": "string", "description": "Fabric IP Network mode of operation", "example": "manual"}}, "title": "Object: Fabric IP Network Configuration (update)"}, "fabric_patch_document": {"additionalProperties": false, "required": ["op", "path", "value"], "type": "object", "properties": {"path": {"type": "string", "description": "A JSON pointer."}, "from": {"type": "string", "description": "A string containing a JSON Pointer value."}, "value": {"anyOf": [{"type": "string"}, {"type": "integer"}, {"type": "array"}, {"type": "boolean"}], "description": "The value to be used within the operations. The value is of type integer, string, or boolean.", "example": "value"}, "op": {"enum": ["replace"], "type": "string", "description": "The operation to be performed."}}}, "fabric_patch_request": {"additionalProperties": false, "required": ["uuids", "patch"], "type": "object", "properties": {"uuids": {"items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array", "example": ["0c3b45fd-bd85-4e69-a525-567e756445a6"]}, "patch": {"items": {"$ref": "#/definitions/fabric_patch_document"}, "type": "array", "example": [{"path": "/foreign_manager_id", "value": "GUID", "op": "replace"}]}}}, "fabric_rediscover": {"additionalProperties": false, "required": ["host", "use_default_token"], "type": "object", "properties": {"host": {"writeOnly": true, "type": "string", "example": "192.168.1.1", "format": "hostname"}, "use_default_token": {"default": false, "type": "boolean", "example": false}}, "title": "Object: Fabric Rediscovery"}, "fabric_segments": {"items": {"additionalProperties": false, "required": ["uuid", "is_default", "switches"], "type": "object", "properties": {"is_default": {"readOnly": true, "type": "boolean", "example": true}, "switches": {"items": {"min_length": "32", "max_length": "32", "type": "string", "description": "UUIDs of switches in this segment."}, "readOnly": true, "type": "array", "example": ["42de42fa30877ada9b6c567d89587fea", "4e2f16c3979f494dbf0393d8a01e8fd5", "c27ea048bab64b4a9db9e25d2ba511f4", "92de42fa30874f8a5b6c567d8958ae86"]}, "uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}}}, "readOnly": true, "type": "array", "title": "Object: Segments within a fabric."}, "fabric_settings": {"additionalProperties": false, "required": ["bridge_loop_detection"], "type": "object", "properties": {"bridge_loop_detection": {"additionalProperties": false, "required": ["loop_mode", "reflect_mode", "penalty_interval", "threshold"], "type": "object", "description": "Bridge loop detection setting for this fabric.", "properties": {"threshold": {"description": "Receive more frames than the threshold for bridge loop detection is set to within the penalty interval; actions will trigger.", "default": 1, "maximum": 65000, "minimum": 1, "type": "number", "example": 1}, "penalty_interval": {"description": "Bridge loop detection penalty interval in milliseconds. Receive more frames than the threshold is set to within this interval; actions will trigger.", "default": 5000, "maximum": 65000, "minimum": 1, "type": "number", "example": 5000}, "reflect_mode": {"default": "block", "enum": ["alert", "block"], "type": "string", "description": "The reflect mode for bridge loop detection on this port.", "example": "block"}, "loop_mode": {"default": "block", "enum": ["alert", "block"], "type": "string", "description": "The loop mode for bridge loop detection on this port.", "example": "block"}}}, "l2vpn": {"additionalProperties": false, "required": ["calculate_topology", "topology_initialized"], "type": "object", "description": "L2VPN setting for this fabric.", "properties": {"calculate_topology": {"default": false, "type": "boolean", "description": "If true, calculate the L2VPN topology during a fit."}, "topology_initialized": {"default": false, "readOnly": true, "type": "boolean", "description": "If true, CFM has initialized the L2VPN infrastructure on the switches. If false, you must run a full fit before configuring L2VPN."}}}}, "title": "Object: Fabric Settings"}, "fabric_settings_update": {"additionalProperties": false, "required": ["bridge_loop_detection"], "type": "object", "properties": {"bridge_loop_detection": {"additionalProperties": false, "required": ["loop_mode", "reflect_mode", "penalty_interval", "threshold"], "type": "object", "description": "Bridge loop detection setting for this fabric.", "properties": {"threshold": {"description": "Receive more frames than the threshold for bridge loop detection is set to within the penalty interval; actions will trigger.", "default": 1, "maximum": 65000, "minimum": 1, "type": "number", "example": 1}, "penalty_interval": {"description": "Bridge loop detection penalty interval in milliseconds. Receive more frames than the threshold is set to within this interval; actions will trigger.", "default": 5000, "maximum": 65000, "minimum": 1, "type": "number", "example": 5000}, "reflect_mode": {"default": "block", "enum": ["alert", "block"], "type": "string", "description": "The reflect mode for bridge loop detection on this port.", "example": "block"}, "loop_mode": {"default": "block", "enum": ["alert", "block"], "type": "string", "description": "The loop mode for bridge loop detection on this port.", "example": "block"}}}, "l2vpn": {"additionalProperties": false, "required": ["calculate_topology"], "type": "object", "description": "L2VPN setting for this fabric.", "properties": {"calculate_topology": {"default": false, "type": "boolean", "description": "If true, calculate the L2VPN topology during a fit."}}}}, "title": "Object: Fabric Settings (Update)"}, "fabric_update": {"additionalProperties": false, "required": ["description", "name"], "type": "object", "properties": {"description": {"type": "string", "example": ""}, "foreign_manager_id": {"default": "", "type": "string", "example": "00000111111000000000000000000001"}, "tags": {"$ref": "#/definitions/tags_on_object"}, "password_update_required": {"readOnly": true, "type": "boolean", "description": "True if a fabric administrator password update is needed", "example": false}, "foreign_fabric_state": {"enum": ["Adding", "Unmanaged", "Configured"], "type": "string", "example": "Configured"}, "settings": {"readOnly": true, "$ref": "#/definitions/fabric_settings_update"}, "foreign_manager_url": {"default": "", "type": "string", "example": "https://remote-manager-address.domain"}, "name": {"type": "string", "example": "fabric-01", "format": "non_empty_or_whitespace_string"}, "switches": {"items": {"$ref": "#/definitions/switch_flat"}, "readOnly": true, "type": "array"}, "segmented": {"readOnly": true, "type": "boolean", "example": false}, "health": {"readOnly": true, "$ref": "#/definitions/health_object"}, "is_stable": {"readOnly": true, "type": "boolean", "example": true}, "foreign_management_state": {"readOnly": true, "enum": ["Available", "Claimed", "Unavailable"], "type": "string", "example": "Claimed"}, "segments": {"$ref": "#/definitions/fabric_segments"}, "uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}}, "title": "Object: Fabric (update)"}, "file": {"additionalProperties": false, "required": ["checksum", "date_created", "name", "url"], "type": "object", "properties": {"url": {"type": "string", "description": "Download URL", "example": "https://192.168.0.1/api/v1/files/README?key=c04c516a9449700f8d54c4866a13b0e883dfabf77929ef11bf72ddc7ffeecda7fcb05bf70e7bb9e20930e988b1d689b4"}, "checksum": {"minLength": 64, "maxLength": 64, "type": "string", "description": "SHA256 checksum", "example": "e27a77a283f2097657b74f6c24c4a21f0e9cf45e4e7139af81a573096c0b2570"}, "name": {"type": "string", "description": "File name", "example": "README"}, "key": {"minLength": 96, "maxLength": 96, "type": "string", "description": "Download access key", "example": "c04c516a9449700f8d54c4866a13b0e883dfabf77929ef11bf72ddc7ffeecda7fcb05bf70e7bb9e20930e988b1d689b4"}, "date_created": {"minLength": 9, "maxLength": 11, "type": "integer", "description": "File creation epoch time", "example": "1497602656"}}, "title": "Object: File"}, "fit": {"additionalProperties": false, "required": [], "type": "object", "properties": {"fit_type": {"enum": ["full", "incremental", "l2vpn"], "type": "string", "description": "Fit type", "example": "full"}, "fabric_uuid": {"readOnly": true, "description": "UUID of fabric to perform fit for", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "description": {"type": "string", "example": "Fit for vlan 100 flow"}, "time_created": {"readOnly": true, "type": "integer", "description": "Time that fit was created "}, "fitting_number_high": {"readOnly": true, "type": "integer", "description": "High part of value that can be used to correlate fit object \nwith active fit on the switches", "example": "783eff3f768f434399d7379ad93a8393"}, "committed": {"default": false, "type": "boolean", "description": "If true, this is the fit committed to the switches at this moment in time"}, "fit_status": {"enum": ["COMPLETED", "RUNNING", "FAILED"], "type": "string", "description": "Status of current fit", "example": "COMPLETED"}, "uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "fitting_number_low": {"readOnly": true, "type": "integer", "description": "Low part of value that can be used to correlate fit object \nwith active fit on the switches", "example": "783eff3f768f434399d7379ad93a8393"}, "name": {"type": "string", "example": "Fit for Fabric 1"}, "full_fit_uuid": {"readOnly": true, "description": "UUID of full fit associated with this partial", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "fit_status_description": {"type": "string", "example": "Detailed description of the current fit status\nStatus description of fit"}, "use_default_residual_load": {"default": true, "type": "boolean", "description": "Use a default load traffic matrix for the residual topology. If __`true`__, the user does not have to specify a residual traffic matrix and the fitting engine will derived the proper traffic matrix for the residual paths. If __`false`__ a residual traffic matrix should be specified by the user"}, "historical_entries": {"items": {"type": "object", "$ref": "#/definitions/fit_historical_entry"}, "type": "array"}, "bum_load_percent": {"description": "Optionally define the load to use during calculation of broadcast, unknown unicast and multicast paths", "default": 20, "maximum": 100, "minimum": 1, "type": "integer", "example": 20}}, "title": "Object: Fit"}, "fit_create": {"additionalProperties": false, "required": ["fabric_uuid"], "type": "object", "properties": {"fabric_uuid": {"description": "UUID of fabric to perform fit for", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "description": {"type": "string", "example": "Fit for vlan 100 flow"}, "use_default_residual_load": {"default": true, "type": "boolean", "description": "Use a default load traffic matrix for the residual topology. If __`true`__, the user does not have to specify a residual traffic matrix and the fitting engine will derived the proper traffic matrix for the residual paths. If __`false`__ a residual traffic matrix should be specified by the user"}, "name": {"type": "string", "example": "Fit for Fabric 1"}, "bum_load_percent": {"description": "Optionally define the load to use during calculation of broadcast, unknown unicast and multicast paths", "default": 20, "maximum": 100, "minimum": 1, "type": "integer", "example": 20}}, "title": "Object: Fit (Create)"}, "fit_historical_entry": {"additionalProperties": false, "type": "object", "properties": {"status": {"enum": ["COMPLETED", "RUNNING", "FAILED"], "type": "string", "description": "Status of fit operation", "example": "COMPLETED"}, "fit_type": {"enum": ["full", "incremental", "l2vpn"], "type": "string", "description": "Type of fit performer.", "example": "full"}, "time_ran": {"readOnly": true, "type": "integer", "description": "Time that fit was run "}, "added_l2vpns": {"items": {"type": "string", "description": "L2Vpns added as part of fit operation"}, "type": "array"}, "added_affinities": {"items": {"type": "string", "description": "Affinities added as part of fit operation"}, "type": "array"}, "deleted_l2vpns": {"items": {"type": "string", "description": "L2Vpns deleted as part of fit operation"}, "type": "array"}, "added_topologies": {"items": {"type": "string", "description": "Topologies added as part of fit operation"}, "type": "array"}, "deleted_topologies": {"items": {"type": "string", "description": "Topologies deleted as part of fit operation"}, "type": "array"}, "deleted_flows": {"items": {"type": "string", "description": "Flows deleted as part of fit operation"}, "type": "array"}, "error_details": {"type": "string", "example": "Details about error in the event of a failed fit"}}, "title": "Object: Fit Historical Entry"}, "fit_update": {"additionalProperties": false, "required": ["fabric_uuid", "fabric_uuid"], "type": "object", "properties": {"bum_load_percent": {"description": "Optionally define the load to use during calculation of broadcast, unknown unicast and multicast paths", "default": 20, "maximum": 100, "minimum": 1, "type": "integer", "example": 20}, "description": {"type": "string", "example": "Fit for vlan 100 flow"}, "name": {"type": "string", "example": "Fit for Fabric 1"}, "use_default_residual_load": {"default": true, "type": "boolean", "description": "Use a default load traffic matrix for the residual topology. If __`true`__, the user does not have to specify a residual traffic matrix and the fitting engine will derived the proper traffic matrix for the residual paths. If __`false`__ a residual traffic matrix should be specified by the user"}}, "title": "Object: Fit (Update)"}, "health_object": {"type": "object", "properties": {"status": {"readOnly": true, "enum": ["healthy", "unknown", "ok_but", "degraded", "minor", "major", "critical", "non_recoverable"], "type": "string", "description": "Indicates the overall state of the component.", "example": "healthy"}, "health_issues": {"items": {"additionalProperties": false, "required": [], "type": "object", "properties": {"description_id": {"readOnly": true, "type": "string"}, "resolution": {"readOnly": true, "type": "string"}, "description": {"readOnly": true, "type": "string"}}}, "readOnly": true, "type": "array", "title": "Object: Health object."}}}, "host": {"oneOf": [{"$ref": "#/definitions/host_kubernetes"}, {"$ref": "#/definitions/host_ilo_amplifier"}, {"$ref": "#/definitions/host_nutanix"}, {"$ref": "#/definitions/host_vsphere"}], "description": "Depending on enabled Packs, can be one of:\n* Object: Host (discovered by Kubernetes Pack)\n* Object: Host (discovered by iLO Amplifier Pack)\n* Object: Host (discovered by Nutanix Pack)\n* Object: Host (discovered by vSphere Pack)", "title": "Object: Host"}, "host_generic": {"additionalProperties": false, "required": ["description", "name", "type", "uuid", "vendor"], "type": "object", "properties": {"vendor": {"enum": ["kubernetes", "nutanix", "simplivity", "vmware", "ilo"], "type": "string"}, "description": {"type": "string", "example": ""}, "pods": {"items": {"$ref": "#/definitions/pod_generic"}, "type": "array"}, "vms": {"items": {"$ref": "#/definitions/vm_generic"}, "type": "array"}, "name": {"type": "string", "example": "esxi-1.example.com"}, "uuid": {"readOnly": true, "description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "00054518-c886-3a51-0002-000000000022"}, "vswitches": {"items": {"$ref": "#/definitions/vswitch"}, "type": "array"}, "nics": {"items": {"items": {"$ref": "#/definitions/host_nic_generic"}, "type": "object", "description": "Host Network Interface"}, "type": "array", "description": "Object varies depending on the value of `vendor`\n* `nutanix:` Refer to Object: Infrastructure Host Network Interface (Nutanix)\n* `ilo:` Refer to Object: Infrastructure Host Network Interface (iLO Amplifier)\n* `vmware, simplivity:` Refer to Object: Infrastructure Host Network Interface (vSphere)\n* `kubernetes:` Refer to Object: Infrastructure Host Network Interface (Kubernetes)\n"}, "hypervisor_type": {"enum": ["esxi", "kvm", "k8s"], "type": "string"}, "ilo": {"oneOf": [{"type": "object", "description": "Object: Infrastructure host interface adapter common object (iLO Amplifier)", "$ref": "#/definitions/host_ilo_amplifier_common"}, {"type": "null"}], "description": "Object: Infrastructure host interface adapter common object (iLO Amplifier)"}, "type": {"enum": ["baremetal", "compute", "hci", "vsan"], "type": "string"}}, "title": "Object: Host (Generic)"}, "host_ilo_amplifier": {"additionalProperties": false, "required": ["description", "name", "ilo", "type", "uuid", "vendor"], "type": "object", "properties": {"instance_uuid": {"min_length": 32, "description": "Identifies a unique iLO Amplifier instance", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "max_length": 36, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "vendor": {"enum": ["ilo"], "type": "string"}, "description": {"type": "string", "example": ""}, "nics": {"items": {"$ref": "#/definitions/host_ilo_amplifier_nic"}, "type": "array"}, "ilo": {"oneOf": [{"type": "object", "description": "Object: Infrastructure host interface adapter common object (iLO Amplifier)", "$ref": "#/definitions/host_ilo_amplifier_common"}, {"type": "null"}], "description": "Object: Infrastructure host interface adapter common object (iLO Amplifier)"}, "type": {"enum": ["baremetal"], "type": "string"}, "uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "name": {"type": "string", "example": "host.hpe.com", "maxLength": 255}}, "title": "Object: Infrastructure Host (discovered by iLO Amplifier pack)"}, "host_ilo_amplifier_common": {"additionalProperties": false, "required": ["discovery_state", "federation_name", "health_status", "instance_uuid", "ipv4_address", "ipv6_addresses", "name", "network_adapters", "power_status", "product_id", "product_name", "serial_number", "server_name", "server_os", "server_os_version", "tpm_status", "uid_indicator", "url", "uuid"], "type": "object", "properties": {"instance_uuid": {"min_length": 32, "description": "Identifies a unique iLO Amplifier instance", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "max_length": 36, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "ipv6_addresses": {"items": {"type": "string", "example": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", "format": "ipv6"}, "type": "array", "description": "IPv6 Addresses"}, "network_adapters": {"items": {"$ref": "#/definitions/host_ilo_amplifier_network_adapter"}, "type": "array"}, "name": {"type": "string", "example": "host.hpe.com", "maxLength": 255}, "server_name": {"type": "string", "example": "WINDOWS-SERVER"}, "discovery_state": {"type": "string", "example": "Complete"}, "federation_name": {"type": "string", "example": ""}, "uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "ipv4_address": {"type": "string", "example": "172.10.10.10", "format": "ipv4"}, "tpm_status": {"type": "string", "example": "Absent"}, "health_status": {"enum": ["critical", "ok", "warning", "unknown"], "type": "string"}, "server_os": {"type": "string", "example": "Microsoft Windows Server 2012 R2 Standard"}, "uid_indicator": {"enum": ["off", "on"], "type": "string", "description": "Unit identification light"}, "url": {"type": "string", "example": "/redfish/v1/AggregatorService/ManagedSystems/a4ff2e3c"}, "power_status": {"enum": ["off", "on"], "type": "string"}, "serial_number": {"type": "string", "example": "D2060F2B055119PE010"}, "product_name": {"type": "string", "example": "ProLiant DL385 Gen10"}, "server_os_version": {"type": "string", "example": "6.3.9600"}, "product_id": {"type": "string", "example": "878714-B21"}}, "title": "Object: Infrastructure Host Interface Adapter common object (iLO Amplifier)"}, "host_ilo_amplifier_network_adapter": {"additionalProperties": false, "required": ["uuid", "server_uuid", "instance_uuid", "firmware_version", "name", "slot_id"], "type": "object", "properties": {"instance_uuid": {"min_length": 32, "description": "Identifies a unique iLO Amplifier instance", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "max_length": 36, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "uuid": {"readOnly": true, "format": "ilo_object_uuid", "type": "string", "description": "An iLO Amplifier uuid reference", "example": "37383638-3430-4d32-3239-323330305459-nic-f4:03:43:bf:79:90"}, "slot_id": {"readOnly": true, "type": "string", "example": "unknown"}, "server_uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "firmware_version": {"readOnly": true, "type": "string", "example": "7.8.13"}, "name": {"readOnly": true, "type": "string", "example": "HP CN1100R 2P Converged Network Adapter"}}, "title": "Object: Infrastructure Host Network Interface Adapter (iLO Amplifier)"}, "host_ilo_amplifier_nic": {"additionalProperties": false, "required": ["admin_status", "ilo", "link_speed", "link_state", "mac_address", "name", "uuid"], "type": "object", "properties": {"link_state": {"readOnly": true, "enum": ["up", "down"], "type": "string", "description": "The link state detected for this physical NIC by the Host."}, "admin_status": {"enum": ["up", "down"], "type": "string", "description": "The administrative status for this physical NIC as known to the fabric (switch)."}, "connection_status": {"readOnly": true, "enum": ["active", "inactive", "unknown"], "type": "string", "description": "Current status of host NIC."}, "name": {"type": "string", "example": "host.hpe.com", "maxLength": 255}, "mac_address": {"format": "mac_address", "description": "MAC Address", "example": "00:50:56:aa:bb:dd"}, "ilo": {"oneOf": [{"type": "object", "description": "Object: Infrastructure host interface adapter common NIC object (iLO Amplifier)", "$ref": "#/definitions/host_ilo_amplifier_nic_common"}, {"type": "null"}], "description": "Object: Infrastructure host interface adapter common NIC object (iLO Amplifier)"}, "link_speed": {"readOnly": true, "type": ["number", "null"], "description": "Link speed in Mbps", "example": 10000}, "port_uuid": {"oneOf": [{"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, {"type": "null"}], "description": "UUID of the Switch Port to which this physical NIC is connected (known to the Composable Fabric Manager API)", "example": "03734100-040c-0000-399e-081dc0ca985b"}, "uuid": {"readOnly": true, "format": "ilo_object_uuid", "type": "string", "description": "An iLO Amplifier uuid reference", "example": "37383638-3430-4d32-3239-323330305459-nic-f4:03:43:bf:79:90"}}, "title": "Object: Infrastructure host physical port (iLO Amplifier)"}, "host_ilo_amplifier_nic_common": {"additionalProperties": false, "required": ["health_status", "instance_uuid", "ipv4_addresses", "ipv6_addresses", "name", "network_adapter_uuid", "port_id", "server_uuid", "uuid"], "type": "object", "properties": {"instance_uuid": {"min_length": 32, "description": "Identifies a unique iLO Amplifier instance", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "max_length": 36, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "ipv6_addresses": {"items": {"type": "string", "example": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", "format": "ipv6"}, "type": "array", "description": "IPv6 Addresses"}, "health_status": {"enum": ["critical", "ok", "warning", "unknown"], "type": "string"}, "network_adapter_uuid": {"readOnly": true, "format": "ilo_object_uuid", "type": "string", "description": "An iLO Amplifier uuid reference", "example": "37383638-3430-4d32-3239-323330305459-nic-f4:03:43:bf:79:90"}, "name": {"type": "string", "example": "host.hpe.com", "maxLength": 255}, "server_uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "port_id": {"type": "integer", "example": 2}, "ipv4_addresses": {"items": {"type": "string", "example": "172.10.10.10", "format": "ipv4"}, "type": "array", "description": "IPv4 Addresses"}, "uuid": {"readOnly": true, "format": "ilo_object_uuid", "type": "string", "description": "An iLO Amplifier uuid reference", "example": "37383638-3430-4d32-3239-323330305459-nic-f4:03:43:bf:79:90"}}, "title": "Object: Infrastructure host interface adapter common nic object (iLO Amplifier)"}, "host_kubernetes": {"additionalProperties": false, "required": ["cluster_uuid", "description", "hypervisor_type", "name", "type", "uuid", "vendor"], "type": "object", "properties": {"macs": {"readOnly": true, "type": "array"}, "addresses": {"readOnly": true, "type": "array"}, "vswitches": {"items": {"$ref": "#/definitions/vswitch"}, "readOnly": true, "type": "array", "description": "Virtual Switches"}, "hypervisor_type": {"readOnly": true, "enum": ["k8s"], "type": "string"}, "labels": {"readOnly": true, "type": "object"}, "uuid": {"readOnly": true, "description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "00054518-c886-3a51-0002-000000000022"}, "name": {"readOnly": true, "type": "string", "example": "esxi-1.example.com"}, "switches": {"readOnly": true, "type": "array"}, "pnics": {"readOnly": true, "type": "object"}, "type": {"readOnly": true, "enum": ["compute"], "type": "string"}, "version": {"readOnly": true, "type": "string", "example": "21645022"}, "nics": {"items": {"$ref": "#/definitions/host_kubernetes_nic"}, "readOnly": true, "type": "array"}, "cluster_uuid": {"readOnly": true, "description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "00043518-d996-4c51-0003-000000000033"}, "vendor": {"readOnly": true, "enum": ["kubernetes"], "type": "string"}, "ilo": {"oneOf": [{"type": "object", "description": "Object: Infrastructure host interface adapter common object (iLO Amplifier)", "$ref": "#/definitions/host_ilo_amplifier_common"}, {"type": "null"}], "description": "Object: Infrastructure host interface adapter common object (iLO Amplifier)"}, "pods": {"items": {"$ref": "#/definitions/pod"}, "readOnly": true, "type": "array", "description": "Pods"}, "annotations": {"readOnly": true, "type": "object"}, "description": {"readOnly": true, "type": "string", "example": ""}}, "title": "Object: Infrastructure Host (discovered by Kubernetes pack)"}, "host_kubernetes_nic": {"additionalProperties": false, "required": ["admin_status", "host_uuid", "link_state", "link_speed", "mac_address", "name", "switch_mac_address", "uuid"], "type": "object", "properties": {"uuid": {"readOnly": true, "description": "A UUID-based managed object reference", "format": "uuid_based_moref", "type": "string", "example": "1da43389-0f14-11e8-a89f-005056babe67-ens192"}, "connection_status": {"readOnly": true, "enum": ["active", "inactive", "unknown"], "type": "string", "description": "Current status of host NIC."}, "name": {"readOnly": true, "type": "string", "example": "eth0"}, "switch_port_id": {"readOnly": true, "type": "string", "description": "This identifier is known to the Kubernetes API through LLDP advertisement from a switch.", "example": 18}, "ilo": {"oneOf": [{"type": "object", "description": "Object: Infrastructure host interface adapter common NIC object (iLO Amplifier)", "$ref": "#/definitions/host_ilo_amplifier_nic_common"}, {"type": "null"}], "description": "Object: Infrastructure host interface adapter common NIC object (iLO Amplifier)"}, "link_speed": {"readOnly": true, "type": ["number", "null"], "description": "Link speed in Mbps", "example": 10000}, "lag_uuid": {"oneOf": [{"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, {"type": "null"}], "description": "UUID of the associated Link Aggregation Group (known to the Composable Fabric Manager API), if one exists.", "example": "03734100-0458-0000-9ffa-6baf6416c429"}, "switch_name": {"readOnly": true, "type": "string", "description": "The name given to the Switch that this physical NIC is connected to (known to the Composable Fabric Manager API) if it can be resolved.", "example": "switch-01"}, "link_state": {"readOnly": true, "enum": ["up", "down"], "type": "string", "description": "The link state detected for this physical NIC by the Host."}, "switch_uuid": {"oneOf": [{"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, {"type": "null"}], "description": "UUID of the Switch that this physical NIC is connected to (known to the Composable Fabric Manager API), if it can be resolved.", "example": "03734100-0419-0000-0000-000000000001"}, "admin_status": {"readOnly": true, "enum": ["up", "down"], "type": "string", "description": "The administrative status for this physical NIC as configured on the Host."}, "mac_address": {"format": "mac_address", "description": "MAC Address", "example": "00:50:56:aa:bb:dd"}, "port_uuid": {"oneOf": [{"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, {"type": "null"}], "description": "UUID of the Switch Port that this physical NIC is connected to (known to the Composable Fabric Manager API), if it can be resolved.", "example": "03734100-040c-0000-399e-081dc0ca985b"}, "lag_name": {"readOnly": true, "type": "string", "description": "Name of the associated Link Aggregation Group, if one exists."}, "host_uuid": {"readOnly": true, "description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "00054518-c886-3a51-0002-000000000001"}, "switch_mac_address": {"format": "mac_address", "description": "MAC Address", "example": "00:50:56:aa:bb:dd"}}, "title": "Object: Infrastructure Host Network Interface (Kubernetes)"}, "host_nic_generic": {"additionalProperties": false, "required": [], "type": "object", "properties": {"link_state": {"readOnly": true, "enum": ["up", "down"], "type": "string", "description": "The link state detected for this physical NIC by the Host."}, "admin_status": {"enum": ["up", "down"], "type": "string", "description": "The administrative status for this physical NIC as known to the fabric (switch)."}, "connection_status": {"readOnly": true, "enum": ["active", "inactive", "unknown"], "type": "string", "description": "Current status of host NIC."}, "name": {"type": "string", "example": "host.hpe.com", "maxLength": 255}, "mac_address": {"format": "mac_address", "description": "MAC Address", "example": "00:50:56:aa:bb:dd"}, "ilo": {"oneOf": [{"type": "object", "description": "Object: Infrastructure host interface adapter common NIC object (iLO Amplifier)", "$ref": "#/definitions/host_ilo_amplifier_nic_common"}, {"type": "null"}], "description": "Object: Infrastructure host interface adapter common NIC object (iLO Amplifier)"}, "link_speed": {"readOnly": true, "type": ["number", "null"], "description": "Link speed in Mbps", "example": 10000}, "port_uuid": {"oneOf": [{"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, {"type": "null"}], "description": "UUID of the Switch Port to which this physical NIC is connected (known to the Composable Fabric Manager API)", "example": "03734100-040c-0000-399e-081dc0ca985b"}, "uuid": {"readOnly": true, "format": "ilo_object_uuid", "type": "string", "description": "An iLO Amplifier uuid reference", "example": "37383638-3430-4d32-3239-323330305459-nic-f4:03:43:bf:79:90"}}, "title": "Object: Host Nic (Generic)"}, "host_nutanix": {"additionalProperties": false, "required": ["cluster_name", "cluster_uuid", "cluster_version", "description", "host_name", "hypervisor_type", "name", "type", "uuid", "vendor"], "type": "object", "properties": {"vendor": {"enum": ["nutanix"], "type": "string"}, "description": {"type": "string", "example": ""}, "cluster_version": {"type": "string", "example": "5.0.0.1"}, "cluster_uuid": {"readOnly": true, "description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "00043518-d996-4c51-0003-000000000033"}, "vms": {"items": {"$ref": "#/definitions/vm_nutanix"}, "type": "array", "description": "Virtual Machines"}, "uuid": {"readOnly": true, "description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "00054518-c886-3a51-0002-000000000022"}, "name": {"type": "string", "example": "esxi-1.example.com"}, "vswitches": {"items": {"$ref": "#/definitions/vswitch"}, "type": "array", "description": "Virtual Switches"}, "nics": {"items": {"$ref": "#/definitions/host_nutanix_nic"}, "type": "array"}, "cluster_name": {"type": "string", "example": "Acropolis V"}, "host_name": {"type": "string", "example": "esxi-1"}, "hypervisor_type": {"enum": ["kvm"], "type": "string"}, "ilo": {"oneOf": [{"type": "object", "description": "Object: Infrastructure host interface adapter common object (iLO Amplifier)", "$ref": "#/definitions/host_ilo_amplifier_common"}, {"type": "null"}], "description": "Object: Infrastructure host interface adapter common object (iLO Amplifier)"}, "type": {"enum": ["hci"], "type": "string"}}, "title": "Object: Infrastructure Host (discovered by Nutanix pack)"}, "host_nutanix_nic": {"additionalProperties": false, "required": ["admin_status", "host_uuid", "link_state", "link_speed", "mac_address", "name", "switch_mac_address", "switch_port_id", "uuid"], "type": "object", "properties": {"port_uuid": {"oneOf": [{"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, {"type": "null"}], "description": "UUID of the Switch Port to which this physical NIC is connected (known to the Composable Fabric Manager API)", "example": "03734100-040c-0000-399e-081dc0ca985b"}, "switch_port_id": {"type": "string", "example": "1.1"}, "link_state": {"readOnly": true, "enum": ["up", "down"], "type": "string", "description": "The link state detected for this physical NIC by the Host."}, "link_speed": {"readOnly": true, "type": ["number", "null"], "description": "Link speed in Mbps", "example": 10000}, "host_uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "connection_status": {"readOnly": true, "enum": ["active", "inactive", "unknown"], "type": "string", "description": "Current status of host NIC."}, "name": {"type": "string", "example": "eth0"}, "ilo": {"oneOf": [{"type": "object", "description": "Object: Infrastructure host interface adapter common NIC object (iLO Amplifier)", "$ref": "#/definitions/host_ilo_amplifier_nic_common"}, {"type": "null"}], "description": "Object: Infrastructure host interface adapter common NIC object (iLO Amplifier)"}, "admin_status": {"enum": ["up", "down"], "type": "string", "description": "The administrative status for this physical NIC as known to the fabric (switch)."}, "mac_address": {"format": "mac_address", "description": "MAC Address", "example": "00:50:56:aa:bb:dd"}, "switch_mac_address": {"format": "mac_address", "description": "MAC Address", "example": "00:50:56:aa:bb:dd"}}, "title": "Object: Infrastructure Host Network Interface (Nutanix)"}, "host_patch_document": {"additionalProperties": false, "required": ["op", "path", "value"], "type": "object", "properties": {"path": {"type": "string", "description": "A JSON pointer."}, "from": {"type": "string", "description": "A string containing a JSON Pointer value."}, "value": {"anyOf": [{"type": "string"}, {"type": "integer"}, {"type": "array"}, {"type": "boolean"}], "description": "The value to be used within the operations. The value is of type integer, string, or boolean.", "example": "value"}, "op": {"enum": ["replace"], "type": "string", "description": "The operation to be performed."}}}, "host_patch_request": {"additionalProperties": false, "required": ["uuids", "patch"], "type": "object", "properties": {"uuids": {"items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array", "example": ["03734100040c000009b8ddaf67cf1ed5", "03734100040c00003bf5b6a5eeac65b9"]}, "patch": {"items": {"$ref": "#/definitions/host_patch_document"}, "type": "array", "example": [{"path": "/ilo/uid_indicator", "value": "on", "op": "replace"}]}}}, "host_simplivity": {"additionalProperties": false, "required": ["cluster_name", "host_moref", "name", "state", "uuid", "virtual_controller_name", "vsphere_uuid"], "type": "object", "properties": {"virtual_controller_name": {"type": "string", "description": "The name of the OmniStack Virtual Controller as seen in vSphere", "example": "OmniStackVC-172-18-101-73"}, "name": {"type": "string", "example": "omnistack10073.example.com"}, "host_moref": {"readOnly": true, "description": "vSphere Host Managed Object Reference (known to the vSphere API)", "format": "vsphere_moref", "type": "string", "example": "host-01"}, "cluster_name": {"type": "string", "example": "Simplivity-Local"}, "state": {"type": "string", "example": "ALIVE"}, "vsphere_uuid": {"readOnly": true, "description": "Identifies a unique vSphere (Virtual Center) instance (known to the vSphere API)", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "a3cb9e3a-127c-45b5-ada3-001b90b71bc2"}, "uuid": {"readOnly": true, "description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "fb260842-8075-4d57-7ec6-aa3784fe4ff7"}}, "title": "Object: Simplivity Host (discovered by Simplivity pack)"}, "host_vsphere": {"additionalProperties": false, "required": ["description", "domain_name", "host_name", "hypervisor_type", "moref", "name", "type", "uuid", "vsphere_uuid"], "type": "object", "properties": {"vendor": {"enum": ["simplivity", "vmware"], "type": "string"}, "description": {"type": "string", "example": ""}, "moref": {"readOnly": true, "description": "vSphere Host Managed Object Reference (known to the vSphere API)", "format": "vsphere_moref", "type": "string", "example": "host-01"}, "vms": {"items": {"$ref": "#/definitions/vm_vsphere"}, "type": "array"}, "name": {"type": "string", "example": "esxi-1.example.com"}, "uuid": {"readOnly": true, "description": "Hyphenated concatenation of the `vsphere_uuid` property and the `moref` property (known to the Composable Fabric Manager API)", "format": "uuid_based_moref", "type": "string", "example": "00044518-b776-2051-0001-000000000001-host-01"}, "vswitches": {"items": {"$ref": "#/definitions/vswitch"}, "type": "array"}, "nics": {"items": {"$ref": "#/definitions/host_vsphere_nic"}, "type": "array"}, "domain_name": {"type": "string", "example": "example.com"}, "vmkernel_adapters": {"items": {"$ref": "#/definitions/vmkernel_adapter"}, "type": "array"}, "host_name": {"type": "string", "example": "esxi-1"}, "hypervisor_type": {"enum": ["esxi"], "type": "string"}, "ilo": {"oneOf": [{"type": "object", "description": "Object: Infrastructure host interface adapter common object (iLO Amplifier)", "$ref": "#/definitions/host_ilo_amplifier_common"}, {"type": "null"}], "description": "Object: Infrastructure host interface adapter common object (iLO Amplifier)"}, "type": {"enum": ["compute", "vsan", "hci"], "type": "string"}, "vsphere_uuid": {"readOnly": true, "description": "Identifies a unique vSphere (Virtual Center) instance (known to the vSphere API)", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "00044518-b776-2051-0001-000000000001"}}, "title": "Object: Infrastructure Host (discovered by vSphere pack)"}, "host_vsphere_nic": {"additionalProperties": false, "required": ["dvswitch_moref", "host_moref", "mac_address", "moref", "name", "link_speed", "vswitch_moref", "uplink_port_key", "uplink_portgroup_key", "vsphere_uuid"], "type": "object", "properties": {"link_state": {"readOnly": true, "enum": ["up", "down"], "type": "string", "description": "The link state detected for this physical NIC by the Host."}, "moref": {"readOnly": true, "description": "vSphere Host Network Interface Managed Object Reference (known to the vSphere API)", "format": "vsphere_moref", "type": "string", "example": "host-01-pnic-vmnic1"}, "port_uuid": {"oneOf": [{"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, {"type": "null"}], "description": "UUID of the Switch Port to which this physical NIC is connected (known to the Composable Fabric Manager API)", "example": "03734100-040c-0000-399e-081dc0ca985b"}, "name": {"type": "string", "example": "vmnic1"}, "switch_port_id": {"type": "string", "description": "Port label of the Switch Port that this physical NIC is connected to (known to the Composable Fabric Manager API)", "example": "1.1"}, "ilo": {"oneOf": [{"type": "object", "description": "Object: Infrastructure host interface adapter common NIC object (iLO Amplifier)", "$ref": "#/definitions/host_ilo_amplifier_nic_common"}, {"type": "null"}], "description": "Object: Infrastructure host interface adapter common NIC object (iLO Amplifier)"}, "downlink_switch_port_id": {"type": "string", "description": "Label of the port on the downlink switch to which this physical NIC is connected, if applicable, and if it can be resolved.", "example": "Ethernet35"}, "host_moref": {"readOnly": true, "description": "vSphere Host Managed Object Reference (known to the vSphere API)", "format": "vsphere_moref", "type": "string", "example": "host-01"}, "downlink_switch_uuid": {"oneOf": [{"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, {"type": "null"}], "description": "UUID of the downlink switch to which this port is connected, if applicable, and if it can be resolved.", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "link_speed": {"readOnly": true, "type": ["number", "null"], "description": "Link speed in Mbps", "example": 10000}, "vswitch_moref": {"oneOf": [{"readOnly": true, "format": "vsphere_moref", "type": "string", "description": "A vSphere managed object reference", "example": "host-01-pnic-vmnic1"}, {"type": "null"}], "description": "vSphere Standard Virtual Switch Managed Object Reference (known to the vSphere API)", "example": "host-01-vswitch-vSwitch0"}, "admin_status": {"enum": ["up", "down"], "type": "string", "description": "The administrative status for this physical NIC as configured on the Host."}, "uplink_portgroup_key": {"type": "string", "example": ""}, "connection_status": {"readOnly": true, "enum": ["active", "inactive", "unknown"], "type": "string", "description": "Current status of host NIC."}, "dvswitch_moref": {"oneOf": [{"readOnly": true, "format": "vsphere_moref", "type": "string", "description": "A vSphere managed object reference", "example": "host-01-pnic-vmnic1"}, {"type": "null"}], "description": "vSphere Distributed Virtual Switch Managed Object Reference (known to the vSphere API)", "example": "dvs-01"}, "mac_address": {"format": "mac_address", "description": "MAC Address", "example": "00:50:56:aa:bb:dd"}, "uplink_port_key": {"type": "string", "example": ""}, "uuid": {"readOnly": true, "description": "Hyphenated concatenation of the `vsphere_uuid` property and the `moref` property (known to the Composable Fabric Manager API)", "format": "uuid_based_moref", "type": "string", "example": "00044518-b776-2051-0001-000000000001-pnic-vmnic1"}, "vsphere_uuid": {"readOnly": true, "description": "Identifies a unique vSphere (Virtual Center) instance (known to the vSphere API)", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "00044518-b776-2051-0001-000000000001"}, "switch_mac_address": {"format": "mac_address", "type": "string", "description": "MAC address of the Switch Port that this physical NIC is connected to (known to the Composable Fabric Manager API)", "example": "E0:39:D7:00:55:56"}}, "title": "Object: Infrastructure Host Network Interface (vSphere)"}, "igmp_snooping": {"required": ["igmp_snooping"], "type": "object", "properties": {"igmp_snooping": {"items": {"required": ["vlans", "ipv4_igmp_snooping", "ipv6_igmp_snooping"], "type": "object", "properties": {"vlans": {"example": "5, 10-20, 30, 40, 50-60", "type": "string", "description": "VLAN range(s)", "format": "vlan-range"}, "ipv4_igmp_snooping": {"required": ["enabled", "querier_timeout_seconds", "reporter_timeout_seconds"], "type": "object", "properties": {"querier_timeout_seconds": {"default": 126, "oneOf": [{"minimum": 1, "type": "integer", "example": 126}, {"type": "null"}], "description": "Timeout for querier to ask for an update. Default: 126", "example": 126}, "enabled": {"type": "boolean", "example": true}, "reporter_timeout_seconds": {"default": 261, "oneOf": [{"minimum": 1, "type": "integer", "example": 261}, {"type": "null"}], "description": "Timeout for reporter to send for response. Default: 261", "example": 261}}}, "ipv6_igmp_snooping": {"required": ["enabled", "querier_timeout_seconds", "reporter_timeout_seconds"], "type": "object", "properties": {"querier_timeout_seconds": {"default": 126, "oneOf": [{"minimum": 1, "type": "integer", "example": 126}, {"type": "null"}], "description": "Timeout for querier to ask for an update. Default: 126", "example": 126}, "enabled": {"type": "boolean", "example": true}, "reporter_timeout_seconds": {"default": 261, "oneOf": [{"minimum": 1, "type": "integer", "example": 261}, {"type": "null"}], "description": "Timeout for reporter to send for response. Default: 261", "example": 261}}}}}, "type": "array"}}}, "ilo_amplifier_pack_config": {"additionalProperties": false, "required": ["uuid", "host", "username", "verify_ssl", "enabled", "connection_state", "connection_fault_string", "last_connection", "cache_sync_status"], "type": "object", "properties": {"username": {"minLength": 1, "format": "non_empty_or_whitespace_string", "type": "string", "example": "admin", "maxLength": 200}, "connection_state": {"readOnly": true, "enum": ["created", "deleted", "disabled", "disconnected", "degraded", "connected"], "type": "string", "description": "Indicates the state of the connection to HPE iLO Amplifier", "example": "disconnected"}, "last_connection": {"readOnly": true, "example": "1497902632", "type": "integer", "description": "UTC epoch time of last successful connection", "format": "int64"}, "description": {"type": "string", "example": "", "maxLength": 1000}, "host": {"description": "Hostname or IP address of HPE iLO Amplifier", "format": "hostname", "minLength": 2, "maxLength": 200, "type": "string", "example": "iloamplifier.example.com"}, "name": {"format": "non_empty_or_whitespace_string", "type": "string", "example": "My HPE iLO Amplifier Configuration", "maxLength": 200}, "uuid": {"minLength": 32, "readOnly": true, "type": "string", "example": "14cb7b0264e048a4b7c46fd3c6ae100b", "maxLength": 36}, "enabled": {"default": true, "type": "boolean", "description": "Indicates whether this configuration should be enabled", "example": true}, "verify_ssl": {"default": false, "type": "boolean", "description": "Indicates whether SSL/TLS certificates should be validated when connecting to HPE iLO Amplifier", "example": false}, "connection_fault_string": {"readOnly": true, "type": "string", "example": "Connection error message if not connected"}, "cache_sync_status": {"type": "object", "description": "Cache Sync Status provides information related to the state of the pack's object cache. It provides if a cache build is in progress, the reason why it is building, and the start and end times of the cache build process. At the start of a cache build, cache_sync_start is set to the current time, while cache_sync_complete is set to zero. At the completion of the cache build, cache_sync_complete is updated with the current time.", "properties": {"cache_sync": {"default": false, "readOnly": true, "type": "boolean", "description": "Indicates if a cache sync is in progress", "example": false}, "cache_sync_reason": {"readOnly": true, "enum": ["upgrade", "sensor_restart", "timer_expiration", "connection_reestablished"], "type": "string", "description": "Indicates the reason why a cache sync occurred", "example": "upgrade"}, "cache_sync_start": {"readOnly": true, "example": "1497902632", "type": "integer", "description": "UTC epoch time of cache sync start", "format": "int64"}, "cache_sync_complete": {"readOnly": true, "example": "1497902632", "type": "integer", "description": "UTC epoch time of cache sync complete", "format": "int64"}}}, "pack": {"readOnly": true, "type": "string", "example": "Pack type"}}, "title": "Object: HPE iLO Amplifier Pack Configuration"}, "ilo_amplifier_pack_config_create": {"additionalProperties": false, "required": ["host", "username", "verify_ssl", "enabled", "password"], "type": "object", "properties": {"username": {"minLength": 1, "maxLength": 200, "type": "string", "example": "admin", "format": "non_empty_or_whitespace_string"}, "password": {"minLength": 1, "maxLength": 200, "type": "string", "format": "password"}, "verify_ssl": {"default": false, "type": "boolean", "description": "Indicates whether SSL/TLS certificates should be validated when connecting to HPE iLO Amplifier", "example": false}, "description": {"type": "string", "example": "", "maxLength": 1000}, "enabled": {"default": true, "type": "boolean", "description": "Indicates whether this configuration should be enabled", "example": true}, "host": {"description": "Hostname or IP address of HPE iLO Amplifier", "format": "hostname", "minLength": 2, "maxLength": 200, "type": "string", "example": "iloamplifier.example.com"}, "pack": {"readOnly": true, "type": "string", "example": "Pack type"}, "name": {"maxLength": 200, "type": "string", "example": "My HPE iLO Amplifier Configuration", "format": "non_empty_or_whitespace_string"}}, "title": "Object: HPE iLO Amplifier Pack Configuration (create)"}, "ilo_amplifier_pack_config_update": {"additionalProperties": false, "type": "object", "properties": {"username": {"minLength": 1, "format": "non_empty_or_whitespace_string", "type": "string", "example": "admin", "maxLength": 200}, "description": {"type": "string", "example": "", "maxLength": 1000}, "enabled": {"default": true, "type": "boolean", "description": "Indicates whether this configuration should be enabled", "example": true}, "host": {"description": "Hostname or IP address of HPE iLO Amplifier", "format": "hostname", "minLength": 2, "maxLength": 200, "type": "string", "example": "iloamplifier.example.com"}, "name": {"format": "non_empty_or_whitespace_string", "type": "string", "example": "My HPE iLO Amplifier Configuration", "maxLength": 200}, "verify_ssl": {"default": false, "type": "boolean", "description": "Indicates whether SSL/TLS certificates should be validated when connecting to HPE iLO Amplifier", "example": false}, "password": {"minLength": 1, "format": "password", "type": "string", "maxLength": 200}, "pack": {"readOnly": true, "type": "string", "example": "Pack type"}}, "title": "Object: HPE iLO Amplifier Pack Configuration (update)"}, "ilo_amplifier_pack_config_verify": {"additionalProperties": false, "required": ["host", "username", "verify_ssl", "enabled", "password"], "type": "object", "properties": {"username": {"minLength": 1, "format": "non_empty_or_whitespace_string", "type": "string", "example": "admin", "maxLength": 200}, "description": {"type": "string", "example": "", "maxLength": 1000}, "enabled": {"default": true, "type": "boolean", "description": "Indicates whether this configuration should be enabled", "example": true}, "host": {"description": "Hostname or IP address of HPE iLO Amplifier", "format": "hostname", "minLength": 2, "maxLength": 200, "type": "string", "example": "iloamplifier.example.com"}, "name": {"type": "string", "example": "My HPE iLO Amplifier Configuration", "maxLength": 200}, "verify_ssl": {"default": false, "type": "boolean", "description": "Indicates whether SSL/TLS certificates should be validated when connecting to HPE iLO Amplifier", "example": false}, "password": {"minLength": 1, "format": "password", "type": "string", "maxLength": 200}, "pack": {"readOnly": true, "type": "string", "example": "Pack type"}}, "title": "Object: HPE iLO Amplifier Pack Configuration (verify)"}, "integration": {"additionalProperties": false, "required": ["author", "description", "email", "keywords", "name", "version", "features"], "type": "object", "properties": {"version": {"type": "string", "example": "5.0.0"}, "features": {"items": {"type": "string"}, "type": "array", "description": "List of configured features for this pack type."}, "description": {"type": "string", "example": "Pack integrated with HPE Simplivity"}, "author": {"type": "string", "example": "Hewlett Packard Enterprise"}, "keywords": {"items": {"type": "string"}, "type": "array", "description": "Integration keywords", "example": ["hpe", "simplivity"]}, "configurations": {"items": {"oneOf": [{"$ref": "#/definitions/kubernetes_pack_config"}, {"$ref": "#/definitions/nutanix_pack_config"}, {"$ref": "#/definitions/vsphere_pack_config"}, {"$ref": "#/definitions/nsx_pack_config"}, {"$ref": "#/definitions/simplivity_pack_config"}, {"$ref": "#/definitions/oneview_pack_config"}, {"$ref": "#/definitions/ilo_amplifier_pack_config"}]}, "type": "array", "description": "List of configured packs of a particular type.\nDepending on type of pack, can be one of:\n* Object: HPE OneView Pack Configuration\n* Object: HPE Simplivity Pack Configuration\n* Object: HPE iLO Amplifier Pack Configuration\n* Object: Kubernetes Master Pack Configuration\n* Object: Nutanix Prism Pack Configuration\n* Object: VMware NSX Pack Configuration\n* Object: VMware vSphere Pack Configuration"}, "email": {"type": "string", "description": "Author email", "example": ""}, "name": {"type": "string", "example": "simplivity"}}, "title": "Object: Composable Fabric Manager Integration Pack"}, "integration_schema": {"type": "object", "properties": {"x-base-path": {"type": "string", "example": "hpe/simplivitys"}, "required": {"type": "string", "example": ["host", "username", "password", "verify_ssl", "enabled"]}, "title": {"type": "string", "example": "HPE Simplivity"}, "additionalProperties": {"type": "boolean", "example": false}, "items": {"type": "object", "properties": {"type": {"type": "string", "example": "object"}, "properties": {"type": "object", "properties": {"username": {"type": "object", "properties": {"minLength": {"type": "integer", "example": 3}, "format": {"type": "non_empty_or_whitespace_string", "example": "admin"}, "title": {"type": "string", "example": "Username"}, "type": {"type": "string", "example": "string"}, "maxLength": {"type": "integer", "example": 200}}}, "host": {"type": "object", "properties": {"description": {"type": "string", "example": "Hostname or IP address of HPE Simplivity"}, "format": {"type": "string", "example": "hostname"}, "minLength": {"type": "integer", "example": 3}, "maxLength": {"type": "integer", "example": 200}, "unique": {"type": "boolean", "example": true}, "type": {"type": "string", "example": "string"}}}, "password": {"type": "object", "properties": {"minLength": {"type": "integer", "example": 3}, "secret": {"type": "boolean", "example": true}, "maxLength": {"type": "integer", "example": 200}, "type": {"type": "string", "example": "string"}, "format": {"type": "string", "example": "password"}}}, "enabled": {"type": "object", "properties": {"default": {"type": "boolean", "example": true}, "type": {"type": "string", "example": "boolean"}, "description": {"type": "string", "example": "Indicates whether this configuration should be enabled"}, "format": {"type": "string", "example": "password"}}}, "verify_ssl": {"type": "object", "properties": {"type": {"type": "string", "example": "boolean"}, "description": {"type": "string", "example": "Indicates whether SSL/TLS certificates should be validated when connecting to HPE Simplivity"}}}}}, "title": {"type": "string", "example": "Configuration"}}}, "$schema": {"type": "string", "example": "http://json-schema.org/schema#"}, "maxLength": {"type": "integer", "example": 10}, "type": {"type": "string", "example": "array"}}, "title": "Object: Integration Schema"}, "integration_set": {"additionalProperties": false, "required": ["name", "description", "is_selected", "integrations", "uuid"], "type": "object", "properties": {"uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "is_selected": {"readOnly": true, "type": "boolean", "description": "Selection state", "example": true}, "integrations": {"items": {"type": "object", "properties": {"additionalProperties": false, "required": ["name", "features"], "name": {"readOnly": true, "type": "string", "description": "Integration name.", "example": "vsphere"}, "features": {"items": {"type": "string"}, "readOnly": true, "type": "array"}}}, "type": "array", "description": "List of integrations for this deployment"}, "name": {"type": "string", "example": "Composable Rack"}, "description": {"type": "string", "example": "HPE Composable Rack Deployment"}}, "title": "Object: Composable Fabric Manager Integration Set"}, "integration_set_patch_document": {"additionalProperties": false, "required": ["op", "path", "value"], "type": "object", "properties": {"path": {"type": "string", "description": "A JSON pointer."}, "from": {"type": "string", "description": "A string containing a JSON Pointer value."}, "value": {"anyOf": [{"type": "string"}, {"type": "integer"}, {"type": "array"}, {"type": "boolean"}], "description": "The value to be used within the operations. The value is of type integer, string, or boolean.", "example": "value"}, "op": {"enum": ["replace"], "type": "string", "description": "The operation to be performed."}}}, "integration_set_patch_request": {"additionalProperties": false, "required": ["uuids", "patch"], "type": "object", "properties": {"uuids": {"items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array", "example": ["03734100040c000009b8ddaf67cf1ed5"]}, "patch": {"items": {"$ref": "#/definitions/integration_set_patch_document"}, "type": "array", "example": [{"path": "/is_selected", "value": true, "op": "replace"}]}}}, "ip_interfaces": {"additionalProperties": false, "required": ["uuid", "if_type", "name"], "type": "object", "properties": {"enable": {"default": true, "type": "boolean", "description": "Enable this IP Interface", "example": true}, "description": {"type": "string", "example": "Description of my IP Interface"}, "ipv4_secondary_addresses": {"items": {"required": ["address", "prefix_length"], "type": "object", "properties": {"prefix_length": {"minimum": 0, "type": "integer", "maximum": 32, "example": 24}, "address": {"type": "string", "example": "172.10.10.10", "format": "ipv4"}}}, "type": "array"}, "vlan": {"minimum": 0, "type": "integer", "maximum": 4000, "example": 10}, "ipv6_ra_lifetime": {"example": 180, "minimum": 0, "type": "integer", "description": "IPv6 Router Advertisement Interval in seconds", "maximum": 9000}, "ipv6_addresses": {"items": {"required": ["address", "prefix_length"], "type": "object", "properties": {"anycast": {"default": false, "type": "boolean", "example": false}, "prefix_length": {"minimum": 0, "type": "integer", "maximum": 128, "example": 64}, "address": {"type": "string", "example": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", "format": "ipv6"}}}, "type": "array"}, "switch_uuid": {"readOnly": false, "description": "UUID of the Switch on which this IP Interface is configured.", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "ipv4_primary_address": {"required": ["address", "prefix_length"], "type": "object", "properties": {"prefix_length": {"minimum": 0, "type": "integer", "maximum": 32, "example": 24}, "address": {"type": "string", "example": "172.10.10.10", "format": "ipv4"}}}, "name": {"maxLength": 43, "type": "string", "example": "My IP Interface", "format": "non_empty_or_whitespace_string"}, "ipv6_reachable_time": {"example": 25000, "minimum": 0, "type": "integer", "description": "IPv6 advertised reachability time in milliseconds", "maximum": 3600000}, "uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "ipv6_ra_interval": {"example": 60, "minimum": 4, "type": "integer", "description": "IPv6 Router Advertisement Interval in seconds", "maximum": 1800}, "lag_uuid": {"readOnly": false, "description": "UUID of the LAG on which this IP Interface is configured.", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "operational_state": {"readOnly": true, "enum": ["up", "down", "unknown"], "type": "string", "description": "Operational state of this IP Interface", "example": "down"}, "if_type": {"enum": ["routed", "vlan", "loopback"], "type": "string"}}, "title": "Object: IP Interfaces"}, "ip_interfaces_create": {"items": {"additionalProperties": false, "required": ["if_type", "name"], "type": "object", "properties": {"ipv6_reachable_time": {"minimum": 0, "type": "integer", "example": 25000, "maximum": 3600000, "description": "IPv6 advertised reachability time in milliseconds"}, "enable": {"default": true, "type": "boolean", "description": "Enable this IP Interface", "example": true}, "description": {"type": "string", "example": "Description of my IP Interface"}, "ipv4_secondary_addresses": {"items": {"required": ["address", "prefix_length"], "type": "object", "properties": {"prefix_length": {"minimum": 0, "type": "integer", "maximum": 32, "example": 24}, "address": {"type": "string", "example": "172.10.10.10", "format": "ipv4"}}}, "type": "array"}, "ipv6_ra_interval": {"minimum": 4, "type": "integer", "example": 60, "maximum": 1800, "description": "IPv6 Router Advertisement Interval in seconds"}, "vlan": {"minimum": 0, "type": "integer", "maximum": 4000, "example": 10}, "ipv6_ra_lifetime": {"minimum": 0, "type": "integer", "example": 180, "maximum": 9000, "description": "IPv6 Router Advertisement Interval in seconds"}, "lag_uuid": {"description": "UUID of the LAG on which this IP Interface is configured.", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": false, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "operational_state": {"readOnly": true, "enum": ["up", "down", "unknown"], "type": "string", "description": "Operational state of this IP Interface", "example": "down"}, "ipv6_addresses": {"items": {"required": ["address", "prefix_length"], "type": "object", "properties": {"anycast": {"default": false, "type": "boolean", "example": false}, "prefix_length": {"minimum": 0, "type": "integer", "maximum": 128, "example": 64}, "address": {"type": "string", "example": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", "format": "ipv6"}}}, "type": "array"}, "switch_uuid": {"description": "UUID of the Switch on which this IP Interface is configured.", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": false, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "ipv4_primary_address": {"required": ["address", "prefix_length"], "type": "object", "properties": {"prefix_length": {"minimum": 0, "type": "integer", "maximum": 32, "example": 24}, "address": {"type": "string", "example": "172.10.10.10", "format": "ipv4"}}}, "if_type": {"enum": ["routed", "vlan", "loopback"], "type": "string"}, "name": {"format": "non_empty_or_whitespace_string", "type": "string", "example": "My IP Interface", "maxLength": 43}}, "title": "Object: IP Interfaces"}, "type": "array", "title": "Object: IP Interface (create)"}, "ip_interfaces_update": {"additionalProperties": false, "required": ["if_type", "name"], "type": "object", "properties": {"ipv6_reachable_time": {"minimum": 0, "type": "integer", "example": 25000, "maximum": 3600000, "description": "IPv6 advertised reachability time in milliseconds"}, "enable": {"default": true, "type": "boolean", "description": "Enable this IP Interface", "example": true}, "description": {"type": "string", "example": "Description of my IP Interface"}, "ipv4_secondary_addresses": {"items": {"required": ["address", "prefix_length"], "type": "object", "properties": {"prefix_length": {"minimum": 0, "type": "integer", "maximum": 32, "example": 24}, "address": {"type": "string", "example": "172.10.10.10", "format": "ipv4"}}}, "type": "array"}, "ipv6_ra_interval": {"minimum": 4, "type": "integer", "example": 60, "maximum": 1800, "description": "IPv6 Router Advertisement Interval in seconds"}, "vlan": {"minimum": 0, "type": "integer", "maximum": 4000, "example": 10}, "ipv6_ra_lifetime": {"minimum": 0, "type": "integer", "example": 180, "maximum": 9000, "description": "IPv6 Router Advertisement Interval in seconds"}, "lag_uuid": {"description": "UUID of the LAG on which this IP Interface is configured.", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": false, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "operational_state": {"readOnly": true, "enum": ["up", "down", "unknown"], "type": "string", "description": "Operational state of this IP Interface", "example": "down"}, "ipv6_addresses": {"items": {"required": ["address", "prefix_length"], "type": "object", "properties": {"anycast": {"default": false, "type": "boolean", "example": false}, "prefix_length": {"minimum": 0, "type": "integer", "maximum": 128, "example": 64}, "address": {"type": "string", "example": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", "format": "ipv6"}}}, "type": "array"}, "switch_uuid": {"description": "UUID of the Switch on which this IP Interface is configured.", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": false, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "ipv4_primary_address": {"required": ["address", "prefix_length"], "type": "object", "properties": {"prefix_length": {"minimum": 0, "type": "integer", "maximum": 32, "example": 24}, "address": {"type": "string", "example": "172.10.10.10", "format": "ipv4"}}}, "if_type": {"enum": ["routed", "vlan", "loopback"], "type": "string"}, "name": {"format": "non_empty_or_whitespace_string", "type": "string", "example": "My IP Interface", "maxLength": 43}}, "title": "Object: IP Interface (update)"}, "ip_prefix_list": {"additionalProperties": false, "required": ["name", "ip_prefixes"], "type": "object", "properties": {"ip_prefixes": {"items": {"required": ["address", "action"], "type": "object", "properties": {"action": {"enum": ["permit", "deny"], "type": "string", "description": "Action to take for matching prefixes", "example": "permit"}, "ge": {"example": 26, "minimum": 0, "type": "integer", "description": "Prefix minimum match length, 0 for unspecified. Must be greater than initial prefix length", "maximum": 32}, "le": {"example": 28, "minimum": 0, "type": "integer", "description": "Prefix maximum match length, 0 for unspecified", "maximum": 64}, "seq": {"example": 2, "minimum": 1, "type": "integer", "description": "List entry sequence number", "maximum": 65535}, "address": {"oneOf": [{"required": ["address", "prefix_length"], "type": "object", "properties": {"prefix_length": {"minimum": 0, "type": "integer", "maximum": 128, "example": 24}, "address": {"oneOf": [{"format": "ipv4"}, {"format": "ipv6"}], "type": "string", "example": "172.10.10.0"}}}, {"enum": ["any"], "type": "string", "description": "Address matching option", "example": "any"}], "description": "IP prefix and prefix length to match, or 'any'", "example": "{ 'address': '10.10.10.0', 'prefix_length': 24 }"}}}, "type": "array", "description": "List of IP prefixes and actions"}, "uuid": {"readOnly": true, "description": "Prefix List UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "name": {"format": "non_empty_or_whitespace_string", "type": "string", "example": "My IP Prefix List", "maxLength": 256}, "description": {"type": "string", "example": "Description of my IP Prefix List"}}, "title": "Object: IP Prefix List"}, "ip_prefix_list_create": {"additionalProperties": false, "required": ["name", "ip_prefixes"], "type": "object", "properties": {"ip_prefixes": {"items": {"required": ["address", "action"], "type": "object", "properties": {"action": {"enum": ["permit", "deny"], "type": "string", "description": "Action to take for matching prefixes", "example": "permit"}, "ge": {"minimum": 0, "type": "integer", "example": 26, "maximum": 32, "description": "Prefix minimum match length, 0 for unspecified. Must be greater than initial prefix length"}, "le": {"minimum": 0, "type": "integer", "example": 28, "maximum": 64, "description": "Prefix maximum match length, 0 for unspecified"}, "seq": {"minimum": 1, "type": "integer", "example": 2, "maximum": 65535, "description": "List entry sequence number"}, "address": {"oneOf": [{"required": ["address", "prefix_length"], "type": "object", "properties": {"prefix_length": {"minimum": 0, "type": "integer", "maximum": 128, "example": 24}, "address": {"oneOf": [{"format": "ipv4"}, {"format": "ipv6"}], "type": "string", "example": "172.10.10.0"}}}, {"enum": ["any"], "type": "string", "description": "Address matching option", "example": "any"}], "description": "IP prefix and prefix length to match, or 'any'", "example": "{ 'address': '10.10.10.0', 'prefix_length': 24 }"}}}, "type": "array", "description": "List of IP prefixes and actions"}, "description": {"type": "string", "example": "Description of my IP Prefix List"}, "name": {"maxLength": 256, "type": "string", "example": "My IP Prefix List", "format": "non_empty_or_whitespace_string"}}, "title": "Object: IP Prefix List (create)"}, "ip_prefix_list_update": {"additionalProperties": false, "required": ["name", "ip_prefixes", "description"], "type": "object", "properties": {"ip_prefixes": {"items": {"required": ["address", "action"], "type": "object", "properties": {"action": {"enum": ["permit", "deny"], "type": "string", "description": "Action to take for matching prefixes", "example": "permit"}, "ge": {"minimum": 0, "type": "integer", "example": 26, "maximum": 32, "description": "Prefix minimum match length, 0 for unspecified. Must be greater than initial prefix length"}, "le": {"minimum": 0, "type": "integer", "example": 28, "maximum": 64, "description": "Prefix maximum match length, 0 for unspecified"}, "seq": {"minimum": 1, "type": "integer", "example": 2, "maximum": 65535, "description": "List entry sequence number"}, "address": {"oneOf": [{"required": ["address", "prefix_length"], "type": "object", "properties": {"prefix_length": {"minimum": 0, "type": "integer", "maximum": 128, "example": 24}, "address": {"oneOf": [{"format": "ipv4"}, {"format": "ipv6"}], "type": "string", "example": "172.10.10.0"}}}, {"enum": ["any"], "type": "string", "description": "Address matching option", "example": "any"}], "description": "IP prefix and prefix length to match, or 'any'", "example": "{ 'address': '10.10.10.0', 'prefix_length': 24 }"}}}, "type": "array", "description": "List of IP prefixes and actions"}, "description": {"type": "string", "example": "Description of my IP Prefix List"}, "uuid": {"description": "Prefix List UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "name": {"maxLength": 256, "type": "string", "example": "My IP Prefix List", "format": "non_empty_or_whitespace_string"}}, "title": "Object: IP Prefix List (update)"}, "ip_static_route": {"additionalProperties": false, "required": ["destination", "next_hop", "uuid"], "type": "object", "properties": {"distance": {"description": "Administrative distance of the static route", "default": 0, "maximum": 255, "minimum": 1, "type": "integer", "example": 1}, "next_hop": {"oneOf": [{"type": "string", "format": "ipv4"}, {"type": "string", "format": "ipv6"}, {"type": "null"}], "description": "A next hop of 0.0.0.0 signifies that the destination network in the static route should use the default route. A next hop of null indicates traffic matching the destination network will be discarded and is used to prevent routing loops.", "example": "172.10.10.0"}, "uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "switch_uuids": {"items": {"readOnly": true, "description": "UUID of switches on which this route is configured. Empty if route has fabric scope", "format": "uuid_opt_hyphenated", "minLength": 32, "readyOnly": false, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array"}, "description": {"type": "string", "example": ""}, "destination": {"required": ["address", "prefix_length"], "type": "object", "properties": {"prefix_length": {"minimum": 0, "type": "integer", "maximum": 128, "example": 24}, "address": {"oneOf": [{"format": "ipv4"}, {"format": "ipv6"}], "type": "string", "example": "172.10.10.0"}}}, "tag": {"description": "Static route tag, used to control redistribution", "default": 0, "maximum": 4294967295, "minimum": 0, "type": "integer", "example": 100}, "name": {"type": "string", "example": "My Static Route"}}, "title": "Object: IP Static Route"}, "ip_static_route_create": {"items": {"additionalProperties": false, "required": ["destination", "next_hop"], "type": "object", "properties": {"distance": {"description": "Administrative distance of the static route", "default": 0, "maximum": 255, "minimum": 1, "type": "integer", "example": 1}, "description": {"type": "string", "example": ""}, "destination": {"required": ["address", "prefix_length"], "type": "object", "properties": {"prefix_length": {"minimum": 0, "type": "integer", "maximum": 128, "example": 24}, "address": {"oneOf": [{"format": "ipv4"}, {"format": "ipv6"}], "type": "string", "example": "172.10.10.0"}}}, "tag": {"description": "Static route tag, used to control redistribution", "default": 0, "maximum": 4294967295, "minimum": 0, "type": "integer", "example": 100}, "name": {"type": "string", "example": "My Static Route"}, "switch_uuids": {"items": {"description": "UUID of switches on which this route is configured. Empty if route has fabric scope", "format": "uuid_opt_hyphenated", "minLength": 32, "readyOnly": false, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array"}, "next_hop": {"oneOf": [{"type": "string", "format": "ipv4"}, {"type": "string", "format": "ipv6"}, {"type": "null"}], "description": "A next hop of 0.0.0.0 signifies that the destination network in the static route should use the default route. A next hop of null indicates traffic matching the destination network will be discarded and is used to prevent routing loops.", "example": "172.10.10.0"}}, "title": "Object: IP Static Route (create)"}, "type": "array"}, "ip_static_route_update": {"additionalProperties": false, "required": ["destination", "next_hop"], "type": "object", "properties": {"distance": {"description": "Administrative distance of the static route", "default": 0, "maximum": 255, "minimum": 1, "type": "integer", "example": 1}, "description": {"type": "string", "example": ""}, "destination": {"required": ["address", "prefix_length"], "type": "object", "properties": {"prefix_length": {"minimum": 0, "type": "integer", "maximum": 128, "example": 24}, "address": {"oneOf": [{"format": "ipv4"}, {"format": "ipv6"}], "type": "string", "example": "172.10.10.0"}}}, "tag": {"description": "Static route tag, used to control redistribution", "default": 0, "maximum": 4294967295, "minimum": 0, "type": "integer", "example": 100}, "name": {"type": "string", "example": "My Static Route"}, "switch_uuids": {"items": {"description": "UUID of switches on which this route is configured. Empty if route has fabric scope", "format": "uuid_opt_hyphenated", "minLength": 32, "readyOnly": false, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array"}, "next_hop": {"oneOf": [{"type": "string", "format": "ipv4"}, {"type": "string", "format": "ipv6"}, {"type": "null"}], "description": "A next hop of 0.0.0.0 signifies that the destination network in the static route should use the default route. A next hop of null indicates traffic matching the destination network will be discarded and is used to prevent routing loops.", "example": "172.10.10.0"}}, "title": "Object: IP Static Route (update)"}, "ip_svi": {"additionalProperties": false, "required": ["primary_address", "secondary_addresses", "vlan", "uuid"], "type": "object", "properties": {"secondary_addresses": {"items": {"required": ["address", "prefix_length"], "type": "object", "properties": {"prefix_length": {"minimum": 0, "type": "integer", "maximum": 128, "example": 24}, "address": {"oneOf": [{"format": "ipv4"}, {"format": "ipv6"}], "type": "string", "example": "172.10.10.0"}}}, "type": "array"}, "description": {"type": "string", "example": ""}, "vlan": {"minimum": 0, "type": "integer", "maximum": 4000, "example": 10}, "name": {"type": "string"}, "primary_address": {"required": ["address", "prefix_length"], "type": "object", "properties": {"prefix_length": {"minimum": 0, "type": "integer", "maximum": 128, "example": 24}, "address": {"oneOf": [{"format": "ipv4"}, {"format": "ipv6"}], "type": "string", "example": "172.10.10.0"}}}, "uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}}, "title": "Object: IP Switched Virtual Interface"}, "ip_tables_arp": {"additionalProperties": false, "required": ["interface", "ip_address", "mac_address", "switch_name", "type"], "type": "object", "properties": {"last_modified_time": {"minLength": 9, "description": "Time of last modification (seconds since epoch)", "type": "integer", "example": "1497602656", "maxLength": 11}, "type": {"items": {"enum": ["DISCARD", "INCOMPLETE", "LEARNED", "LOCAL", "LOOPBACK", "NEXTHOP"], "type": "string", "example": "LEARNED"}, "type": "array"}, "switch_uuid": {"readOnly": true, "description": "UUID of the switch on which this ARP table entry resides.", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "mac_address": {"example": "ab:cd:ef:01:02:03", "type": "string", "description": "MAC address", "format": "mac_address"}, "interface": {"type": "string", "example": "routerchannel"}, "ip_address": {"oneOf": [{"format": "ipv4"}, {"format": "ipv6"}], "type": "string", "example": "192.168.1.1"}, "creation_time": {"minLength": 9, "description": "Time of creation (seconds since epoch)", "type": "integer", "example": "1497602656", "maxLength": 11}, "switch_name": {"type": "string", "example": "host.hpe.com", "maxLength": 255}}, "title": "ARP table entry"}, "ip_tables_ip_route": {"additionalProperties": false, "required": ["connected", "destination", "dmt", "is_last_resort", "next_hop_info", "route_sub_type", "route_type", "switch_uuid"], "type": "object", "properties": {"route_type": {"enum": ["kernel", "connected", "static", "RIP", "BGP", "OSPF", "IS-IS", "not_applicable"], "type": "string", "example": "OSPF"}, "metric": {"type": "integer", "example": 0}, "switch_uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "tag": {"description": "Route tag, used to control redistribution", "default": 0, "maximum": 4294967295, "minimum": 0, "type": "integer", "example": 100}, "connected": {"type": "boolean", "example": true}, "next_hop_info": {"type": "object", "properties": {"is_nexthop_inactive": {"enum": ["true", "false", "not_applicable"], "type": "string", "example": "false", "description": "Can be not_applicable, true, or false"}, "uptime": {"type": "integer", "description": "Time in seconds", "example": 1664}, "next_hop": {"type": "string", "example": "172.0.30.4", "description": "IP route next hop address: IP address or \u2018null0\u2019"}, "is_arp_unresolved": {"enum": ["true", "false", "not_applicable"], "type": "string", "example": "false", "description": "Can be not_applicable, true, or false"}, "path": {"enum": ["directly_connected", "incomplete", "summary", "via_nexthop", "not_applicable"], "type": "string", "example": "directly_connected", "description": "Path can be via_nexthop, incomplete, directly_connected, summary and not_applicable"}, "recursive_nexthops": {"items": {"type": "object", "properties": {"is_nexthop_inactive": {"enum": ["true", "false", "not_applicable"], "type": "string", "example": "false", "description": "Can be not_applicable, true, or false"}, "mpls_next_hop": {"type": "boolean", "example": false, "description": "true/false indication as to whether this is an mpls next hop or not"}, "is_blackhole": {"enum": ["true", "false", "not_applicable"], "type": "string", "example": "false", "description": "Can be not_applicable, true, or false"}, "next_hop": {"type": "string", "example": "172.0.30.4", "description": "IP route next hop address: IP address or \u2018null0\u2019"}, "is_arp_unresolved": {"enum": ["true", "false", "not_applicable"], "type": "string", "example": "false", "description": "Can be not_applicable, true, or false"}, "path": {"enum": ["directly_connected", "incomplete", "summary", "via_nexthop", "not_applicable"], "type": "string", "example": "directly_connected", "description": "Path can be via_nexthop, incomplete, directly_connected, summary and not_applicable"}, "interface_name": {"type": "string", "example": "Loopback Interface"}}}, "type": "array"}, "interface_name": {"type": "string", "example": "Loopback Interface"}, "is_blackhole": {"enum": ["true", "false", "not_applicable"], "type": "string", "example": "false", "description": "Can be not_applicable, true, or false"}, "mpls_next_hop": {"type": "boolean", "example": false, "description": "true/false indication as to whether this is an mpls next hop or not"}}}, "route_sub_type": {"enum": ["NSSA_external_type_1", "NSSA_external_type_2", "external_type_1", "external_type_2", "level-1", "level-2", "inter_area", "not_applicable"], "type": "string", "example": "external_type_1"}, "distance": {"minimum": 0, "type": "integer", "description": "Ip route distance between 1 - 255 where 0 indicates not applicable", "maximum": 255, "example": 1}, "destination": {"required": ["address", "prefix_length"], "type": "object", "properties": {"prefix_length": {"minimum": 0, "type": "integer", "maximum": 128, "example": 24}, "address": {"oneOf": [{"format": "ipv4"}, {"format": "ipv6"}], "type": "string", "example": "172.10.10.0"}}}, "switch_name": {"type": "string", "example": "host.hpe.com", "maxLength": 255}, "is_last_resort": {"enum": ["true", "false", "not_applicable"], "type": "string", "example": "false", "description": "Can be not_applicable, true, or false"}}, "title": "IP route table entry"}, "kubernetes_pack_config": {"additionalProperties": false, "required": ["uuid", "host", "username", "verify_ssl", "enabled", "openshift", "connection_state", "connection_fault_string", "last_connection", "cache_sync_status"], "type": "object", "properties": {"username": {"minLength": 1, "format": "non_empty_or_whitespace_string", "type": "string", "example": "admin", "maxLength": 200}, "connection_state": {"readOnly": true, "enum": ["created", "deleted", "disabled", "disconnected", "degraded", "connected"], "type": "string", "description": "Indicates the state of the connection to Nutanix Prism", "example": "disconnected"}, "last_connection": {"minLength": 9, "description": "UTC epoch time of last successful connection", "type": "integer", "example": "1497602656", "maxLength": 11}, "description": {"type": "string", "maxLength": 1000}, "host": {"description": "Hostname or IP address of Kubernetes Master", "format": "hostname", "minLength": 2, "maxLength": 200, "type": "string", "example": "os.example.com"}, "port": {"default": 8443, "type": "integer", "description": "Kubernetes Master API Server Port", "example": 8443}, "name": {"format": "non_empty_or_whitespace_string", "type": "string", "example": "My Kubernetes Configuration", "maxLength": 200}, "uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "enabled": {"default": true, "type": "boolean", "description": "Indicates whether this configuration should be enabled", "example": true}, "verify_ssl": {"default": false, "type": "boolean", "description": "Indicates whether SSL/TLS certificates should be validated when connecting to Kubernetes Master", "example": false}, "connection_fault_string": {"readOnly": true, "type": "string", "example": "Connection error message if not connected"}, "cache_sync_status": {"type": "object", "description": "Cache Sync Status provides information related to the state of the pack's object cache. It provides if a cache build is in progress, the reason why it is building, and the start and end times of the cache build process. At the start of a cache build, cache_sync_start is set to the current time, while cache_sync_complete is set to zero. At the completion of the cache build, cache_sync_complete is updated with the current time.", "properties": {"cache_sync": {"default": false, "readOnly": true, "type": "boolean", "description": "Indicates if a cache sync is in progress", "example": false}, "cache_sync_reason": {"readOnly": true, "enum": ["upgrade", "sensor_restart", "timer_expiration", "connection_reestablished"], "type": "string", "description": "Indicates the reason why a cache sync occurred", "example": "upgrade"}, "cache_sync_start": {"readOnly": true, "example": "1497902632", "type": "integer", "description": "UTC epoch time of cache sync start", "format": "int64"}, "cache_sync_complete": {"readOnly": true, "example": "1497902632", "type": "integer", "description": "UTC epoch time of cache sync complete", "format": "int64"}}}, "openshift": {"default": false, "type": "boolean", "description": "Indicates this is an OpenShift cluster"}, "pack": {"readOnly": true, "type": "string", "example": "Pack type"}}, "title": "Object: Kubernetes Pack Configuration"}, "kubernetes_pack_config_create": {"additionalProperties": false, "required": ["host", "username", "verify_ssl", "enabled", "openshift", "token"], "type": "object", "properties": {"username": {"minLength": 1, "maxLength": 200, "type": "string", "example": "admin", "format": "non_empty_or_whitespace_string"}, "verify_ssl": {"default": false, "type": "boolean", "description": "Indicates whether SSL/TLS certificates should be validated when connecting to Kubernetes Master", "example": false}, "description": {"type": "string", "maxLength": 1000}, "enabled": {"default": true, "type": "boolean", "description": "Indicates whether this configuration should be enabled", "example": true}, "token": {"minLength": 1, "maxLength": 2000, "type": "string", "format": "password"}, "openshift": {"default": false, "type": "boolean", "description": "Indicates this is an OpenShift cluster"}, "host": {"description": "Hostname or IP address of Kubernetes Master", "format": "hostname", "minLength": 2, "maxLength": 200, "type": "string", "example": "os.example.com"}, "pack": {"readOnly": true, "type": "string", "example": "Pack type"}, "port": {"default": 8443, "type": "integer", "description": "Kubernetes Master API Server Port", "example": 8443}, "name": {"maxLength": 200, "type": "string", "example": "My Kubernetes Configuration", "format": "non_empty_or_whitespace_string"}}, "title": "Object: Kubernetes Pack Configuration (create)"}, "kubernetes_pack_config_update": {"additionalProperties": false, "type": "object", "properties": {"username": {"minLength": 1, "format": "non_empty_or_whitespace_string", "type": "string", "example": "admin", "maxLength": 200}, "description": {"type": "string", "maxLength": 1000}, "name": {"format": "non_empty_or_whitespace_string", "type": "string", "example": "My Kubernetes Configuration", "maxLength": 200}, "enabled": {"default": true, "type": "boolean", "description": "Indicates whether this configuration should be enabled", "example": true}, "token": {"minLength": 1, "format": "password", "type": "string", "maxLength": 2000}, "port": {"default": 8443, "type": "integer", "description": "Kubernetes Master API Server Port", "example": 8443}, "verify_ssl": {"default": false, "type": "boolean", "description": "Indicates whether SSL/TLS certificates should be validated when connecting to Kubernetes Master", "example": false}, "host": {"description": "Hostname or IP address of Kubernetes Master", "format": "hostname", "minLength": 2, "maxLength": 200, "type": "string", "example": "os.example.com"}, "openshift": {"default": false, "type": "boolean", "description": "Indicates this is an OpenShift cluster"}, "pack": {"readOnly": true, "type": "string", "example": "Pack type"}}, "title": "Object: Kubernetes Pack Configuration (update)"}, "kubernetes_pack_config_verify": {"additionalProperties": false, "required": ["host", "username", "verify_ssl", "enabled", "openshift", "token"], "type": "object", "properties": {"username": {"minLength": 1, "format": "non_empty_or_whitespace_string", "type": "string", "example": "admin", "maxLength": 200}, "description": {"type": "string", "maxLength": 1000}, "name": {"type": "string", "example": "My Kubernetes Configuration", "maxLength": 200}, "enabled": {"default": true, "type": "boolean", "description": "Indicates whether this configuration should be enabled", "example": true}, "token": {"minLength": 1, "format": "password", "type": "string", "maxLength": 2000}, "port": {"default": 8443, "type": "integer", "description": "Kubernetes Master API Server Port", "example": 8443}, "verify_ssl": {"default": false, "type": "boolean", "description": "Indicates whether SSL/TLS certificates should be validated when connecting to Kubernetes Master", "example": false}, "host": {"description": "Hostname or IP address of Kubernetes Master", "format": "hostname", "minLength": 2, "maxLength": 200, "type": "string", "example": "os.example.com"}, "openshift": {"default": false, "type": "boolean", "description": "Indicates this is an OpenShift cluster"}, "pack": {"readOnly": true, "type": "string", "example": "Pack type"}}, "title": "Object: Kubernetes Pack Configuration (verify)"}, "kubernetes_pod": {"additionalProperties": false, "required": ["metadata", "spec", "status"], "type": "object", "properties": {"spec": {"additionalProperties": false, "required": ["scheduler"], "type": "object", "properties": {"scheduler": {"type": "string", "example": "default-scheduler"}}}, "metadata": {"additionalProperties": false, "required": ["labels", "name", "namespace", "uuid"], "type": "object", "properties": {"labels": {"type": "object", "example": {"proximity": "local"}}, "namespace": {"type": "string", "example": "demo1"}, "name": {"type": "string", "example": "demo-pod"}, "uuid": {"minLength": 36, "type": "string", "example": "423a1d57-83e6-583f-98ba-984317ef8c9d", "maxLength": 36}}}}, "title": "Object: Kubernetes Pod"}, "l2vpn": {"additionalProperties": false, "required": ["name", "vni", "uuid", "assignments", "fabric_uuids"], "type": "object", "properties": {"route_target": {"allOf": [{"$ref": "#/definitions/route_target"}, {"description": "Route Target. Used to connect external endpoints via BGP. BGP must be configured in order to use a route target. BGP is not necessary if you do not use a route target."}]}, "description": {"type": "string"}, "uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "vni": {"minimum": 1, "type": "integer", "description": "VxLAN ID for this L2VPN. This ID must be unique.", "maximum": 16770000, "example": 5000}, "assignments": {"items": {"$ref": "#/definitions/l2vpn_assignment"}, "type": "array", "description": "Assignments for this L2VPN. An empty list means there are no assignments. A L2VPN object with no assignments or route targets simply reserves a VxLAN ID."}, "fabric_uuids": {"items": {"example": "6c8ee2a1a0284f308b3c0f4156f6d042", "type": "string", "description": "Fabric UUID.", "format": "uuid_opt_hyphenated"}, "readOnly": true, "type": "array", "description": "The UUIDs for the fabric or fabrics this L2VPN is associated with. If the L2VPN has no assignments, then it is not associated with a fabric, then this list will be empty"}, "name": {"type": "string", "description": "name", "example": "l2vpn-1"}}, "title": "Object: L2VPN"}, "l2vpn_assignment": {"additionalProperties": false, "required": ["interface_uuid", "switch_information", "interface_identifier"], "type": "object", "properties": {"switch_information": {"items": {"$ref": "#/definitions/l2vpn_information_for_switches"}, "type": "array", "description": "Names and UUIDs for the switch(es) this assignment's interface is associated with. There will be only one name in the list for a port, but possible multiple names for a LAG."}, "vlans": {"description": "Optional VLANs to add to a L2VPN assignment. VLANs in this range are mapped to the L2VPN. A combination of a VLAN with an interface may only be used with one L2VPN.", "type": "string", "example": "5, 10-20, 30, 40, 50-60", "format": "vlan-range"}, "interface_uuid": {"allOf": [{"$ref": "#/definitions/uuid_with_type_l2vpn"}, {"description": "Port or LAG UUID for the L2VPN assignment. A bare (i.e. no VLAN) port or LAG may only be used with one L2VPN. A port or LAG with VLAN combination may only be used with one L2VPN."}]}, "interface_identifier": {"readOnly": true, "type": "string", "example": "port1", "description": "Identifier for this assignment's interface for this assignment. The identifier for a port assignment is the port name with the port label in parenthesis if the port name is set, or the port label if the port name is not set. The identifier for a LAG assignment is the LAG name."}}, "title": "Object: L2VPN Port/LAG Assignment"}, "l2vpn_assignment_create": {"additionalProperties": false, "required": ["interface_uuid"], "type": "object", "properties": {"vlans": {"format": "vlan-range", "type": "string", "description": "Optional VLANs to add to a L2VPN assignment. VLANs in this range are mapped to the L2VPN. A combination of a VLAN with an interface may only be used with one L2VPN.", "example": "5, 10-20, 30, 40, 50-60"}, "interface_uuid": {"allOf": [{"$ref": "#/definitions/uuid_with_type_l2vpn"}, {"description": "Port or LAG UUID for the L2VPN assignment. A bare (i.e. no VLAN) port or LAG may only be used with one L2VPN. A port or LAG with VLAN combination may only be used with one L2VPN."}]}}, "title": "Object: L2VPN Assignment (Create)"}, "l2vpn_assignment_update": {"additionalProperties": false, "required": ["interface_uuid"], "type": "object", "properties": {"vlans": {"format": "vlan-range", "type": "string", "description": "Optional VLANs to add to a L2VPN assignment. VLANs in this range are mapped to the L2VPN. A combination of a VLAN with an interface may only be used with one L2VPN.", "example": "5, 10-20, 30, 40, 50-60"}, "interface_uuid": {"allOf": [{"$ref": "#/definitions/uuid_with_type_l2vpn"}, {"description": "Port or LAG UUID for the L2VPN assignment. A bare (i.e. no VLAN) port or LAG may only be used with one L2VPN. A port or LAG with VLAN combination may only be used with one L2VPN."}]}}, "title": "Object: L2VPN Assignment (Update)"}, "l2vpn_create": {"additionalProperties": false, "required": ["name", "vni", "assignments"], "type": "object", "properties": {"route_target": {"allOf": [{"$ref": "#/definitions/route_target"}, {"description": "Route Target. Used to connect external endpoints via BGP. BGP must be configured in order to use a route target. BGP is not necessary if you do not use a route target."}]}, "description": {"type": "string"}, "vni": {"example": 5000, "minimum": 1, "type": "integer", "description": "VxLAN ID for this L2VPN. This ID must be unique.", "maximum": 16770000}, "name": {"type": "string", "description": "name", "example": "l2vpn-1"}, "assignments": {"items": {"$ref": "#/definitions/l2vpn_assignment_create"}, "type": "array", "description": "Assignments for this L2VPN. An empty list means there are no assignments. A L2VPN object with no assignments or route targets simply reserves a VxLAN ID."}}, "title": "Object: L2VPN (Create)"}, "l2vpn_information_for_ports_lags": {"additionalProperties": false, "required": ["l2vpn_uuid", "l2vpn_name"], "type": "object", "properties": {"l2vpn_uuid": {"readOnly": true, "description": "The UUID of the L2VPN to which this LAG or port is associated", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "l2vpn_name": {"description": "The name of the associated L2VPN", "type": "string", "example": "l2vpn01", "format": "non_empty_or_whitespace_string"}}, "title": "Object: L2VPN information for Ports/LAGs"}, "l2vpn_information_for_switches": {"additionalProperties": false, "required": ["switch_uuid", "switch_name"], "type": "object", "properties": {"switch_uuid": {"readOnly": true, "description": "The UUID of the switch associated with this L2VPN", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "switch_name": {"description": "The name of the associated switch", "type": "string", "example": "switch01", "format": "non_empty_or_whitespace_string"}}, "title": "Object: L2VPN information for Switches"}, "l2vpn_update": {"additionalProperties": false, "required": ["name", "vni", "assignments"], "type": "object", "properties": {"route_target": {"allOf": [{"$ref": "#/definitions/route_target"}, {"description": "Route Target. Used to connect external endpoints via BGP. BGP must be configured in order to use a route target. BGP is not necessary if you do not use a route target."}]}, "description": {"type": "string"}, "vni": {"example": 5000, "minimum": 1, "type": "integer", "description": "VxLAN ID for this L2VPN. This ID must be unique.", "maximum": 16770000}, "name": {"type": "string", "description": "name", "example": "l2vpn-1"}, "assignments": {"items": {"$ref": "#/definitions/l2vpn_assignment_update"}, "type": "array", "description": "Assignments for this L2VPN. An empty list means there are no assignments. A L2VPN object with no assignments or route targets simply reserves a VxLAN ID."}}, "title": "Object: L2VPN (Update)"}, "lacp": {"additionalProperties": false, "required": ["aggregate_port_limits", "intervals", "mode", "priority"], "type": "object", "properties": {"priority": {"description": "LACP priority.", "default": 32768, "maximum": 32768, "minimum": 0, "type": "number", "example": 100}, "intervals": {"additionalProperties": false, "required": ["fast", "slow"], "type": "object", "description": "LACP intervals, in seconds.", "properties": {"slow": {"description": "Slow interval, in seconds.", "default": 30, "maximum": 30, "minimum": 1, "type": "number", "example": 30}, "fast": {"description": "Fast interval, in seconds.", "default": 1, "maximum": 30, "minimum": 1, "type": "number", "example": 1}}}, "aggregate_port_limits": {"additionalProperties": false, "required": ["maximum", "minimum"], "type": "object", "description": "Aggregate port limits.", "properties": {"minimum": {"description": "Minimum number of member ports supported by the associated Link Aggregation Group. A value of 0 implies the limit is not enforced.", "default": 0, "maximum": 8, "minimum": 0, "type": "number", "example": 2}, "maximum": {"description": "Maximum number of member ports supported by the associated Link Aggregation Group. A value of 0 implies the limit is not enforced.", "default": 0, "maximum": 8, "minimum": 0, "type": "number", "example": 8}}}, "mode": {"enum": ["active", "off", "passive"], "type": "string", "description": "Link Aggregation Control Protocol (LACP) Mode.", "example": "active"}}, "title": "Object: Link Aggregation Control Protocol (LACP) properties"}, "lag": {"additionalProperties": false, "required": ["description", "fabric_uuid", "name", "native_vlan", "port_properties", "type", "uuid", "ungrouped_vlans", "vlan_group_uuids", "vlans"], "type": "object", "properties": {"native_vlan": {"example": 99, "minimum": 0, "type": "number", "maximum": 4000, "description": "This VLAN is:\n* Applied to all untagged traffic coming in to this Link Aggregation Group (ingress)\n* Removed from all traffic tagged with this VLAN which is leaving this Link Aggregation Group (egress)\n* NOTE: a native_vlan value of 0 means that any untagged traffic will be dropped on either ingress or egress"}, "uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "mlag": {"readOnly": true, "type": "boolean", "description": "True if this Link Aggregation Group is an MLAG; false otherwise.", "example": true}, "fabric_uuid": {"readOnly": true, "description": "The UUID of the fabric to which this Link Aggregation Group is associated", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "description": {"type": "string", "example": ""}, "tags": {"$ref": "#/definitions/tags_on_object"}, "type": {"readOnly": true, "enum": ["internal", "provisioned"], "type": "string", "description": "* `provisioned` Link Aggregation Groups have been explicitly configured on switches and can contain one or more ports.\n* `internal` Link Aggregation Groups exist by default on switches and contain only one port. Think of `internal` Link Aggregation Groups as logical objects that simply hold configuration state (e.g. LACP mode and configured line speed)."}, "mac_learning_configuration": {"type": "object", "$ref": "#/definitions/mac_learning_config"}, "mac_learning_attachments": {"items": {"$ref": "#/definitions/mac_attachment"}, "type": "array", "description": "MAC attachments learned or configured on this Link Aggregation Group"}, "vlan_group_uuids": {"items": {"example": "6c8ee2a1a0284f308b3c0f4156f6d042", "type": "string", "description": "VLAN group UUID.", "format": "uuid_opt_hyphenated"}, "type": "array", "description": "UUIDs of the VLAN groups associated with this Link Aggregation Group."}, "name": {"type": "string", "example": "LinkAggregationGroup#01", "format": "non_empty_or_whitespace_string"}, "lacp_fallback": {"type": "object", "properties": {"port_uuid": {"oneOf": [{"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, {"type": "null"}], "description": "Port associated with LACP fallback.", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "timeout": {"example": 20, "minimum": 0, "type": "number", "maximum": 100, "description": "LACP timeout value in seconds."}}}, "vlan_groups": {"items": {"$ref": "#/definitions/vlan_group_embedded"}, "readOnly": true, "type": "array", "description": "VLAN groups associated with this Link Aggregation Group."}, "port_properties": {"minItems": 1, "items": {"$ref": "#/definitions/lag_ports"}, "type": "array", "description": "Switch port properties associated with this Link Aggregation Group.\n* Each object is scoped specifically to the switch to which the contained LAG member port UUIDs are related.\n* For example, an MLAG with two ports on two different switches will have two port_properties objects, each with two port UUIDs and switch-specific configuration settings."}, "vlans": {"readOnly": true, "format": "vlan-range", "type": "string", "description": "The effective VLANs assigned to this Link Aggregation Group, including VLAN groups and directly assigned VLANs, presented as a sorted set of ranges.", "example": "5, 10-20, 30, 40, 50-60"}, "l2vpn_information": {"items": {"$ref": "#/definitions/l2vpn_information_for_ports_lags"}, "type": "array", "description": "If the `l2vpn` query parameter is `true`, this list will contain any associated L2VPN UUIDs and their names."}, "ungrouped_vlans": {"example": "5, 10-20, 30, 40, 50-60", "type": "string", "description": "VLANs directly assigned to this Link Aggregation Group, not in a VLAN group, presented as a sorted set of ranges.", "format": "vlan-range"}, "mac_learning_use_default_configuration": {"type": "boolean", "description": "Does this Link Aggregation Group use the default MAC learning configuration?", "example": false}}, "title": "Object: LAG"}, "lag_create": {"additionalProperties": false, "required": ["name", "native_vlan", "port_properties", "ungrouped_vlans", "vlan_group_uuids"], "type": "object", "properties": {"native_vlan": {"minimum": 0, "type": "number", "description": "This VLAN is:\n* Applied to all untagged traffic coming in to this Link Aggregation Group (ingress)\n* Removed from all traffic tagged with this VLAN which is leaving this Link Aggregation Group (egress)\n* NOTE: a native_vlan value of 0 means that any untagged traffic will be dropped on either ingress or egress", "maximum": 4000, "example": 99}, "mlag": {"readOnly": true, "type": "boolean", "description": "True if this Link Aggregation Group is an MLAG; false otherwise.", "example": true}, "fabric_uuid": {"description": "The UUID of the fabric to which this Link Aggregation Group is associated", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "tags": {"$ref": "#/definitions/tags_on_object"}, "description": {"type": "string", "example": ""}, "mac_learning_configuration": {"type": "object", "$ref": "#/definitions/mac_learning_config"}, "mac_learning_attachments": {"items": {"$ref": "#/definitions/mac_attachment"}, "type": "array", "description": "Static MAC attachments configured on this LAG"}, "vlan_group_uuids": {"items": {"description": "VLAN group UUID.", "type": "string", "example": "6c8ee2a1a0284f308b3c0f4156f6d042", "format": "uuid_opt_hyphenated"}, "type": "array", "description": "UUIDs of the VLAN groups associated with this Link Aggregation Group."}, "lacp_fallback": {"type": "object", "properties": {"port_uuid": {"oneOf": [{"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, {"type": "null"}], "description": "Port associated with LACP fallback.", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "timeout": {"minimum": 0, "type": "number", "description": "LACP timeout value in seconds.", "maximum": 100, "example": 20}}}, "vlan_groups": {"items": {"$ref": "#/definitions/vlan_group_embedded"}, "readOnly": true, "type": "array", "description": "VLAN groups associated with this Link Aggregation Group."}, "mac_learning_use_default_configuration": {"type": "boolean", "description": "Does this Link Aggregation Group use the default MAC learning configuration?", "example": false}, "port_properties": {"minItems": 1, "items": {"$ref": "#/definitions/lag_ports_update"}, "type": "array", "description": "Switch port properties associated with this Link Aggregation Group.\n* Each object is scoped specifically to the switch to which the contained LAG member port UUIDs are related.\n* For example, an MLAG with two ports on two different switches will have two port_properties objects, each with two port UUIDs and switch-specific configuration settings."}, "vlans": {"readOnly": true, "format": "vlan-range", "type": "string", "example": "5, 10-20, 30, 40, 50-60", "description": "The effective VLANs assigned to this Link Aggregation Group, including VLAN groups and directly assigned VLANs, presented as a sorted set of ranges."}, "type": {"readOnly": true, "enum": ["internal", "provisioned"], "type": "string", "description": "* `provisioned` Link Aggregation Groups have been explicitly configured on switches and can contain one or more ports.\n* `internal` Link Aggregation Groups exist by default on switches and contain only one port. Think of `internal` Link Aggregation Groups as logical objects that simply hold configuration state (e.g. LACP mode and configured line speed)."}, "ungrouped_vlans": {"description": "VLANs directly assigned to this Link Aggregation Group, not in a VLAN group, presented as a sorted set of ranges.", "type": "string", "example": "5, 10-20, 30, 40, 50-60", "format": "vlan-range"}, "name": {"type": "string", "example": "LinkAggregationGroup#01", "format": "non_empty_or_whitespace_string"}}, "title": "Object: LAG (Create)"}, "lag_flat": {"additionalProperties": false, "required": ["description", "fabric_uuid", "name", "native_vlan", "port_properties", "type", "uuid", "ungrouped_vlans", "vlan_group_uuids", "vlans"], "type": "object", "properties": {"native_vlan": {"description": "This VLAN is:\n* Applied to all untagged traffic coming in to this Link Aggregation Group (ingress)\n* Removed from all traffic tagged with this VLAN which is leaving this Link Aggregation Group (egress)\n* NOTE: a native_vlan value of 0 means that any untagged traffic will be dropped on either ingress or egress", "minimum": 0, "type": "number", "example": 99, "maximum": 4000}, "mlag": {"readOnly": true, "type": "boolean", "description": "True if this Link Aggregation Group is an MLAG; false otherwise.", "example": true}, "fabric_uuid": {"description": "The UUID of the fabric to which this Link Aggregation Group is associated", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "tags": {"$ref": "#/definitions/tags_on_object"}, "l2vpn_information": {"items": {"$ref": "#/definitions/l2vpn_information_for_ports_lags"}, "type": "array", "description": "If the `l2vpn` query parameter is `true`, this list will contain any associated L2VPN UUIDs and their names."}, "vlan_group_uuids": {"items": {"format": "uuid_opt_hyphenated", "type": "string", "example": "6c8ee2a1a0284f308b3c0f4156f6d042", "description": "VLAN group UUID."}, "type": "array", "description": "UUIDs of the VLAN groups associated with this Link Aggregation Group."}, "name": {"type": "string", "example": "LinkAggregationGroup#01", "format": "non_empty_or_whitespace_string"}, "lacp_fallback": {"type": "object", "properties": {"port_uuid": {"oneOf": [{"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, {"type": "null"}], "description": "Port associated with LACP fallback.", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "timeout": {"description": "LACP timeout value in seconds.", "minimum": 0, "type": "number", "example": 20, "maximum": 100}}}, "port_properties": {"minItems": 1, "items": {"$ref": "#/definitions/lag_ports_flat"}, "type": "array", "description": "Switch port properties associated with this Link Aggregation Group.\n* Each object is scoped specifically to the switch to which the contained LAG member port UUIDs are related.\n* For example, an MLAG with two ports on two different switches will have two port_properties objects, each with two port UUIDs and switch-specific configuration settings."}, "vlans": {"readOnly": true, "example": "5, 10-20, 30, 40, 50-60", "type": "string", "description": "The effective VLANs assigned to this Link Aggregation Group, including VLAN groups and directly assigned VLANs, presented as a sorted set of ranges.", "format": "vlan-range"}, "type": {"readOnly": true, "enum": ["internal", "provisioned"], "type": "string", "description": "* `provisioned` Link Aggregation Groups have been explicitly configured on switches and can contain one or more ports.\n* `internal` Link Aggregation Groups exist by default on switches and contain only one port. Think of `internal` Link Aggregation Groups as logical objects that simply hold configuration state (e.g. LACP mode and configured line speed)."}, "ungrouped_vlans": {"format": "vlan-range", "type": "string", "example": "5, 10-20, 30, 40, 50-60", "description": "VLANs directly assigned to this Link Aggregation Group, not in a VLAN group, presented as a sorted set of ranges."}, "description": {"type": "string", "example": ""}}, "title": "Object: LAG (flat)"}, "lag_patch_document": {"additionalProperties": false, "required": ["op", "path"], "type": "object", "properties": {"path": {"type": "string", "description": "A JSON pointer."}, "from": {"type": "string", "description": "A string containing a JSON Pointer value."}, "value": {"anyOf": [{"type": "string"}, {"type": "integer"}, {"type": "array"}, {"type": "boolean"}, {"type": "array"}, {"type": "boolean"}], "description": "The value to be used within the operations. The value is of type array, boolean, integer, or string.", "example": "value"}, "op": {"enum": ["add", "remove", "replace"], "type": "string", "description": "The operation to be performed."}}}, "lag_patch_request": {"additionalProperties": false, "required": ["uuids", "patch"], "type": "object", "properties": {"uuids": {"items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array", "example": ["037341000458000040b8eec096f17ea9", "0373410004580000a0cb730d0910013c"]}, "patch": {"items": {"$ref": "#/definitions/lag_patch_document"}, "type": "array", "example": [{"path": "/speed/current", "value": 10000, "op": "replace"}, {"path": "/description", "value": "LAG for ACME Co.", "op": "replace"}, {"path": "/native_vlan", "value": 4, "op": "replace"}]}}}, "lag_ports": {"additionalProperties": false, "required": ["lacp", "port_uuids", "speed"], "type": "object", "properties": {"port_lacp_state": {"items": {"type": "object", "properties": {"partner_state_lacp_status": {"oneOf": [{"enum": ["not_applicable", "forwarding", "standby", "synced"], "type": "string", "description": "", "example": "forwarding"}, {"type": "null"}]}, "port_uuid": {"example": "03734100040c0000399e081dc0ca985b", "type": "string", "description": "Port UUID", "format": "uuid_opt_hyphenated"}, "partner_state_system_id": {"oneOf": [{"type": "string", "example": "00:50:56:aa:bb:dd", "format": "mac_address"}, {"type": "null"}]}, "partner_state_port": {"oneOf": [{"minimum": 0, "type": "number", "description": ""}, {"type": "null"}]}, "partner_state_system_priority": {"oneOf": [{"minimum": 0, "type": "number", "description": "", "maximum": 65535, "example": 0}, {"type": "null"}]}, "partner_state_key": {"oneOf": [{"minimum": 0, "type": "number", "description": "", "maximum": 65535, "example": 0}, {"type": "null"}]}, "actor_state_lacp_status": {"oneOf": [{"enum": ["not_applicable", "forwarding", "standby", "synced"], "type": "string", "description": "", "example": "forwarding"}, {"type": "null"}]}}}, "readOnly": true, "type": "array"}, "lacp": {"$ref": "#/definitions/lacp"}, "switch_uuid": {"readOnly": true, "type": "string", "description": "Switch UUID", "format": "uuid_opt_hyphenated"}, "speed": {"$ref": "#/definitions/port_speed"}, "ports": {"items": {"$ref": "#/definitions/port_flat"}, "readOnly": true, "type": "array", "description": "Switch ports associated with this Link Aggregation Group."}, "port_uuids": {"minItems": 1, "items": {"example": "03734100040c0000399e081dc0ca985b", "type": "string", "description": "Switch port UUID", "format": "uuid_opt_hyphenated"}, "type": "array", "description": "UUIDs of the switch ports associated with this Link Aggregation Group."}}, "title": "Object: LAG-specific port properties"}, "lag_ports_flat": {"additionalProperties": false, "required": ["lacp", "port_uuids", "speed"], "type": "object", "properties": {"port_lacp_state": {"items": {"type": "object", "properties": {"partner_state_lacp_status": {"oneOf": [{"enum": ["not_applicable", "forwarding", "standby", "synced"], "type": "string", "description": "", "example": "forwarding"}, {"type": "null"}]}, "port_uuid": {"format": "uuid_opt_hyphenated", "type": "string", "example": "03734100040c0000399e081dc0ca985b", "description": "Port UUID"}, "partner_state_system_id": {"oneOf": [{"type": "string", "example": "00:50:56:aa:bb:dd", "format": "mac_address"}, {"type": "null"}]}, "partner_state_port": {"oneOf": [{"minimum": 0, "type": "number", "description": ""}, {"type": "null"}]}, "partner_state_system_priority": {"oneOf": [{"example": 0, "minimum": 0, "type": "number", "description": "", "maximum": 65535}, {"type": "null"}]}, "partner_state_key": {"oneOf": [{"example": 0, "minimum": 0, "type": "number", "description": "", "maximum": 65535}, {"type": "null"}]}, "actor_state_lacp_status": {"oneOf": [{"enum": ["not_applicable", "forwarding", "standby", "synced"], "type": "string", "description": "", "example": "forwarding"}, {"type": "null"}]}}}, "readOnly": true, "type": "array"}, "lacp": {"$ref": "#/definitions/lacp"}, "switch_uuid": {"readOnly": true, "type": "string", "description": "Switch UUID", "format": "uuid_opt_hyphenated"}, "speed": {"$ref": "#/definitions/port_speed"}, "port_uuids": {"minItems": 1, "items": {"format": "uuid_opt_hyphenated", "type": "string", "example": "03734100040c0000399e081dc0ca985b", "description": "Switch port UUID"}, "type": "array", "description": "UUIDs of the switch ports associated with this Link Aggregation Group."}}, "title": "Object: LAG-specific port properties(flat)"}, "lag_ports_update": {"additionalProperties": false, "required": ["lacp", "port_uuids", "speed"], "type": "object", "properties": {"port_lacp_state": {"items": {"type": "object", "properties": {"partner_state_lacp_status": {"oneOf": [{"enum": ["not_applicable", "forwarding", "standby", "synced"], "type": "string", "description": "", "example": "forwarding"}, {"type": "null"}]}, "port_uuid": {"format": "uuid_opt_hyphenated", "type": "string", "example": "03734100040c0000399e081dc0ca985b", "description": "Port UUID"}, "partner_state_system_id": {"oneOf": [{"type": "string", "example": "00:50:56:aa:bb:dd", "format": "mac_address"}, {"type": "null"}]}, "partner_state_port": {"oneOf": [{"minimum": 0, "type": "number", "description": ""}, {"type": "null"}]}, "partner_state_system_priority": {"oneOf": [{"example": 0, "minimum": 0, "type": "number", "description": "", "maximum": 65535}, {"type": "null"}]}, "partner_state_key": {"oneOf": [{"example": 0, "minimum": 0, "type": "number", "description": "", "maximum": 65535}, {"type": "null"}]}, "actor_state_lacp_status": {"oneOf": [{"enum": ["not_applicable", "forwarding", "standby", "synced"], "type": "string", "description": "", "example": "forwarding"}, {"type": "null"}]}}}, "readOnly": true, "type": "array"}, "lacp": {"$ref": "#/definitions/lacp"}, "switch_uuid": {"readOnly": true, "type": "string", "description": "Switch UUID", "format": "uuid_opt_hyphenated"}, "speed": {"$ref": "#/definitions/port_speed"}, "port_uuids": {"minItems": 1, "items": {"format": "uuid_opt_hyphenated", "type": "string", "example": "03734100040c0000399e081dc0ca985b", "description": "Switch port UUID"}, "type": "array", "description": "UUIDs of the switch ports associated with this Link Aggregation Group."}}, "title": "Object: LAG-specific port properties (Update)"}, "lag_update": {"additionalProperties": false, "required": ["description", "name", "native_vlan", "port_properties", "ungrouped_vlans", "vlan_group_uuids"], "type": "object", "properties": {"native_vlan": {"description": "This VLAN is:\n* Applied to all untagged traffic coming in to this Link Aggregation Group (ingress)\n* Removed from all traffic tagged with this VLAN which is leaving this Link Aggregation Group (egress)\n* NOTE: a native_vlan value of 0 means that any untagged traffic will be dropped on either ingress or egress", "minimum": 0, "type": "number", "example": 99, "maximum": 4000}, "mlag": {"readOnly": true, "type": "boolean", "description": "True if this Link Aggregation Group is an MLAG; false otherwise.", "example": true}, "fabric_uuid": {"description": "The UUID of the fabric to which this Link Aggregation Group is associated", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "tags": {"$ref": "#/definitions/tags_on_object"}, "mac_learning_configuration": {"type": "object", "$ref": "#/definitions/mac_learning_config"}, "mac_learning_attachments": {"items": {"$ref": "#/definitions/mac_attachment"}, "type": "array", "description": "Static MAC attachments configured on this LAG"}, "vlan_group_uuids": {"items": {"format": "uuid_opt_hyphenated", "type": "string", "example": "6c8ee2a1a0284f308b3c0f4156f6d042", "description": "VLAN group UUID."}, "type": "array", "description": "UUIDs of the VLAN groups associated with this Link Aggregation Group."}, "name": {"type": "string", "example": "LinkAggregationGroup#01", "format": "non_empty_or_whitespace_string"}, "lacp_fallback": {"type": "object", "properties": {"port_uuid": {"oneOf": [{"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, {"type": "null"}], "description": "Port associated with LACP fallback.", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "timeout": {"description": "LACP timeout value in seconds.", "minimum": 0, "type": "number", "example": 20, "maximum": 100}}}, "vlan_groups": {"items": {"$ref": "#/definitions/vlan_group_embedded"}, "readOnly": true, "type": "array", "description": "VLAN groups associated with this Link Aggregation Group."}, "mac_learning_use_default_configuration": {"type": "boolean", "description": "Does this Link Aggregation Group use the default MAC learning configuration?", "example": false}, "port_properties": {"minItems": 1, "items": {"$ref": "#/definitions/lag_ports_update"}, "type": "array", "description": "Switch port properties associated with this Link Aggregation Group.\n* Each object is scoped specifically to the switch to which the contained LAG member port UUIDs are related.\n* For example, an MLAG with two ports on two different switches will have two port_properties objects, each with two port UUIDs and switch-specific configuration settings."}, "vlans": {"readOnly": true, "example": "5, 10-20, 30, 40, 50-60", "type": "string", "description": "The effective VLANs assigned to this Link Aggregation Group, including VLAN groups and directly assigned VLANs, presented as a sorted set of ranges.", "format": "vlan-range"}, "type": {"readOnly": true, "enum": ["internal", "provisioned"], "type": "string", "description": "* `provisioned` Link Aggregation Groups have been explicitly configured on switches and can contain one or more ports.\n* `internal` Link Aggregation Groups exist by default on switches and contain only one port. Think of `internal` Link Aggregation Groups as logical objects that simply hold configuration state (e.g. LACP mode and configured line speed)."}, "ungrouped_vlans": {"format": "vlan-range", "type": "string", "example": "5, 10-20, 30, 40, 50-60", "description": "VLANs directly assigned to this Link Aggregation Group, not in a VLAN group, presented as a sorted set of ranges."}, "description": {"type": "string", "example": ""}}, "title": "Object: LAG (Update)"}, "license": {"additionalProperties": false, "required": ["consumed_count", "detailed_licenses", "fabric_name", "fabric_uuid", "id", "license_count", "name", "overprovisioned", "vendor_string"], "type": "object", "properties": {"consumed_count": {"type": "integer", "description": "Count of consumed licenses of this type.", "example": 7}, "overprovisioned": {"readOnly": true, "type": "boolean", "description": "Whether this license type is over-provisioned.", "example": true}, "license_count": {"readOnly": true, "type": "integer", "description": "Count of total licenses of this type, -1 for uncounted", "example": 8}, "name": {"enum": ["PLX_SM_S", "PLX_AP_S"], "type": "string", "description": "Name of the license.", "example": "PLX_AP_S"}, "detailed_licenses": {"items": {"type": "object", "properties": {"overprovisioned": {"readOnly": true, "type": "boolean", "description": "Whether this license is over-provisioned.", "example": true}, "fabric_uuid": {"readOnly": true, "type": "string", "description": "Fabric UUID for the fabric to which this license is associated.", "example": "03734100041a0000399e081dc0ca985b"}, "license_list": {"items": {"type": "object", "properties": {"license_count": {"readOnly": true, "type": "integer", "description": "Count of total licenses of this type, -1 for uncounted", "example": 8}, "vendor_string": {"readOnly": true, "type": "string", "description": "Vendor description string from the license.", "example": "Enable standard Access Port(s) on any switch."}, "expired": {"readOnly": true, "type": "boolean", "description": "True if the license has expired, false if not.", "example": 1521676800}, "issued_date": {"readOnly": true, "type": "number", "description": "The license issued date in microseconds from the epoch."}, "license_lock_id": {"readOnly": true, "type": "string", "description": "ID to which this license is locked,\"Any\" if not locked to a specific ID", "example": "cb1406fd-b77a-4ed7-aa37-0b69c27ec10c"}, "name": {"readOnly": true, "type": "string", "description": "Name of the license.", "example": "PLX_AP_S_SX"}, "expiration_date": {"readOnly": true, "type": "number", "description": "The expiration date in microseconds from the epoch.", "example": 1521676800}, "required": ["expiration_date", "expired", "issued_date", "license_count", "license_lock_id", "name", "start_date", "vendor_string", "version"], "version": {"readOnly": true, "type": "string", "description": "Version of this license.", "example": "1.0"}, "additionalProperties": false, "start_date": {"readOnly": true, "type": "number", "description": "The license start date in microseconds from the epoch.", "example": 1521676800}}}, "type": "array"}, "license_count": {"readOnly": true, "type": "integer", "description": "Count of total licenses of this type, -1 for uncounted", "example": 8}, "vendor_string": {"readOnly": true, "type": "string", "description": "Vendor description string from the license.", "example": "Enable standard Access Port(s) on any switch."}, "consumed_count": {"type": "integer", "description": "Count of consumed licenses of this type.", "example": 7}, "license_lock_id": {"readOnly": true, "type": "string", "description": "ID to which this license is locked, \"Any\" if not locked to a specific ID", "example": "cb1406fd-b77a-4ed7-aa37-0b69c27ec10c"}, "name": {"readOnly": true, "type": "string", "description": "Name of the license.", "example": "PLX_AP_S_SX"}, "expiration_date": {"readOnly": true, "type": "number", "description": "The expiration date in microseconds from the epoch."}, "required": ["consumed_count", "expiration_date", "fabric_name", "fabric_uuid", "license_count", "license_list", "license_lock_id", "name", "overprovisioned", "vendor_string", "version"], "fabric_name": {"readOnly": true, "type": "string", "description": "Fabric name for the fabric to which this license is associated.", "example": "Fabric1"}, "version": {"readOnly": true, "type": "string", "description": "Version of this license.", "example": "1.0"}, "additionalProperties": false}}, "type": "array"}, "vendor_string": {"readOnly": true, "type": "string", "description": "Vendor description string from the license.", "example": "Enable standard Access Port(s) on any switch."}, "fabric_name": {"readOnly": true, "type": "string", "description": "Fabric name for the fabric to which this license is associated.", "example": "Fabric1"}, "fabric_uuid": {"readOnly": true, "type": "string", "description": "Fabric UUID for the fabric to which this license is associated.", "example": "03734100041a0000399e081dc0ca985b"}, "id": {"readOnly": true, "type": "string", "description": "Identifier for this license. Unique on this system.", "example": "PLX_AP_S-Fabric01"}}, "title": "Object: License"}, "license_upload": {"additionalProperties": false, "required": ["licenses"], "type": "object", "properties": {"licenses": {"minLength": 1, "type": "string", "description": "License Binary File", "example": ""}}, "title": "Object: Licenses (upload)"}, "licenses_request": {"additionalProperties": false, "required": ["device_id", "fabric_name", "request_file"], "type": "object", "properties": {"fabric_name": {"readOnly": true, "type": "string", "description": "Fabric name for the fabric used to generate the request file.", "example": "Fabric01"}, "request_file": {"minLength": 1, "type": "string", "description": "Base64 encoded Request Binary File", "example": ""}, "device_id": {"readOnly": true, "type": "string", "description": "Device ID to which license request is locked.", "example": "1bff02ce-1629-4506-9c37-24f9fe6a3991"}}, "title": "Object: Request file (download)"}, "mac_address_with_mask": {"additionalProperties": false, "required": ["mac_address"], "type": "object", "properties": {"mask": {"default": "ff:ff:ff:ff:ff:ff", "example": "ff:ff:ff:00:00:00", "format": "mac_address"}, "mac_address": {"example": "00:50:56:aa:bb:dd", "format": "mac_address"}}, "title": "Object: MAC Address with Mask"}, "mac_attachment": {"additionalProperties": false, "required": ["mac_address"], "type": "object", "properties": {"vlan": {"type": "number", "example": 1000}, "vni": {"type": "number", "example": 5000}, "mac_address": {"example": "00:50:56:aa:bb:dd", "format": "mac_address"}}, "title": "Object: MAC Attachment"}, "mac_attachment_object": {"additionalProperties": false, "required": ["uuid", "mac_address", "last_modified", "interface_uuid", "interface_type"], "type": "object", "properties": {"interface_object": {"readOnly": true, "type": "object", "description": "Interface this MAC attachment was learned on either:\n* LAG\n* port\nObject will only be returned if `interfaces` is set to TRUE", "properties": {"oneOf": [{"$ref": "#/definitions/lag_flat"}, {"$ref": "#/definitions/port_flat"}]}}, "interface_uuid": {"readOnly": true, "type": "string", "description": "Either a non-dashed 16-byte UUID or an empty string", "example": "03734100040c00000000000000000011"}, "last_modified": {"readOnly": true, "example": 1241283415, "type": "integer", "description": "Date/time the MAC attachment was updated in persistent store expressed in terms of the epoch", "format": "int64"}, "uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "mac_address": {"example": "00:50:56:aa:bb:dd", "format": "mac_address"}, "switch_uuids": {"items": {"example": "0373410004190000590cb385dabc399a", "type": "string", "description": "Switch UUID.", "format": "uuid_opt_hyphenated"}, "type": "array"}, "interface_identifier": {"readOnly": true, "type": "string", "example": "my_port (1)", "description": "Identifier for the interface the MAC was learned on. The identifier for a port assignment is the port name with the port label in parenthesis if the port name is set, or the port label if the port name is not set. The identifier for a LAG assignment is the LAG name."}, "interface_type": {"readOnly": true, "enum": ["lag", "port"], "type": "string", "description": "Either port or lag", "example": "port"}, "vlan": {"example": 1000, "minimum": 1, "type": "integer", "description": "The VLAN ID", "maximum": 4000}, "vni": {"minimum": 1, "type": "integer", "description": "The VNI identifier (for MAC attachments learned on L2VPN).", "example": 100}}, "title": "Object: MAC Attachment Object"}, "mac_learning_config": {"additionalProperties": false, "required": ["aging", "learning_limit", "mode", "violation_action"], "type": "object", "properties": {"learning_limit": {"minimum": 0, "type": "integer", "description": "The maximum number of MAC's that may be learned on a LAG.", "example": 1}, "aging": {"type": "boolean", "description": "Is MAC aging enabled?", "example": false}, "violation_action": {"enum": ["restrict", "shutdown"], "type": "string", "description": "The action to take if the MAC learning limit is violated.", "example": "restrict"}, "mode": {"enum": ["dynamic", "static", "sticky", "unbounded"], "type": "string", "description": "The MAC learning mode.", "example": "dynamic"}}, "title": "Object: MAC Learning Configuration"}, "mac_learning_default_config": {"additionalProperties": false, "required": ["aging", "learning_limit", "mode", "violation_action"], "type": "object", "properties": {"learning_limit": {"minimum": 0, "type": "integer", "description": "The maximum number of MAC's that may be learned on a LAG.", "example": 1}, "aging": {"type": "boolean", "description": "Is MAC aging enabled?", "example": false}, "violation_action": {"enum": ["restrict", "shutdown"], "type": "string", "description": "The action to take if the MAC learning limit is violated.", "example": "restrict"}, "mode": {"enum": ["dynamic", "sticky", "unbounded"], "type": "string", "description": "The MAC learning mode.", "example": "dynamic"}}, "title": "Object: MAC Learning Default Configuration"}, "multi_status_response": {"additionalProperties": false, "required": ["reason", "status", "uuids"], "type": "object", "properties": {"status": {"enum": ["success", "partial_success", "accepted_busy", "failure"], "type": "string", "description": "Result of the operation.", "example": "failed"}, "reason": {"type": "string", "description": "A comma-separated string of reason(s) for failure or partial success.", "example": "Failed to update MAC learning configuration for LAG ACME Co."}, "uuids": {"items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array", "description": "List of UUIDs with the status.", "example": ["037341000458000008112182c45d3c91", "037341000458000008112182c45d3c91"]}}, "title": "Object: Multi-Status Response"}, "neighbor_discovery_advertisement": {"additionalProperties": false, "required": ["switch_uuid", "port_uuid", "chassis_id", "chassis_subtype", "port_id", "port_subtype"], "type": "object", "properties": {"port_description": {"type": "string", "description": "IEEE 802 LAN station's port description of received neighbor. This is an alpha-numeric string that should be `ifDescr` if RFC 2863 is implemented.", "example": "My port description"}, "port_uuid": {"readOnly": false, "description": "The UUID of the port the neighbor was received on.", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "ttl": {"type": "integer", "description": "Time To Live. Amount of time, in seconds, the neighbor is valid.", "example": 60}, "port_id": {"type": "string", "description": "Port ID of the received neighbor.", "example": "My-Port-ID"}, "mgmt_address_ifnum_subtype": {"type": "integer", "description": "Subtype of the Interface Number in the received neighbor. It can be one of 3 values:\n* Unknown (1)\n* ifIndex (2)\n* System port number (3)", "example": 2}, "uuid": {"readOnly": true, "description": "UUID of the neighbor.", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "port_subtype": {"enum": ["if_alias", "port_component", "mac_address", "network_address", "if_name", "agent_circuit", "locally_assigned"], "type": "string", "description": "Subtype of the Port ID. It can be one of the following:\n* Interface Alias (1): ifAlias (RFC 2863)\n* Port Component (2): possibly entPhysicalAlias (RFC 4133)\n* MAC Address (3): MAC address\n* Network Address (4): networkAddress\n* Interface Name (5): ifName (RFC 2863)\n* Agent Circuit ID (6): agent circuit ID (RFC 3046)\n* Locally Assigned (7): local, alpha numeric string", "example": "mac_address"}, "chassis_id": {"type": "string", "description": "Chassis ID of neighbor. What's in this field is specified by the `Chassis Subtype`.", "example": "My-Chassis-ID"}, "source_mac_address": {"example": "F0:AC:12:C9:34:A0", "description": "MAC Address of _sender_ of LLDP/CDP neighbor.", "format": "mac_address"}, "switch_uuid": {"readOnly": false, "description": "The UUID of the switch the neighbor was received on.", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "last_modified": {"readOnly": true, "type": "string", "description": "Date/time the neighbor was last updated.", "example": "2016-06-22 19:10:25-07"}, "chassis_subtype": {"enum": ["chassis_component", "if_alias", "port_component", "mac_address", "network_address", "if_name", "locally_assigned"], "type": "string", "description": "Subtype of the Chassis ID. It can be one of the following:\n* Chassis Component (1): possibly EntPhysicalAlias (RFC 4133)\n* Interface Alias (2): ifAlias (RFC 2863)\n* Port Component (3): possibly EntPhysicalAlias (RFC 4133)\n* MAC Address (4): MAC address\n* Network Address (5): networkAddress\n* Interface Name (6): ifName (RFC 2863)\n* Locally Assigned (7): local, alpha numeric string", "example": "locally_assigned"}, "supported_capabilities": {"type": "integer", "description": "A bit map specifying the capabilities supported by the sender\n>Bit 1: Other\n>Bit 2: Repeater (RFC 2108)\n>Bit 3: MAC Bridge (IEEE 802.1D)\n>Bit 4: WLAN Access Point (IEEE 802.11 MIB)\n>Bit 5: Router (RFC 1812)\n>Bit 6: Telephone (RFC 4293)\n>Bit 7: DOCSIS Cable Device (RFC 4693, RFC 4546)\n>Bit 8: Station Only (RFC 4293)\n>Bit 9: C-VLAN Component of VLAN Bridge (IEEE 802.1Q)\n>Bit 10: S-VLAN Component of VLAN Bridge (IEEE 802.1Q)\n>Bit 11: Two-port MAC Relay (IEEE 802.1Q)\n", "example": 128}, "lag_id": {"type": "integer", "description": "LAG ID of remote end. This is carried in the LAG TLV.\nAs specified in Annex E.8 of IEEE 802.1AB", "example": 0}, "system_name": {"type": "string", "description": "System Name of received neighbor.\nAn alpha-numeric string indicating administratively assigned name (should be fully qualified name or sysName as specified by RFC 3418).", "example": "My System ID"}, "mgmt_address": {"type": "string", "description": "Management Address of received neighbor. What's contained in this field is defined by the `mgmt_address_subtype` field.", "example": "10.10.1.100"}, "system_description": {"type": "string", "description": "System Description of received neighbor. An alpha-numeric string specifying system's hardware, operating system, and networking software.\nIf RFC 3418 is supported, sysDescr should be used.", "example": "My System Description"}, "mgmt_address_ifnum": {"type": "integer", "description": "Interface number of management address of received neighbor. What's contained in this field is defined by the `mgmt_address_ifnum_subtype` field.", "example": 0}, "mgmt_address_subtype": {"type": "integer", "description": "Management Address Subtype of received neighbor.\nSee: https://www.iana.org/assignments/protocol-numbers/ protocol-numbers.xhtml", "example": 4}, "neighbor_type": {"readOnly": true, "enum": ["cdp", "lldp", "user"], "type": "string", "example": "cdp"}, "port_vlanid": {"type": "integer", "description": "The VLAN ID of the port. A value of zero shall be used if the system doesn't know the PVID or not support port-based VLAN operation", "example": 0}, "enabled_capabilities": {"type": "integer", "description": "A bit map specifying the currently enabled capabilities:\n>Bit 1: Other\n>Bit 2: Repeater (RFC 2108)\n>Bit 3: MAC Bridge (IEEE 802.1D)\n>Bit 4: WLAN Access Point (IEEE 802.11 MIB)\n>Bit 5: Router (RFC 1812)\n>Bit 6: Telephone (RFC 4293)\n>Bit 7: DOCSIS Cable Device (RFC 4693, RFC 4546)\n>Bit 8: Station Only (RFC 4293)\n>Bit 9: C-VLAN Component of VLAN Bridge (IEEE 802.1Q)\n>Bit 10: S-VLAN Component of VLAN Bridge (IEEE 802.1Q)\n>Bit 11: Two-port MAC Relay (IEEE 802.1Q)\n", "example": 128}, "stale": {"readOnly": true, "type": "boolean", "description": "When `True`, this field indicates that the neighbor has aged out on the switch, but has not yet been purged from CFM. When set to `False`, the neighbor is active."}, "station_mac_address": {"example": "E0:39:D7:90:1B:00", "description": "MAC address of switch on which neighbor was received.", "format": "mac_address"}}, "title": "Object: Neighbor Discovery Neighbor"}, "neighbor_discovery_advertisement_create": {"additionalProperties": false, "required": ["switch_uuid", "port_uuid", "chassis_id", "chassis_subtype", "port_id", "port_subtype"], "type": "object", "properties": {"port_description": {"type": "string", "description": "IEEE 802 LAN station's port description of received neighbor. This is an alpha-numeric string that should be `ifDescr` if RFC 2863 is implemented.", "example": "My port description"}, "port_uuid": {"description": "The UUID of the port the neighbor was received on.", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": false, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "ttl": {"type": "integer", "description": "Time To Live. Amount of time, in seconds, the neighbor is valid.", "example": 60}, "port_id": {"type": "string", "description": "Port ID of the received neighbor.", "example": "My-Port-ID"}, "mgmt_address_ifnum_subtype": {"type": "integer", "description": "Subtype of the Interface Number in the received neighbor. It can be one of 3 values:\n* Unknown (1)\n* ifIndex (2)\n* System port number (3)", "example": 2}, "port_subtype": {"enum": ["if_alias", "port_component", "mac_address", "network_address", "if_name", "agent_circuit", "locally_assigned"], "type": "string", "description": "Subtype of the Port ID. It can be one of the following:\n* Interface Alias (1): ifAlias (RFC 2863)\n* Port Component (2): possibly entPhysicalAlias (RFC 4133)\n* MAC Address (3): MAC address\n* Network Address (4): networkAddress\n* Interface Name (5): ifName (RFC 2863)\n* Agent Circuit ID (6): agent circuit ID (RFC 3046)\n* Locally Assigned (7): local, alpha numeric string", "example": "mac_address"}, "chassis_id": {"type": "string", "description": "Chassis ID of neighbor. What's in this field is specified by the `Chassis Subtype`.", "example": "My-Chassis-ID"}, "source_mac_address": {"description": "MAC Address of _sender_ of LLDP/CDP neighbor.", "example": "F0:AC:12:C9:34:A0", "format": "mac_address"}, "switch_uuid": {"description": "The UUID of the switch the neighbor was received on.", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": false, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "last_modified": {"readOnly": true, "type": "string", "description": "Date/time the neighbor was last updated.", "example": "2016-06-22 19:10:25-07"}, "chassis_subtype": {"enum": ["chassis_component", "if_alias", "port_component", "mac_address", "network_address", "if_name", "locally_assigned"], "type": "string", "description": "Subtype of the Chassis ID. It can be one of the following:\n* Chassis Component (1): possibly EntPhysicalAlias (RFC 4133)\n* Interface Alias (2): ifAlias (RFC 2863)\n* Port Component (3): possibly EntPhysicalAlias (RFC 4133)\n* MAC Address (4): MAC address\n* Network Address (5): networkAddress\n* Interface Name (6): ifName (RFC 2863)\n* Locally Assigned (7): local, alpha numeric string", "example": "locally_assigned"}, "supported_capabilities": {"type": "integer", "description": "A bit map specifying the capabilities supported by the sender\n>Bit 1: Other\n>Bit 2: Repeater (RFC 2108)\n>Bit 3: MAC Bridge (IEEE 802.1D)\n>Bit 4: WLAN Access Point (IEEE 802.11 MIB)\n>Bit 5: Router (RFC 1812)\n>Bit 6: Telephone (RFC 4293)\n>Bit 7: DOCSIS Cable Device (RFC 4693, RFC 4546)\n>Bit 8: Station Only (RFC 4293)\n>Bit 9: C-VLAN Component of VLAN Bridge (IEEE 802.1Q)\n>Bit 10: S-VLAN Component of VLAN Bridge (IEEE 802.1Q)\n>Bit 11: Two-port MAC Relay (IEEE 802.1Q)\n", "example": 128}, "lag_id": {"type": "integer", "description": "LAG ID of remote end. This is carried in the LAG TLV.\nAs specified in Annex E.8 of IEEE 802.1AB", "example": 0}, "system_name": {"type": "string", "description": "System Name of received neighbor.\nAn alpha-numeric string indicating administratively assigned name (should be fully qualified name or sysName as specified by RFC 3418).", "example": "My System ID"}, "mgmt_address": {"type": "string", "description": "Management Address of received neighbor. What's contained in this field is defined by the `mgmt_address_subtype` field.", "example": "10.10.1.100"}, "system_description": {"type": "string", "description": "System Description of received neighbor. An alpha-numeric string specifying system's hardware, operating system, and networking software.\nIf RFC 3418 is supported, sysDescr should be used.", "example": "My System Description"}, "mgmt_address_ifnum": {"type": "integer", "description": "Interface number of management address of received neighbor. What's contained in this field is defined by the `mgmt_address_ifnum_subtype` field.", "example": 0}, "mgmt_address_subtype": {"type": "integer", "description": "Management Address Subtype of received neighbor.\nSee: https://www.iana.org/assignments/protocol-numbers/ protocol-numbers.xhtml", "example": 4}, "neighbor_type": {"readOnly": true, "enum": ["cdp", "lldp", "user"], "type": "string", "example": "cdp"}, "port_vlanid": {"type": "integer", "description": "The VLAN ID of the port. A value of zero shall be used if the system doesn't know the PVID or not support port-based VLAN operation", "example": 0}, "enabled_capabilities": {"type": "integer", "description": "A bit map specifying the currently enabled capabilities:\n>Bit 1: Other\n>Bit 2: Repeater (RFC 2108)\n>Bit 3: MAC Bridge (IEEE 802.1D)\n>Bit 4: WLAN Access Point (IEEE 802.11 MIB)\n>Bit 5: Router (RFC 1812)\n>Bit 6: Telephone (RFC 4293)\n>Bit 7: DOCSIS Cable Device (RFC 4693, RFC 4546)\n>Bit 8: Station Only (RFC 4293)\n>Bit 9: C-VLAN Component of VLAN Bridge (IEEE 802.1Q)\n>Bit 10: S-VLAN Component of VLAN Bridge (IEEE 802.1Q)\n>Bit 11: Two-port MAC Relay (IEEE 802.1Q)\n", "example": 128}, "stale": {"readOnly": true, "type": "boolean", "description": "When `True`, this field indicates that the neighbor has aged out on the switch, but has not yet been purged from CFM. When set to `False`, the neighbor is active."}, "station_mac_address": {"description": "MAC address of switch on which neighbor was received.", "example": "E0:39:D7:90:1B:00", "format": "mac_address"}}, "title": "Object: User-Defined Neighbor (Create)"}, "neighbor_discovery_advertisement_update": {"additionalProperties": false, "required": ["switch_uuid", "port_uuid", "chassis_id", "chassis_subtype", "port_id", "port_subtype"], "type": "object", "properties": {"port_description": {"type": "string", "description": "IEEE 802 LAN station's port description of received neighbor. This is an alpha-numeric string that should be `ifDescr` if RFC 2863 is implemented.", "example": "My port description"}, "port_uuid": {"description": "The UUID of the port the neighbor was received on.", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": false, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "ttl": {"type": "integer", "description": "Time To Live. Amount of time, in seconds, the neighbor is valid.", "example": 60}, "port_id": {"type": "string", "description": "Port ID of the received neighbor.", "example": "My-Port-ID"}, "mgmt_address_ifnum_subtype": {"type": "integer", "description": "Subtype of the Interface Number in the received neighbor. It can be one of 3 values:\n* Unknown (1)\n* ifIndex (2)\n* System port number (3)", "example": 2}, "uuid": {"description": "UUID of the neighbor.", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "port_subtype": {"enum": ["if_alias", "port_component", "mac_address", "network_address", "if_name", "agent_circuit", "locally_assigned"], "type": "string", "description": "Subtype of the Port ID. It can be one of the following:\n* Interface Alias (1): ifAlias (RFC 2863)\n* Port Component (2): possibly entPhysicalAlias (RFC 4133)\n* MAC Address (3): MAC address\n* Network Address (4): networkAddress\n* Interface Name (5): ifName (RFC 2863)\n* Agent Circuit ID (6): agent circuit ID (RFC 3046)\n* Locally Assigned (7): local, alpha numeric string", "example": "mac_address"}, "chassis_id": {"type": "string", "description": "Chassis ID of neighbor. What's in this field is specified by the `Chassis Subtype`.", "example": "My-Chassis-ID"}, "source_mac_address": {"format": "mac_address", "example": "F0:AC:12:C9:34:A0", "description": "MAC Address of _sender_ of LLDP/CDP neighbor."}, "switch_uuid": {"description": "The UUID of the switch the neighbor was received on.", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": false, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "last_modified": {"readOnly": true, "type": "string", "description": "Date/time the neighbor was last updated.", "example": "2016-06-22 19:10:25-07"}, "chassis_subtype": {"enum": ["chassis_component", "if_alias", "port_component", "mac_address", "network_address", "if_name", "locally_assigned"], "type": "string", "description": "Subtype of the Chassis ID. It can be one of the following:\n* Chassis Component (1): possibly EntPhysicalAlias (RFC 4133)\n* Interface Alias (2): ifAlias (RFC 2863)\n* Port Component (3): possibly EntPhysicalAlias (RFC 4133)\n* MAC Address (4): MAC address\n* Network Address (5): networkAddress\n* Interface Name (6): ifName (RFC 2863)\n* Locally Assigned (7): local, alpha numeric string", "example": "locally_assigned"}, "supported_capabilities": {"type": "integer", "description": "A bit map specifying the capabilities supported by the sender\n>Bit 1: Other\n>Bit 2: Repeater (RFC 2108)\n>Bit 3: MAC Bridge (IEEE 802.1D)\n>Bit 4: WLAN Access Point (IEEE 802.11 MIB)\n>Bit 5: Router (RFC 1812)\n>Bit 6: Telephone (RFC 4293)\n>Bit 7: DOCSIS Cable Device (RFC 4693, RFC 4546)\n>Bit 8: Station Only (RFC 4293)\n>Bit 9: C-VLAN Component of VLAN Bridge (IEEE 802.1Q)\n>Bit 10: S-VLAN Component of VLAN Bridge (IEEE 802.1Q)\n>Bit 11: Two-port MAC Relay (IEEE 802.1Q)\n", "example": 128}, "lag_id": {"type": "integer", "description": "LAG ID of remote end. This is carried in the LAG TLV.\nAs specified in Annex E.8 of IEEE 802.1AB", "example": 0}, "system_name": {"type": "string", "description": "System Name of received neighbor.\nAn alpha-numeric string indicating administratively assigned name (should be fully qualified name or sysName as specified by RFC 3418).", "example": "My System ID"}, "mgmt_address": {"type": "string", "description": "Management Address of received neighbor. What's contained in this field is defined by the `mgmt_address_subtype` field.", "example": "10.10.1.100"}, "system_description": {"type": "string", "description": "System Description of received neighbor. An alpha-numeric string specifying system's hardware, operating system, and networking software.\nIf RFC 3418 is supported, sysDescr should be used.", "example": "My System Description"}, "mgmt_address_ifnum": {"type": "integer", "description": "Interface number of management address of received neighbor. What's contained in this field is defined by the `mgmt_address_ifnum_subtype` field.", "example": 0}, "mgmt_address_subtype": {"type": "integer", "description": "Management Address Subtype of received neighbor.\nSee: https://www.iana.org/assignments/protocol-numbers/ protocol-numbers.xhtml", "example": 4}, "neighbor_type": {"readOnly": true, "enum": ["cdp", "lldp", "user"], "type": "string", "example": "cdp"}, "port_vlanid": {"type": "integer", "description": "The VLAN ID of the port. A value of zero shall be used if the system doesn't know the PVID or not support port-based VLAN operation", "example": 0}, "enabled_capabilities": {"type": "integer", "description": "A bit map specifying the currently enabled capabilities:\n>Bit 1: Other\n>Bit 2: Repeater (RFC 2108)\n>Bit 3: MAC Bridge (IEEE 802.1D)\n>Bit 4: WLAN Access Point (IEEE 802.11 MIB)\n>Bit 5: Router (RFC 1812)\n>Bit 6: Telephone (RFC 4293)\n>Bit 7: DOCSIS Cable Device (RFC 4693, RFC 4546)\n>Bit 8: Station Only (RFC 4293)\n>Bit 9: C-VLAN Component of VLAN Bridge (IEEE 802.1Q)\n>Bit 10: S-VLAN Component of VLAN Bridge (IEEE 802.1Q)\n>Bit 11: Two-port MAC Relay (IEEE 802.1Q)\n", "example": 128}, "stale": {"readOnly": true, "type": "boolean", "description": "When `True`, this field indicates that the neighbor has aged out on the switch, but has not yet been purged from CFM. When set to `False`, the neighbor is active."}, "station_mac_address": {"format": "mac_address", "example": "E0:39:D7:90:1B:00", "description": "MAC address of switch on which neighbor was received."}}, "title": "Object: User-Defined Neighbor (Update)"}, "neighbor_discovery_configuration": {"additionalProperties": false, "required": ["uuid", "lldp_mode", "cdp_mode", "is_default"], "type": "object", "properties": {"is_default": {"readOnly": true, "type": "boolean", "description": "Is this the fabric-wide default configuration?"}, "switch_uuids": {"items": {"readOnly": true, "description": "Switch UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array", "description": "List of switch UUIDs."}, "fabric_uuid": {"readOnly": true, "description": "Fabric UUID.", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "description": {"type": "string", "example": "My neighbor discovery configuration"}, "name": {"type": "string", "example": "Neighbor-discovery-configuration"}, "lldp_mode": {"default": "rx_only", "enum": ["disable", "rx_only", "tx_only", "rx_and_tx"], "type": "string", "description": "LLDP neighbor discovery protocol mode.", "example": "rx_only"}, "uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "cdp_mode": {"default": "disable", "enum": ["disable", "rx_only"], "type": "string", "description": "CDP neighbor discovery protocol mode.", "example": "disable"}}, "title": "Object: Neighbor Discovery Configuration"}, "neighbor_discovery_configuration_create": {"additionalProperties": false, "required": ["lldp_mode", "cdp_mode"], "type": "object", "properties": {"description": {"type": "string", "example": "My neighbor discovery configuration"}, "cdp_mode": {"default": "disable", "enum": ["disable", "rx_only"], "type": "string", "description": "CDP neighbor discovery protocol mode.", "example": "disable"}, "switch_uuids": {"items": {"description": "Switch UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array", "description": "List of switch UUIDs."}, "lldp_mode": {"default": "rx_only", "enum": ["disable", "rx_only", "tx_only", "rx_and_tx"], "type": "string", "description": "LLDP neighbor discovery protocol mode.", "example": "rx_only"}, "name": {"type": "string", "example": "Neighbor-discovery-configuration"}}, "title": "Object: Neighbor Discovery Configuration (Create)"}, "neighbor_discovery_configuration_update": {"additionalProperties": false, "required": ["lldp_mode", "cdp_mode"], "type": "object", "properties": {"description": {"type": "string", "example": "My neighbor discovery configuration"}, "uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "cdp_mode": {"default": "disable", "enum": ["disable", "rx_only"], "type": "string", "description": "CDP neighbor discovery protocol mode.", "example": "disable"}, "switch_uuids": {"items": {"description": "Switch UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array", "description": "List of switch UUIDs."}, "lldp_mode": {"default": "rx_only", "enum": ["disable", "rx_only", "tx_only", "rx_and_tx"], "type": "string", "description": "LLDP neighbor discovery protocol mode.", "example": "rx_only"}, "name": {"type": "string", "example": "Neighbor-discovery-configuration"}}, "title": "Object: Neighbor Discovery Configuration (Update)"}, "neighbor_discovery_statistic": {"additionalProperties": false, "required": ["switch_uuid", "port_uuid", "rx_packets", "rx_discards", "rx_errors", "tx_packets", "tx_discards", "tx_errors", "tlv_unknowns"], "type": "object", "properties": {"switch_uuid": {"minLength": 32, "example": "86e3fac968f436398d7379ad93895a36", "type": "string", "description": "The UUID of the switch the neighbor statistic was collected on.", "maxLength": 36}, "statistics": {"items": {"type": "object", "properties": {"tlv_unknowns": {"type": "integer", "description": "Number of Unknown TLVs in Received LLDP Packets.", "example": "0"}, "rx_packets": {"type": "integer", "description": "Count of Received LLDP Packets.", "example": "100"}, "port_uuid": {"minLength": 32, "example": "783eff3f768f434399d7379ad93a8393", "type": "string", "description": "The UUID of the port the neighbor statistic was collected on.", "maxLength": 36}, "rx_errors": {"type": "integer", "description": "LLDP Packets Received Containing Errors.", "example": "9"}, "tx_errors": {"type": "integer", "description": "Number of Transmitted LLDP Packets Containing Errors.", "example": "8"}, "rx_discards": {"type": "integer", "description": "Discarded Received LLDP Packets.", "example": "0"}, "tx_packets": {"type": "integer", "description": "Count of Transmitted LLDP Packets", "example": "100"}, "tx_discards": {"type": "integer", "description": "Discarded Transmit LLDP Packets.", "example": "10"}}}, "type": "array", "description": "Array of Port-Level LLDP Statistics"}}, "title": "Object: Neighbor Discovery Statistic"}, "nsx_pack_config": {"additionalProperties": false, "required": ["uuid", "host", "username", "verify_ssl", "enabled", "connection_state", "connection_fault_string", "last_connection", "cache_sync_status"], "type": "object", "properties": {"username": {"minLength": 1, "format": "non_empty_or_whitespace_string", "type": "string", "example": "admin", "maxLength": 200}, "connection_state": {"readOnly": true, "enum": ["created", "deleted", "disabled", "disconnected", "degraded", "connected"], "type": "string", "description": "Indicates the state of the connection to VMware NSX", "example": "disconnected"}, "last_connection": {"minLength": 9, "description": "UTC epoch time of last successful connection", "type": "integer", "example": "1497602656", "maxLength": 11}, "description": {"type": "string", "example": "", "maxLength": 1000}, "host": {"description": "Hostname or IP address of VMware NSX", "format": "hostname", "minLength": 2, "maxLength": 200, "type": "string", "example": "nsx-manager.example.com"}, "name": {"format": "non_empty_or_whitespace_string", "type": "string", "example": "My NSX Configuration", "maxLength": 200}, "uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "enabled": {"default": true, "type": "boolean", "description": "Indicates whether this configuration should be enabled", "example": true}, "verify_ssl": {"default": false, "type": "boolean", "description": "Indicates whether SSL/TLS certificates should be validated when connecting to VMware NSX", "example": false}, "connection_fault_string": {"readOnly": true, "type": "string", "example": "Connection error message if not connected"}, "cache_sync_status": {"type": "object", "description": "Cache Sync Status provides information related to the state of the pack's object cache. It provides if a cache build is in progress, the reason why it is building, and the start and end times of the cache build process. At the start of a cache build, cache_sync_start is set to the current time, while cache_sync_complete is set to zero. At the completion of the cache build, cache_sync_complete is updated with the current time.", "properties": {"cache_sync": {"default": false, "readOnly": true, "type": "boolean", "description": "Indicates if a cache sync is in progress", "example": false}, "cache_sync_reason": {"readOnly": true, "enum": ["upgrade", "sensor_restart", "timer_expiration", "connection_reestablished"], "type": "string", "description": "Indicates the reason why a cache sync occurred", "example": "upgrade"}, "cache_sync_start": {"readOnly": true, "example": "1497902632", "type": "integer", "description": "UTC epoch time of cache sync start", "format": "int64"}, "cache_sync_complete": {"readOnly": true, "example": "1497902632", "type": "integer", "description": "UTC epoch time of cache sync complete", "format": "int64"}}}, "pack": {"readOnly": true, "type": "string", "example": "Pack type"}}, "title": "Object: VMware NSX Pack Configuration"}, "nsx_pack_config_create": {"additionalProperties": false, "required": ["host", "username", "verify_ssl", "enabled", "password"], "type": "object", "properties": {"username": {"minLength": 1, "maxLength": 200, "type": "string", "example": "admin", "format": "non_empty_or_whitespace_string"}, "password": {"minLength": 1, "maxLength": 200, "type": "string", "format": "password"}, "verify_ssl": {"default": false, "type": "boolean", "description": "Indicates whether SSL/TLS certificates should be validated when connecting to VMware NSX", "example": false}, "description": {"type": "string", "example": "", "maxLength": 1000}, "enabled": {"default": true, "type": "boolean", "description": "Indicates whether this configuration should be enabled", "example": true}, "host": {"description": "Hostname or IP address of VMware NSX", "format": "hostname", "minLength": 2, "maxLength": 200, "type": "string", "example": "nsx-manager.example.com"}, "pack": {"readOnly": true, "type": "string", "example": "Pack type"}, "name": {"maxLength": 200, "type": "string", "example": "My NSX Configuration", "format": "non_empty_or_whitespace_string"}}, "title": "Object: VMware NSX Pack Configuration (create)"}, "nsx_pack_config_update": {"additionalProperties": false, "type": "object", "properties": {"username": {"minLength": 1, "format": "non_empty_or_whitespace_string", "type": "string", "example": "admin", "maxLength": 200}, "description": {"type": "string", "example": "", "maxLength": 1000}, "enabled": {"default": true, "type": "boolean", "description": "Indicates whether this configuration should be enabled", "example": true}, "host": {"description": "Hostname or IP address of VMware NSX", "format": "hostname", "minLength": 2, "maxLength": 200, "type": "string", "example": "nsx-manager.example.com"}, "name": {"format": "non_empty_or_whitespace_string", "type": "string", "example": "My NSX Configuration", "maxLength": 200}, "verify_ssl": {"default": false, "type": "boolean", "description": "Indicates whether SSL/TLS certificates should be validated when connecting to VMware NSX", "example": false}, "password": {"minLength": 1, "format": "password", "type": "string", "maxLength": 200}, "pack": {"readOnly": true, "type": "string", "example": "Pack type"}}, "title": "Object: VMware NSX Pack Configuration (update)"}, "nsx_pack_config_verify": {"additionalProperties": false, "required": ["host", "username", "verify_ssl", "enabled", "password"], "type": "object", "properties": {"username": {"minLength": 1, "format": "non_empty_or_whitespace_string", "type": "string", "example": "admin", "maxLength": 200}, "description": {"type": "string", "example": "", "maxLength": 1000}, "enabled": {"default": true, "type": "boolean", "description": "Indicates whether this configuration should be enabled", "example": true}, "host": {"description": "Hostname or IP address of VMware NSX", "format": "hostname", "minLength": 2, "maxLength": 200, "type": "string", "example": "nsx-manager.example.com"}, "name": {"type": "string", "example": "My NSX Configuration", "maxLength": 200}, "verify_ssl": {"default": false, "type": "boolean", "description": "Indicates whether SSL/TLS certificates should be validated when connecting to VMware NSX", "example": false}, "password": {"minLength": 1, "format": "password", "type": "string", "maxLength": 200}, "pack": {"readOnly": true, "type": "string", "example": "Pack type"}}, "title": "Object: VMware NSX Pack Configuration (verify)"}, "ntp_client_configuration": {"additionalProperties": false, "required": ["description", "fabric_uuids", "name", "servers", "switch_uuids", "uuid"], "type": "object", "properties": {"set_by_dhcp": {"readOnly": true, "type": "boolean", "description": "Whether or not DHCP created this NTP client configuration.", "example": false}, "uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "name": {"type": "string", "example": "My NTP Client Configuration", "format": "non_empty_or_whitespace_string"}, "servers": {"minItems": 1, "items": {"type": "string", "example": "yourhost.com"}, "type": "array", "description": "List of NTP servers in ipv4, ipv6 or hostname format"}, "switch_uuids": {"items": {"readOnly": true, "description": "Switch UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array", "description": "UUIDs of switches this NTP Client Configuration is applied to. To exclude, specify value as the empty array: __`[]`__"}, "fabric_uuids": {"items": {"readOnly": true, "description": "Fabric UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array", "description": "UUIDs of fabrics this NTP Client Configuration is applied to. When using `fabric_uuid` the configuration will be applied to all switches in the fabric. If the fabric is expanded the new switch will automatically pick up the new settings covered by `fabric_uuid`. To exclude, specify value as the empty array: __`[]`__"}, "description": {"type": "string", "example": "This is NTP Client Configuration for the entire Big City Campus"}}, "title": "Object: NTP Client Configuration"}, "ntp_client_configuration_create": {"additionalProperties": false, "required": ["fabric_uuids", "name", "servers", "switch_uuids"], "type": "object", "properties": {"name": {"type": "string", "example": "My NTP Client Configuration", "format": "non_empty_or_whitespace_string"}, "servers": {"minItems": 1, "items": {"type": "string", "example": "yourhost.com"}, "type": "array", "description": "List of NTP servers in ipv4, ipv6 or hostname format"}, "switch_uuids": {"items": {"description": "Switch UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array", "description": "UUIDs of switches this NTP Client Configuration is applied to. To exclude, specify value as the empty array: __`[]`__"}, "fabric_uuids": {"items": {"description": "Fabric UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array", "description": "UUIDs of fabrics this NTP Client Configuration is applied to. When using `fabric_uuid` the configuration will be applied to all switches in the fabric. If the fabric is expanded the new switch will automatically pick up the new settings covered by `fabric_uuid`. To exclude, specify value as the empty array: __`[]`__"}, "description": {"type": "string", "example": "This is NTP Client Configuration for the entire Big City Campus"}}, "title": "Object: NTP Client Configuration (Create)"}, "ntp_client_configuration_update": {"additionalProperties": false, "required": ["fabric_uuids", "name", "servers", "switch_uuids"], "type": "object", "properties": {"set_by_dhcp": {"readOnly": true, "type": "boolean", "description": "Whether or not DHCP created this NTP client configuration.", "example": false}, "uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "description": {"type": "string", "example": "This is NTP Client Configuration for the entire Big City Campus"}, "servers": {"minItems": 1, "items": {"type": "string", "example": "yourhost.com"}, "type": "array", "description": "List of NTP servers in ipv4, ipv6 or hostname format"}, "switch_uuids": {"items": {"description": "Switch UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array", "description": "UUIDs of switches this NTP Client Configuration is applied to. To exclude, specify value as the empty array: __`[]`__"}, "fabric_uuids": {"items": {"description": "Fabric UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array", "description": "UUIDs of fabrics this NTP Client Configuration is applied to. When using `fabric_uuid` the configuration will be applied to all switches in the fabric. If the fabric is expanded the new switch will automatically pick up the new settings covered by `fabric_uuid`. To exclude, specify value as the empty array: __`[]`__"}, "name": {"type": "string", "example": "My NTP Client Configuration", "format": "non_empty_or_whitespace_string"}}, "title": "Object: NTP Client Configuration (Update)"}, "nutanix_pack_config": {"additionalProperties": false, "required": ["uuid", "host", "username", "verify_ssl", "enabled", "fitting", "prism_visualization", "vlan_provisioning", "connection_state", "connection_fault_string", "last_connection", "cache_sync_status"], "type": "object", "properties": {"username": {"minLength": 1, "format": "non_empty_or_whitespace_string", "type": "string", "example": "admin", "maxLength": 200}, "connection_state": {"readOnly": true, "enum": ["created", "deleted", "disabled", "disconnected", "degraded", "connected"], "type": "string", "description": "Indicates the state of the connection to Nutanix Prism", "example": "disconnected"}, "cache_sync_status": {"type": "object", "description": "Cache Sync Status provides information related to the state of the pack's object cache. It provides if a cache build is in progress, the reason why it is building, and the start and end times of the cache build process. At the start of a cache build, cache_sync_start is set to the current time, while cache_sync_complete is set to zero. At the completion of the cache build, cache_sync_complete is updated with the current time.", "properties": {"cache_sync": {"default": false, "readOnly": true, "type": "boolean", "description": "Indicates if a cache sync is in progress", "example": false}, "cache_sync_reason": {"readOnly": true, "enum": ["upgrade", "sensor_restart", "timer_expiration", "connection_reestablished"], "type": "string", "description": "Indicates the reason why a cache sync occurred", "example": "upgrade"}, "cache_sync_start": {"readOnly": true, "example": "1497902632", "type": "integer", "description": "UTC epoch time of cache sync start", "format": "int64"}, "cache_sync_complete": {"readOnly": true, "example": "1497902632", "type": "integer", "description": "UTC epoch time of cache sync complete", "format": "int64"}}}, "vlan_provisioning": {"default": false, "type": "boolean", "description": "Indicates whether VLANs will be automatically provisioned when the Acropolis Hypervisor is used", "example": false}, "uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "fitting": {"default": false, "type": "boolean", "description": "Indicates if CVM network traffic will be affinitized through Fitting. This ensures that there is enough bandwidth available for the CVM traffic and minimizes interference from CVM traffic over user traffic.", "example": false}, "description": {"type": "string", "example": "", "maxLength": 1000}, "enabled": {"default": true, "type": "boolean", "description": "Indicates whether this configuration should be enabled", "example": true}, "verify_ssl": {"default": false, "type": "boolean", "description": "Indicates whether SSL/TLS certificates should be validated when connecting to Nutanix Prism", "example": false}, "prism_visualization": {"default": false, "type": "boolean", "description": "Indicates whether Nutanix Prism's Network Visualization will be populated when the Acropolis Hypervisor is used. This data is also used to aid in automated VLAN Provisioning.", "example": false}, "host": {"description": "Hostname or IP address of Nutanix Prism", "format": "hostname", "minLength": 2, "maxLength": 200, "type": "string", "example": "prism.example.com"}, "pack": {"readOnly": true, "type": "string", "example": "Pack type"}, "connection_fault_string": {"readOnly": true, "type": "string", "example": "Connection error message if not connected"}, "last_connection": {"minLength": 9, "description": "UTC epoch time of last successful connection", "type": "integer", "example": "1497602656", "maxLength": 11}, "vlan_range": {"default": "1-4000", "example": "1-4000", "type": "string", "description": "No actions will be taken on VLANs outside this range. If blank, all supported VLANs (1-4000) will be managed by Composable Fabric Manager.", "format": "vlan-range"}, "name": {"format": "non_empty_or_whitespace_string", "type": "string", "example": "My Nutanix Configuration", "maxLength": 200}}, "title": "Object: Nutanix Prism Pack Configuration"}, "nutanix_pack_config_create": {"additionalProperties": false, "required": ["host", "username", "verify_ssl", "enabled", "fitting", "prism_visualization", "vlan_provisioning", "password"], "type": "object", "properties": {"username": {"minLength": 1, "maxLength": 200, "type": "string", "example": "admin", "format": "non_empty_or_whitespace_string"}, "password": {"minLength": 1, "maxLength": 200, "type": "string", "format": "password"}, "vlan_range": {"default": "1-4000", "format": "vlan-range", "type": "string", "example": "1-4000", "description": "No actions will be taken on VLANs outside this range. If blank, all supported VLANs (1-4000) will be managed by Composable Fabric Manager."}, "vlan_provisioning": {"default": false, "type": "boolean", "description": "Indicates whether VLANs will be automatically provisioned when the Acropolis Hypervisor is used", "example": false}, "name": {"maxLength": 200, "type": "string", "example": "My Nutanix Configuration", "format": "non_empty_or_whitespace_string"}, "enabled": {"default": true, "type": "boolean", "description": "Indicates whether this configuration should be enabled", "example": true}, "verify_ssl": {"default": false, "type": "boolean", "description": "Indicates whether SSL/TLS certificates should be validated when connecting to Nutanix Prism", "example": false}, "prism_visualization": {"default": false, "type": "boolean", "description": "Indicates whether Nutanix Prism's Network Visualization will be populated when the Acropolis Hypervisor is used. This data is also used to aid in automated VLAN Provisioning.", "example": false}, "fitting": {"default": false, "type": "boolean", "description": "Indicates if CVM network traffic will be affinitized through Fitting. This ensures that there is enough bandwidth available for the CVM traffic and minimizes interference from CVM traffic over user traffic.", "example": false}, "host": {"description": "Hostname or IP address of Nutanix Prism", "format": "hostname", "minLength": 2, "maxLength": 200, "type": "string", "example": "prism.example.com"}, "pack": {"readOnly": true, "type": "string", "example": "Pack type"}, "description": {"type": "string", "example": "", "maxLength": 1000}}, "title": "Object: Nutanix Prism Pack Configuration (create)"}, "nutanix_pack_config_update": {"additionalProperties": false, "type": "object", "properties": {"username": {"minLength": 1, "format": "non_empty_or_whitespace_string", "type": "string", "example": "admin", "maxLength": 200}, "password": {"minLength": 1, "format": "password", "type": "string", "maxLength": 200}, "vlan_provisioning": {"default": false, "type": "boolean", "description": "Indicates whether VLANs will be automatically provisioned when the Acropolis Hypervisor is used", "example": false}, "name": {"format": "non_empty_or_whitespace_string", "type": "string", "example": "My Nutanix Configuration", "maxLength": 200}, "description": {"type": "string", "example": "", "maxLength": 1000}, "enabled": {"default": true, "type": "boolean", "description": "Indicates whether this configuration should be enabled", "example": true}, "prism_visualization": {"default": false, "type": "boolean", "description": "Indicates whether Nutanix Prism's Network Visualization will be populated when the Acropolis Hypervisor is used. This data is also used to aid in automated VLAN Provisioning.", "example": false}, "verify_ssl": {"default": false, "type": "boolean", "description": "Indicates whether SSL/TLS certificates should be validated when connecting to Nutanix Prism", "example": false}, "pack": {"readOnly": true, "type": "string", "example": "Pack type"}, "host": {"description": "Hostname or IP address of Nutanix Prism", "format": "hostname", "minLength": 2, "maxLength": 200, "type": "string", "example": "prism.example.com"}, "vlan_range": {"default": "1-4000", "description": "No actions will be taken on VLANs outside this range. If blank, all supported VLANs (1-4000) will be managed by Composable Fabric Manager.", "type": "string", "example": "1-4000", "format": "vlan-range"}, "fitting": {"default": false, "type": "boolean", "description": "Indicates if CVM network traffic will be affinitized through Fitting. This ensures that there is enough bandwidth available for the CVM traffic and minimizes interference from CVM traffic over user traffic.", "example": false}}, "title": "Object: Nutanix Prism Pack Configuration (update)"}, "nutanix_pack_config_verify": {"additionalProperties": false, "required": ["host", "username", "verify_ssl", "enabled", "fitting", "prism_visualization", "vlan_provisioning", "password"], "type": "object", "properties": {"username": {"minLength": 1, "format": "non_empty_or_whitespace_string", "type": "string", "example": "admin", "maxLength": 200}, "password": {"minLength": 1, "format": "password", "type": "string", "maxLength": 200}, "vlan_provisioning": {"default": false, "type": "boolean", "description": "Indicates whether VLANs will be automatically provisioned when the Acropolis Hypervisor is used", "example": false}, "name": {"type": "string", "example": "My Nutanix Configuration", "maxLength": 200}, "description": {"type": "string", "example": "", "maxLength": 1000}, "enabled": {"default": true, "type": "boolean", "description": "Indicates whether this configuration should be enabled", "example": true}, "prism_visualization": {"default": false, "type": "boolean", "description": "Indicates whether Nutanix Prism's Network Visualization will be populated when the Acropolis Hypervisor is used. This data is also used to aid in automated VLAN Provisioning.", "example": false}, "verify_ssl": {"default": false, "type": "boolean", "description": "Indicates whether SSL/TLS certificates should be validated when connecting to Nutanix Prism", "example": false}, "pack": {"readOnly": true, "type": "string", "example": "Pack type"}, "host": {"description": "Hostname or IP address of Nutanix Prism", "format": "hostname", "minLength": 2, "maxLength": 200, "type": "string", "example": "prism.example.com"}, "vlan_range": {"default": "1-4000", "description": "No actions will be taken on VLANs outside this range. If blank, all supported VLANs (1-4000) will be managed by Composable Fabric Manager.", "type": "string", "example": "1-4000", "format": "vlan-range"}, "fitting": {"default": false, "type": "boolean", "description": "Indicates if CVM network traffic will be affinitized through Fitting. This ensures that there is enough bandwidth available for the CVM traffic and minimizes interference from CVM traffic over user traffic.", "example": false}}, "title": "Object: Nutanix Prism Pack Configuration (verify)"}, "oneview_pack_config": {"additionalProperties": false, "required": ["cache_sync_status", "connection_fault_string", "connection_state", "description", "enabled", "host", "last_connection", "name", "username", "uuid", "verify_ssl"], "type": "object", "properties": {"username": {"minLength": 1, "format": "non_empty_or_whitespace_string", "type": "string", "example": "admin", "maxLength": 200}, "connection_state": {"readOnly": true, "enum": ["created", "deleted", "disabled", "disconnected", "degraded", "connected"], "type": "string", "description": "Indicates the state of the connection to OneView", "example": "disconnected"}, "last_connection": {"minLength": 9, "description": "UTC epoch time of last successful connection", "type": "integer", "example": "1497602656", "maxLength": 11}, "description": {"type": "string", "example": "", "maxLength": 1000}, "host": {"description": "Hostname or IP address of OneView", "format": "hostname", "default": "", "minLength": 2, "maxLength": 200, "type": "string", "example": "oneview-host.example.com"}, "uuid": {"minLength": 32, "readOnly": true, "type": "string", "example": "18e1919e16ab43b3a553b4fc21e159d2", "maxLength": 36}, "name": {"default": "HPE OneView ", "format": "non_empty_or_whitespace_string", "type": "string", "example": "HPE OneView Configuration", "maxLength": 200}, "enabled": {"default": true, "type": "boolean", "description": "Indicates whether this configuration is enabled", "example": true}, "verify_ssl": {"default": false, "type": "boolean", "description": "Indicates whether SSL/TLS certificates should be validated when connecting to HPE OneView", "example": false}, "cache_sync_status": {"type": "object", "description": "Cache Sync Status provides information related to the state of the pack's object cache. It provides if a cache build is in progress, the reason why it is building, and the start and end times of the cache build process. At the start of a cache build, cache_sync_start is set to the current time, while cache_sync_complete is set to zero. At the completion of the cache build, cache_sync_complete is updated with the current time.", "properties": {"cache_sync": {"default": false, "readOnly": true, "type": "boolean", "description": "Indicates if a cache sync is in progress", "example": false}, "cache_sync_reason": {"readOnly": true, "enum": ["upgrade", "sensor_restart", "timer_expiration", "connection_reestablished"], "type": "string", "description": "Indicates the reason why a cache sync occurred", "example": "upgrade"}, "cache_sync_start": {"readOnly": true, "example": "1497902632", "type": "integer", "description": "UTC epoch time of cache sync start", "format": "int64"}, "cache_sync_complete": {"readOnly": true, "example": "1497902632", "type": "integer", "description": "UTC epoch time of cache sync complete", "format": "int64"}}}, "connection_fault_string": {"readOnly": true, "type": "string", "example": "Connection error message if not connected"}, "pack": {"readOnly": true, "type": "string", "example": "Pack type"}}, "title": "Object: HPE OneView Pack Configuration"}, "oneview_pack_config_create": {"additionalProperties": false, "required": ["host", "username", "password", "enabled", "password"], "type": "object", "properties": {"username": {"minLength": 1, "maxLength": 200, "type": "string", "example": "admin", "format": "non_empty_or_whitespace_string"}, "password": {"minLength": 1, "maxLength": 200, "type": "string", "format": "password"}, "enabled": {"default": true, "type": "boolean", "description": "Indicates whether this configuration is enabled", "example": true}, "verify_ssl": {"default": false, "type": "boolean", "description": "Indicates whether SSL/TLS certificates should be validated when connecting to HPE OneView", "example": false}, "name": {"default": "HPE OneView ", "maxLength": 200, "type": "string", "example": "HPE OneView Configuration", "format": "non_empty_or_whitespace_string"}, "host": {"description": "Hostname or IP address of OneView", "format": "hostname", "default": "", "minLength": 2, "maxLength": 200, "type": "string", "example": "oneview-host.example.com"}, "pack": {"readOnly": true, "type": "string", "example": "Pack type"}, "description": {"type": "string", "example": "", "maxLength": 1000}}, "title": "Object: HPE OneView Pack Configuration (create)"}, "oneview_pack_config_update": {"additionalProperties": false, "type": "object", "properties": {"username": {"minLength": 1, "format": "non_empty_or_whitespace_string", "type": "string", "example": "admin", "maxLength": 200}, "name": {"default": "HPE OneView ", "format": "non_empty_or_whitespace_string", "type": "string", "example": "HPE OneView Configuration", "maxLength": 200}, "description": {"type": "string", "example": "", "maxLength": 1000}, "enabled": {"default": true, "type": "boolean", "description": "Indicates whether this configuration is enabled", "example": true}, "host": {"description": "Hostname or IP address of OneView", "format": "hostname", "default": "", "minLength": 2, "maxLength": 200, "type": "string", "example": "oneview-host.example.com"}, "verify_ssl": {"default": false, "type": "boolean", "description": "Indicates whether SSL/TLS certificates should be validated when connecting to HPE OneView", "example": false}, "password": {"minLength": 1, "format": "password", "type": "string", "maxLength": 200}, "pack": {"readOnly": true, "type": "string", "example": "Pack type"}}, "title": "Object: HPE OneView Pack Configuration (update)"}, "oneview_pack_config_verify": {"additionalProperties": false, "required": ["host", "username", "password", "enabled", "password"], "type": "object", "properties": {"username": {"minLength": 1, "format": "non_empty_or_whitespace_string", "type": "string", "example": "admin", "maxLength": 200}, "name": {"default": "HPE OneView ", "type": "string", "example": "HPE OneView Configuration", "maxLength": 200}, "description": {"type": "string", "example": "", "maxLength": 1000}, "enabled": {"default": true, "type": "boolean", "description": "Indicates whether this configuration is enabled", "example": true}, "host": {"description": "Hostname or IP address of OneView", "format": "hostname", "default": "", "minLength": 2, "maxLength": 200, "type": "string", "example": "oneview-host.example.com"}, "verify_ssl": {"default": false, "type": "boolean", "description": "Indicates whether SSL/TLS certificates should be validated when connecting to HPE OneView", "example": false}, "password": {"minLength": 1, "format": "password", "type": "string", "maxLength": 200}, "pack": {"readOnly": true, "type": "string", "example": "Pack type"}}, "title": "Object: HPE OneView Pack Configuration (verify)"}, "ospf_area": {"additionalProperties": false, "required": ["area_id", "authentication_type", "area_type"], "type": "object", "properties": {"area_id": {"oneOf": [{"type": "string", "example": "172.10.10.10", "format": "ipv4"}, {"type": "integer"}], "description": "ID of OSPF area", "example": "172.10.10.10"}, "name": {"type": "string", "example": "My OSPF area"}, "area_uuid": {"readOnly": true, "description": "The UUID of the area to which OSPF is associated.", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "vpc_uuid": {"readOnly": true, "description": "The UUID of the virtual private cloud to which OSPF is associated.", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "area_type": {"enum": ["standard", "nssa", "stub"], "type": "string"}, "authentication_type": {"enum": ["plain_text", "none", "md5"], "type": "string"}, "description": {"type": "string", "example": "Description of my OSPF area"}}, "title": "Object: OSPF Area Configuration"}, "ospf_area_create": {"additionalProperties": false, "required": ["area_id", "authentication_type", "area_type"], "type": "object", "properties": {"area_id": {"oneOf": [{"type": "string", "example": "172.10.10.10", "format": "ipv4"}, {"type": "integer"}], "description": "ID of OSPF area", "example": "172.10.10.10"}, "name": {"type": "string", "example": "My OSPF area"}, "vpc_uuid": {"description": "The UUID of the virtual private cloud to which OSPF is associated.", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "area_type": {"enum": ["standard", "nssa", "stub"], "type": "string"}, "authentication_type": {"enum": ["plain_text", "none", "md5"], "type": "string"}, "description": {"type": "string", "example": "Description of my OSPF area"}}, "title": "Object: OSPF Area Configuration (Create)"}, "ospf_area_update": {"additionalProperties": false, "required": ["area_id", "authentication_type", "area_type"], "type": "object", "properties": {"area_id": {"oneOf": [{"type": "string", "example": "172.10.10.10", "format": "ipv4"}, {"type": "integer"}], "description": "ID of OSPF area", "example": "172.10.10.10"}, "name": {"type": "string", "example": "My OSPF area"}, "area_uuid": {"description": "The UUID of the area to which OSPF is associated.", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "vpc_uuid": {"description": "The UUID of the virtual private cloud to which OSPF is associated.", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "area_type": {"enum": ["standard", "nssa", "stub"], "type": "string"}, "authentication_type": {"enum": ["plain_text", "none", "md5"], "type": "string"}, "description": {"type": "string", "example": "Description of my OSPF area"}}, "title": "Object: OSPF Area Configuration (Update)"}, "ospf_database_state": {"type": "object", "properties": {"databases": {"items": {"type": "object", "properties": {"router_id": {"type": "string", "example": "192.168.1.1", "description": "ID of router."}, "area_id": {"type": "string", "example": "10.10.10.1", "description": " Area ID."}, "link_state_advertisements": {"items": {"type": "object", "properties": {"process_id": {"type": "integer", "example": 0, "description": "ID of process."}, "advertising_router": {"type": "string", "example": "192.168.1.1", "description": "Advertising routers ID."}, "link_count": {"type": "integer", "example": 0, "description": "Number of interface detected."}, "route": {"type": "object", "properties": {"address": {"required": ["address", "prefix_length"], "type": "object", "properties": {"prefix_length": {"minimum": 0, "type": "integer", "maximum": 128, "example": 24}, "address": {"oneOf": [{"format": "ipv4"}, {"format": "ipv6"}], "type": "string", "example": "172.10.10.0"}}}}}, "age": {"type": "integer", "example": 0, "description": "Link State age."}, "external_metric": {"type": "string"}, "tag": {"type": "integer", "example": 0, "description": "Link State tag."}, "opaque_id": {"type": "integer", "example": 0, "description": "Link State opaque ID."}, "sequence_number": {"type": "integer", "example": 0, "description": "Link State sequence."}, "link_id": {"type": "string", "example": "192.168.1.1", "description": "Link State ID."}}}, "type": "array", "description": "Information about link state acknowledgments."}, "area_type": {"type": "string", "example": "0", "description": " Type of area"}, "link_state_advertisements_type": {"type": "string", "example": "string", "description": "Database description."}, "process_id": {"type": "integer", "example": 0, "description": "ID of process."}}}, "type": "array"}}, "title": "Object: OSPF Database State"}, "ospf_global": {"additionalProperties": false, "required": ["enable", "redistribute"], "type": "object", "properties": {"redistribute": {"type": "object", "description": " Redistribution of routes into OSPF.", "properties": {"redistribute_connected": {"type": "boolean", "description": "True if local routes should be redistributed", "example": true}, "redistribute_bgp": {"type": "boolean", "description": "True if bgp routes should be redistributed", "example": false}, "redistribute_static": {"type": "boolean", "description": "True if static routes should be redistributed", "example": false}}}, "enable": {"type": "boolean", "description": "Enable OSPF for this Virtual Private Cloud", "example": false}, "vpc_uuid": {"readOnly": true, "description": "The UUID of the VPC to which OSPF is associated.", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "interfaces": {"items": {"$ref": "#/definitions/ospf_interface"}, "type": "array"}, "switches": {"items": {"$ref": "#/definitions/ospf_network"}, "type": "array"}, "areas": {"items": {"$ref": "#/definitions/ospf_area"}, "type": "array"}}, "title": "Object: OSPF"}, "ospf_global_create": {"additionalProperties": false, "required": [], "type": "object", "properties": {"redistribute": {"type": "object", "description": " Redistribution of routes into OSPF.", "properties": {"redistribute_connected": {"type": "boolean", "description": "True if local routes should be redistributed", "example": true}, "redistribute_bgp": {"type": "boolean", "description": "True if bgp routes should be redistributed", "example": false}, "redistribute_static": {"type": "boolean", "description": "True if static routes should be redistributed", "example": false}}}, "enable": {"type": "boolean", "description": "Enable OSPF for this Virtual Private Cloud", "example": false}, "vpc_uuid": {"description": "The UUID of the VPC to which OSPF is associated.", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}}, "title": "Object: OSPF Global Configuration (Create)"}, "ospf_global_state": {"type": "object", "properties": {"ospf": {"items": {"type": "object", "properties": {"external_link_state_advertisements_checksum": {"type": "integer", "example": 0, "description": "Link State advertisements Checksum."}, "refresh_timer": {"type": "integer", "example": 0, "description": "Periodic refresh time"}, "min_lsa_throttle_hold_time": {"type": "object", "properties": {"seconds": {"type": "integer", "example": 1}, "milliseconds": {"max": 999, "type": "integer", "example": 999, "min": 0}}}, "uptime": {"type": "int", "example": "25", "description": "Uptime in seconds"}, "external_lsa_db_limited": {"type": "boolean", "example": false}, "incoming_current_database_description_exchange_neighbors": {"type": "integer", "example": 0, "description": "Database description exchange neighbors."}, "spf_schedule_delay_min": {"type": "object", "properties": {"seconds": {"type": "integer", "example": 1}, "milliseconds": {"max": 999, "type": "integer", "example": 999, "min": 0}}}, "outgoing_current_database_description_exchange_neighbors": {"type": "integer", "example": 0, "description": "Database exchange neighbors."}, "max_lsa_throttle_hold_time": {"type": "object", "properties": {"seconds": {"type": "integer", "example": 1}, "milliseconds": {"max": 999, "type": "integer", "example": 999, "min": 0}}}, "router_id": {"type": "integer", "example": "172.10.10.10", "description": "ID of router."}, "attached_areas_count": {"type": "integer", "example": 0, "description": "Number of attached areas."}, "vpc_name": {"type": "string", "example": "default"}, "link_state_advertisements_originated_count": {"type": "integer", "example": 0, "description": "Link State Advertisements originated count."}, "spf_schedule_delay_max": {"type": "object", "properties": {"seconds": {"type": "integer", "example": 1}, "milliseconds": {"max": 999, "type": "integer", "example": 999, "min": 0}}}, "process_id": {"type": "integer", "example": 0, "description": "ID of process."}, "non_default_external_lsa_count": {"type": "integer", "example": "5"}, "areas": {"items": {"type": "object", "properties": {"area_id": {"type": "string", "example": "172.10.10.10", "description": "ID of area."}, "shortest_path_first_executed_count": {"type": "integer", "example": 0, "description": "Number of times shortest path first algorithm has been executed for the particular area."}, "is_active": {"type": "boolean", "example": true, "description": "True if the area has active address ranges."}, "is_default": {"type": "boolean", "example": true, "description": "True if default area."}, "fully_adjacent_neighbor_count": {"type": "integer", "example": 0, "description": "Number of adjacent neighbors."}, "area_interface_count": {"type": "integer", "example": 0}, "interface_count": {"type": "integer", "example": 0, "description": "Number of interfaces."}, "shortest_path_first_last_executed": {"minLength": 9, "description": "Epoch time of last time shortest-path-first algorithm executed.", "type": "integer", "example": "1497602656", "maxLength": 11}, "authentication": {"type": "string"}, "link_state_advertisements_count": {"type": "integer", "example": 0, "description": "Number of link state advertisements."}, "link_state_advertisements_checksum": {"type": "integer", "example": 0, "description": "Checksum number of the link state advertisements."}, "is_backbone": {"type": "boolean", "example": true, "description": "True if area is backbone."}}}, "type": "array", "description": "Areas configured on this OSPF object"}, "exit_lsa_db_overflow_interval": {"type": "int", "example": "0"}, "external_link_state_advertisements_count": {"type": "integer", "example": 0, "description": "External Link State advertisements count."}, "db_overflow_state": {"type": "boolean", "example": false}, "link_state_advertisements_received_count": {"type": "integer", "example": 0, "description": "Link State Advertisements receive count."}, "min_lsa_arrival_time": {"type": "object", "properties": {"seconds": {"type": "integer", "example": 1}, "milliseconds": {"max": 999, "type": "integer", "example": 999, "min": 0}}}, "external_lsa_db_limit": {"type": "int", "example": "10"}, "initial_lsa_throttle_delay": {"type": "object", "properties": {"seconds": {"type": "integer", "example": 1}, "milliseconds": {"max": 999, "type": "integer", "example": 999, "min": 0}}}}}, "type": "array", "description": "Interface status on this OSPF object"}}, "title": "Object: OSPF Global Configuration"}, "ospf_global_update": {"additionalProperties": false, "required": ["enable", "redistribute"], "type": "object", "properties": {"redistribute": {"type": "object", "description": " Redistribution of routes into OSPF.", "properties": {"redistribute_connected": {"type": "boolean", "description": "True if local routes should be redistributed", "example": true}, "redistribute_bgp": {"type": "boolean", "description": "True if bgp routes should be redistributed", "example": false}, "redistribute_static": {"type": "boolean", "description": "True if static routes should be redistributed", "example": false}}}, "enable": {"type": "boolean", "description": "Enable OSPF for this Virtual Private Cloud", "example": false}, "vpc_uuid": {"description": "The UUID of the VPC to which OSPF is associated.", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}}, "title": "Object: OSPF Global Configuration (Update)"}, "ospf_interface": {"additionalProperties": false, "required": ["priority", "cost", "hello_interval", "dead_interval", "mtu_size", "ignore_mtu_mismatch"], "type": "object", "properties": {"vpc_uuid": {"readOnly": true, "description": "The UUID of the virtual private cloud to which OSPF is associated.", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "authentication_value": {"type": "string", "description": "Plain-text authentication value", "example": "string"}, "switch_uuid": {"readOnly": true, "description": "The UUID of the switch to which OSPF is associated.", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "dead_interval": {"example": 40, "minimum": 1, "type": "integer", "description": "dead period for hello messages in seconds", "maximum": 65535}, "hello_interval": {"example": 10, "minimum": 1, "type": "integer", "description": "Interval period for hello messages in seconds", "maximum": 65535}, "mtu_size": {"example": 1500, "minimum": 1500, "type": "integer", "description": "MTU size in bytes, defaults to undefined interface MTU", "maximum": 9368}, "passive_mode": {"type": "boolean", "description": "Enable OSPF Passive Interface", "example": false}, "priority": {"example": 0, "minimum": 0, "type": "integer", "description": "priority of interface", "maximum": 255}, "ignore_mtu_mismatch": {"type": "boolean", "description": "Ignore MTU mismatch", "example": false}, "cost": {"example": 10, "minimum": 0, "type": "integer", "description": "Cost of interface", "maximum": 65535}, "md5_list": {"items": {"type": "object", "properties": {"value": {"type": "string", "example": "string"}, "key": {"minimum": 1, "type": "integer", "maximum": 255, "example": 10}}}, "type": "array", "description": "md5 authentication key value pairs"}, "interface_uuid": {"readOnly": true, "description": "The UUID of the IP interface to which OSPF is associated.", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}}, "title": "Object: OSPF Interface Configuration"}, "ospf_interface_create": {"additionalProperties": false, "required": ["priority", "cost", "hello_interval", "dead_interval", "mtu_size", "ignore_mtu_mismatch"], "type": "object", "properties": {"cost": {"minimum": 0, "type": "integer", "example": 10, "maximum": 65535, "description": "Cost of interface"}, "ignore_mtu_mismatch": {"type": "boolean", "description": "Ignore MTU mismatch", "example": false}, "mtu_size": {"minimum": 1500, "type": "integer", "example": 1500, "maximum": 9368, "description": "MTU size in bytes, defaults to undefined interface MTU"}, "vpc_uuid": {"description": "The UUID of the virtual private cloud to which OSPF is associated.", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "passive_mode": {"type": "boolean", "description": "Enable OSPF Passive Interface", "example": false}, "authentication_value": {"type": "string", "description": "Plain-text authentication value", "example": "string"}, "priority": {"minimum": 0, "type": "integer", "example": 0, "maximum": 255, "description": "priority of interface"}, "switch_uuid": {"description": "The UUID of the switch to which OSPF is associated.", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "dead_interval": {"minimum": 1, "type": "integer", "example": 40, "maximum": 65535, "description": "dead period for hello messages in seconds"}, "hello_interval": {"minimum": 1, "type": "integer", "example": 10, "maximum": 65535, "description": "Interval period for hello messages in seconds"}, "md5_list": {"items": {"type": "object", "properties": {"key": {"minimum": 1, "type": "integer", "maximum": 255, "example": 10}, "value": {"type": "string", "example": "string"}}}, "type": "array", "description": "md5 authentication key value pairs"}, "interface_uuid": {"description": "The UUID of the IP interface to which OSPF is associated.", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}}, "title": "Object: OSPF Interface (Create)"}, "ospf_interface_reset": {"additionalProperties": false, "required": ["reset"], "type": "object", "properties": {"reset": {"type": "boolean", "description": "Reset Ospf properties to default", "example": true}, "vpc_uuid": {"readOnly": true, "description": "The UUID of the virtual private cloud to which OSPF is associated.", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "interface_uuid": {"readOnly": true, "description": "The UUID of the IP interface to which OSPF is associated.", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "switch_uuid": {"readOnly": true, "description": "The UUID of the switch to which OSPF is associated.", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}}, "title": "Object: OSPF Interface Configuration"}, "ospf_interface_state": {"type": "object", "properties": {"interfaces": {"items": {"type": "object", "properties": {"router_id": {"type": "string", "example": "192.168.1.1", "description": "Router ID Number"}, "dd_tx_count": {"type": "integer", "example": 30, "description": "Database Description Transmit Count"}, "area_id": {"type": "string", "example": "192.168.1.1", "description": "Area ID Number"}, "holddown_timer": {"type": "integer", "example": 0}, "cost": {"type": "integer", "example": 0}, "hello_due_time": {"type": "integer", "example": 0}, "link_state_request_tx_count": {"type": "integer", "example": 0, "description": "Link State Request transmit count."}, "interface_passive": {"type": "boolean", "example": false}, "ls_ack_transmit_count": {"type": "integer", "example": 0}, "discard_count": {"type": "integer", "example": 0}, "designated_router_id": {"type": "string"}, "process_id": {"type": "integer", "example": 0, "description": "OSPF process ID."}, "holddown_timer_remaining": {"type": "integer", "example": 0, "description": "Hold down time remaining."}, "hello_tx_count": {"type": "integer", "example": 0, "description": "Hello transmit count."}, "backup_designated_router_if_address": {"type": "string", "example": "10.10.0.1 / 2001:0db8:85a3:0000:0000:8a2e:0370:7334"}, "backup_designated_router_id": {"type": "string"}, "adj_neighborhood_count": {"type": "integer", "example": 0}, "transmit_delay": {"type": "integer", "example": 0, "description": "The transmit delay."}, "interface_uuid": {"min_length": 32, "readOnly": true, "max_length": 36, "description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "ls_update_transmit_count": {"type": "integer", "example": 0}, "designated_router_address": {"type": "string", "example": "10.10.0.1 / 2001:0db8:85a3:0000:0000:8a2e:0370:7334"}, "dd_rx_count": {"type": "integer", "example": 0, "description": "Database Description Receive Count"}, "ls_ack_receive_count": {"type": "integer", "example": 0}, "backup_designated_router_address": {"type": "string", "example": "10.10.0.1 / 2001:0db8:85a3:0000:0000:8a2e:0370:7334"}, "link_state_request_rx_count": {"type": "integer", "example": 0, "description": "Link State Request receive count."}, "interface_state": {"type": "string", "example": "string", "description": "Operational state of the interface."}, "interface_address": {"type": "string", "example": "string", "description": "Address of interface."}, "neighborhood_count": {"type": "integer", "example": 0}, "mtu": {"type": "integer", "example": 0, "description": "Size of packets that can be transmitted."}, "priority": {"type": "integer", "example": 0}, "designated_router_if_address": {"type": "string", "example": "10.10.0.1 / 2001:0db8:85a3:0000:0000:8a2e:0370:7334"}, "hello_rx_count": {"type": "integer", "example": 0, "description": "Hello packet receive count."}, "ls_update_receive_count": {"type": "integer", "example": 0}, "interface_name": {"type": "string", "example": "string", "description": "Name of interface."}, "network_type": {"type": "string", "example": "string", "description": "Network type ie point-to-point."}, "interface_admin_state": {"type": "boolean", "example": true}}}, "type": "array"}}, "title": "Object: OSPF Interface State"}, "ospf_interface_update": {"additionalProperties": false, "required": ["priority", "cost", "hello_interval", "dead_interval", "mtu_size", "ignore_mtu_mismatch"], "type": "object", "properties": {"cost": {"minimum": 0, "type": "integer", "example": 10, "maximum": 65535, "description": "Cost of interface"}, "ignore_mtu_mismatch": {"type": "boolean", "description": "Ignore MTU mismatch", "example": false}, "mtu_size": {"minimum": 1500, "type": "integer", "example": 1500, "maximum": 9368, "description": "MTU size in bytes, defaults to undefined interface MTU"}, "vpc_uuid": {"description": "The UUID of the virtual private cloud to which OSPF is associated.", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "passive_mode": {"type": "boolean", "description": "Enable OSPF Passive Interface", "example": false}, "authentication_value": {"type": "string", "description": "Plain-text authentication value", "example": "string"}, "priority": {"minimum": 0, "type": "integer", "example": 0, "maximum": 255, "description": "priority of interface"}, "switch_uuid": {"description": "The UUID of the switch to which OSPF is associated.", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "dead_interval": {"minimum": 1, "type": "integer", "example": 40, "maximum": 65535, "description": "dead period for hello messages in seconds"}, "hello_interval": {"minimum": 1, "type": "integer", "example": 10, "maximum": 65535, "description": "Interval period for hello messages in seconds"}, "md5_list": {"items": {"type": "object", "properties": {"key": {"minimum": 1, "type": "integer", "maximum": 255, "example": 10}, "value": {"type": "string", "example": "string"}}}, "type": "array", "description": "md5 authentication key value pairs"}, "interface_uuid": {"description": "The UUID of the IP interface to which OSPF is associated.", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}}, "title": "Object: OSPF Interface (Update)"}, "ospf_neighbor_state": {"type": "object", "properties": {"neighbors": {"items": {"type": "object", "properties": {"thread_database_description_retransmission": {"type": "boolean", "example": true}, "backup_designated_router": {"type": "string", "example": "10.10.0.1 / 2001:0db8:85a3:0000:0000:8a2e:0370:7334"}, "neighbor_uptime": {"type": "integer", "example": 160, "description": "Uptime in seconds."}, "address": {"type": "string", "example": "192.168.1.1", "description": "Interface address."}, "link_state_request_list_count": {"type": "integer", "example": 0}, "options": {"type": "integer", "example": 0}, "priority": {"type": "integer", "example": 1, "description": "Priority of the neighbor."}, "thread_link_state_request_retransmission": {"type": "boolean", "example": true}, "state": {"type": "string", "example": "FULL/DR", "description": "State of interface."}, "state_changes": {"type": "integer", "example": 0}, "thread_link_state_update_retransmission": {"type": "boolean", "example": true}, "dead_time": {"type": "integer", "example": 30, "description": "Expected dead time of neighbor."}, "thread_inactivity_timer": {"type": "boolean", "example": true}, "link_state_retransmission_list_count": {"type": "integer", "example": 0}, "interface_name": {"type": "string", "example": "vr0.1", "description": "Name of interface."}, "options_string": {"type": "string"}, "neighbor_id": {"type": "string", "example": "192.168.1.1", "description": "ID of neighbor."}, "database_summary_list_count": {"type": "integer", "example": 0}, "designated_router": {"type": "string", "example": "10.10.0.1 / 2001:0db8:85a3:0000:0000:8a2e:0370:7334"}}}, "type": "array"}}, "title": "Object: OSPF Neighbor State"}, "ospf_network": {"additionalProperties": false, "required": ["network", "router_id", "default_originate"], "type": "object", "properties": {"router_id": {"oneOf": [{"type": "string", "example": "172.10.10.10", "format": "ipv4"}, {"type": "null"}], "description": "Ip address of router id", "example": "172.10.10.10"}, "vpc_uuid": {"readOnly": true, "description": "The UUID of the Virtual Private Cloud to which OSPF is associated.", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "default_originate": {"enum": ["disabled", "enabled", "always"], "type": "string", "description": "Allow a default route to be advertised"}, "network": {"items": {"required": ["area_uuid", "address"], "type": "object", "properties": {"area_uuid": {"readOnly": false, "description": "The UUID of the OSPF area.", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "address": {"required": ["address", "prefix_length"], "type": "object", "properties": {"prefix_length": {"minimum": 0, "type": "integer", "maximum": 32, "example": 24}, "address": {"type": "string", "example": "172.10.10.10", "format": "ipv4"}}}}}, "type": "array", "description": "List of network addresses to be included in an area."}, "switch_uuid": {"readOnly": true, "description": "The UUID of the switch to which OSPF is associated.", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}}, "title": "Object: OSPF Network"}, "ospf_state": {"type": "object", "properties": {"vpc_uuid": {"readOnly": true, "description": "The UUID of the Virtual Private Cloud to which OSPF is associated.", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "neighbor_status": {"$ref": "#/definitions/ospf_neighbor_state"}, "switch_uuid": {"readOnly": true, "description": "The UUID of the switch to which OSPF is associated.", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "database_status": {"$ref": "#/definitions/ospf_database_state"}, "interface_status": {"$ref": "#/definitions/ospf_interface_state"}, "ospf_status": {"$ref": "#/definitions/ospf_global_state"}}, "title": "Object: OSPF"}, "password_policy": {"additionalProperties": false, "required": ["minimum_length"], "type": "object", "properties": {"minimum_upper_case": {"description": "Minimum number of upper case characters required to be in the password.", "default": 0, "maximum": 64, "minimum": 0, "type": "number", "example": 1}, "minimum_special": {"description": "Minimum number of special characters required to be in the password. The set of acceptable special characters is defined by the `special_characters` property.", "default": 0, "maximum": 64, "minimum": 0, "type": "number", "example": 1}, "minimum_lower_case": {"description": "Minimum number of lower case characters required to be in the password.", "default": 0, "maximum": 64, "minimum": 0, "type": "number", "example": 1}, "special_characters": {"format": "non_empty_or_whitespace_string", "type": "string", "description": "The set of special characters acceptable for use in the password. New or updated user passwords are validated against the characters in this set if the `minimum_special` property is greater than zero. Possible values are limited to the character set ``!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~``.", "example": "!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~"}, "minimum_numeric": {"description": "Minimum number of numeric case characters required to be in the password.", "default": 0, "maximum": 64, "minimum": 0, "type": "number", "example": 1}, "minimum_length": {"description": "Minimum password length. Must be \u2264 `maximum_length` if both are defined.", "default": 1, "maximum": 64, "minimum": 1, "type": "number", "example": 8}, "maximum_length": {"example": 64, "minimum": 1, "type": "number", "description": "Maximum password length. Must be \u2265 `minimum_length` if both are defined.", "maximum": 64}}, "title": "Object: Password Policy"}, "patch_document": {"additionalProperties": false, "required": ["op", "path"], "type": "object", "properties": {"path": {"type": "string", "description": "A JSON pointer."}, "from": {"type": "string", "description": "A string containing a JSON Pointer value."}, "value": {"anyOf": [{"type": "string"}, {"type": "integer"}, {"type": "array"}, {"type": "boolean"}], "description": "The value to be used within the operations. The value is of type integer, string, or boolean.", "example": "value"}, "op": {"enum": ["add", "copy", "move", "remove", "replace", "test"], "type": "string", "description": "The operation to be performed."}}}, "patch_request": {"additionalProperties": false, "required": ["uuids", "patch"], "type": "object", "properties": {"uuids": {"items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array"}, "patch": {"items": {"$ref": "#/definitions/patch_document"}, "type": "array"}}}, "patch_response": {"additionalProperties": false, "required": ["reason", "status", "uuids"], "type": "object", "properties": {"status": {"enum": ["success", "partial_success", "accepted_busy", "failure"], "type": "string", "description": "Result of the operation.", "example": "failed"}, "reason": {"type": "string", "description": "A comma-separated string of reason(s) for failure or partial success.", "example": ["Failed to receive delete notification for 03734100040c000009b8ddaf67cf1ed5 due to qsfp_mode changes"]}, "uuids": {"items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array", "description": "List of UUIDs with the status.", "example": ["03734100040c000009b8ddaf67cf1ed5", "03734100040c0000399e081dc0ca985e"]}}, "title": "Object: PATCH Response"}, "path_actor": {"additionalProperties": false, "required": ["topology_uuid", "uuid"], "type": "object", "properties": {"uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "protection": {"default": "fail_to_residual", "enum": ["fail_to_residual", "drop"], "type": "string", "description": "If FAIL_TO_RESIDUAL, upon link failures in the primary path packets will traverse the residual topology. Otherwise if packets will be dropped", "example": "fail_to_residual"}, "name": {"type": "string", "example": "Path Actor Foo", "format": "non_empty_or_whitespace_string"}, "topology_uuid": {"readOnly": true, "description": "UUID of topology object to associate with this affinity", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "description": {"type": "string", "example": "Path Actor Foo"}}, "title": "Object: Path Actor"}, "path_actor_create": {"additionalProperties": false, "required": ["topology_uuid"], "type": "object", "properties": {"name": {"type": "string", "example": "Path Actor Foo", "format": "non_empty_or_whitespace_string"}, "protection": {"default": "fail_to_residual", "enum": ["fail_to_residual", "drop"], "type": "string", "description": "If FAIL_TO_RESIDUAL, upon link failures in the primary path packets will traverse the residual topology. Otherwise if packets will be dropped", "example": "fail_to_residual"}, "description": {"type": "string", "example": "Path Actor Foo"}, "topology_uuid": {"description": "UUID of topology object to associate with this affinity", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}}, "title": "Object: Path Actor (Create)"}, "path_actor_update": {"additionalProperties": false, "required": ["topology_uuid"], "type": "object", "properties": {"description": {"type": "string", "example": "Path Actor Foo"}, "protection": {"default": "fail_to_residual", "enum": ["fail_to_residual", "drop"], "type": "string", "description": "If FAIL_TO_RESIDUAL, upon link failures in the primary path packets will traverse the residual topology. Otherwise if packets will be dropped", "example": "fail_to_residual"}, "uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "topology_uuid": {"description": "UUID of topology object to associate with this affinity", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "name": {"type": "string", "example": "Path Actor Foo", "format": "non_empty_or_whitespace_string"}}, "title": "Object: Path Actor (Update)"}, "path_edge": {"additionalProperties": false, "required": ["from_switch_id", "from_uuid", "from_name", "from_port_uuid", "from_port_name", "to_switch_id", "to_uuid", "to_name", "to_port_uuid", "to_port_name"], "type": "object", "properties": {"from_name": {"type": "string", "description": "Local switch name", "example": "switch1"}, "weight": {"example": 100, "type": "number", "description": "Weight of the Path", "format": "float"}, "to_port_name": {"type": "string", "description": "Remote switch port Label", "example": "xp45"}, "to_name": {"type": "string", "description": "Remote switch name", "example": "1.1"}, "to_uuid": {"type": "string", "description": "Remote switch UUID", "example": "0373410004190000f33424bffabc399e"}, "from_switch_id": {"type": "string", "description": "Unique identifier (MAC Address) of the local switch", "example": "E0:39:D7:00:21:00"}, "to_port_uuid": {"type": "string", "description": "Remote switch port UUID", "example": "03734100040c0000eda3d395a935f549"}, "from_uuid": {"type": "string", "description": "Local switch UUID", "example": "0373410004190000fda2ce1c5f78adb7"}, "to_switch_id": {"type": "string", "description": "Unique identifier (MAC Address) of the remote switch", "example": "E0:39:D7:00:69:00"}, "from_port_uuid": {"type": "string", "description": "Local switch port UUID", "example": "03734100040d0000cb86de3f26c776fb"}, "from_port_name": {"type": "string", "description": "Local switch port label", "example": "xp48"}}, "title": "Object: Path Edge"}, "peer": {"additionalProperties": false, "required": ["local_station_id", "local_station_name", "local_station_uuid", "fabric_uuid", "peers"], "type": "object", "properties": {"local_station_name": {"type": "string", "description": "Local Station (Switch) name", "example": "switch1"}, "fabric_uuid": {"type": "string", "description": "Fabric UUID to which the local switch belongs", "example": "03734100041a00000a8bfd6ec132beb6"}, "peers": {"items": {"$ref": "#/definitions/switch_peer"}, "type": "array", "description": "Represents a list peers of a Switch"}, "local_station_uuid": {"type": "string", "description": "Local Station (Switch) Station UUID", "example": "0373410004190000f33424bffabc399e"}}, "title": "Object: Peer"}, "pim_config": {"additionalProperties": false, "required": ["admin_state_enabled", "hello_interval", "hello_holdtime", "passive", "designated_router_priority"], "type": "object", "properties": {"passive": {"default": false, "type": "boolean", "description": "Enable passive mode, otherwise active.", "example": false}, "admin_state_enabled": {"default": false, "type": "boolean", "description": "Set admin state to up when enabled, otherwise down.", "example": false}, "name": {"type": "string", "example": "My PIM global config"}, "hello_interval": {"example": 30, "minimum": 30, "type": "integer", "description": "Hello interval timer, default value 30 seconds.", "maximum": 65535}, "hello_holdtime": {"example": 105, "minimum": 0, "type": "integer", "description": "Hello hold timer, default value 105 seconds.", "maximum": 65535}, "interfaces": {"items": {"$ref": "#/definitions/pim_interface"}, "readOnly": true, "type": "array"}, "designated_router_priority": {"example": 1, "minimum": 0, "type": "integer", "description": "Designated Router Priority, default value 1 seconds.", "maximum": 4294967294}, "uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "description": {"type": "string", "example": "Description of PIM global config"}}, "title": "Object: Protocol Independent Multicast Config"}, "pim_config_create": {"additionalProperties": false, "required": ["admin_state_enabled", "hello_interval", "hello_holdtime", "passive", "designated_router_priority"], "type": "object", "properties": {"admin_state_enabled": {"default": false, "type": "boolean", "description": "Set admin state to up when enabled, otherwise down.", "example": false}, "name": {"type": "string", "example": "My PIM global config"}, "designated_router_priority": {"minimum": 0, "type": "integer", "example": 1, "maximum": 4294967294, "description": "Designated Router Priority, default value 1 seconds."}, "interfaces": {"items": {"$ref": "#/definitions/pim_interface"}, "readOnly": true, "type": "array"}, "description": {"type": "string", "example": "Description of PIM global config"}, "passive": {"default": false, "type": "boolean", "description": "Enable passive mode, otherwise active.", "example": false}, "hello_interval": {"minimum": 30, "type": "integer", "example": 30, "maximum": 65535, "description": "Hello interval timer, default value 30 seconds."}, "hello_holdtime": {"minimum": 0, "type": "integer", "example": 105, "maximum": 65535, "description": "Hello hold timer, default value 105 seconds."}}, "title": "Object: PIM interface config (Create)"}, "pim_config_get": {"additionalProperties": false, "items": {"$ref": "#/definitions/pim_config"}, "required": ["pim_configs"], "type": "array", "title": "Object: Protocol Independent Multicast Config"}, "pim_config_update": {"additionalProperties": false, "required": ["admin_state_enabled", "hello_interval", "hello_holdtime", "passive", "designated_router_priority"], "type": "object", "properties": {"admin_state_enabled": {"default": false, "type": "boolean", "description": "Set admin state to up when enabled, otherwise down.", "example": false}, "name": {"type": "string", "example": "My PIM global config"}, "designated_router_priority": {"minimum": 0, "type": "integer", "example": 1, "maximum": 4294967294, "description": "Designated Router Priority, default value 1 seconds."}, "interfaces": {"items": {"$ref": "#/definitions/pim_interface"}, "readOnly": true, "type": "array"}, "description": {"type": "string", "example": "Description of PIM global config"}, "passive": {"default": false, "type": "boolean", "description": "Enable passive mode, otherwise active.", "example": false}, "hello_interval": {"minimum": 30, "type": "integer", "example": 30, "maximum": 65535, "description": "Hello interval timer, default value 30 seconds."}, "hello_holdtime": {"minimum": 0, "type": "integer", "example": 105, "maximum": 65535, "description": "Hello hold timer, default value 105 seconds."}}, "title": "Object: PIM interface config (Update)"}, "pim_global": {"additionalProperties": false, "required": ["rendezvous_point_address", "join_prune_timer", "register_source", "anycast_set", "register_rate_limit", "register_suppression", "register_rendezvous_point_reachability_enabled", "shortest_path_tree_switchover_enabled", "enabled"], "type": "object", "properties": {"description": {"type": "string", "example": "Description of PIM global config"}, "register_rendezvous_point_reachability_enabled": {"default": false, "type": "boolean", "description": "Enable the RP reachability check.", "example": false}, "register_rate_limit": {"example": 105, "minimum": 0, "type": "integer", "description": "Register rate timer, default value 105 seconds.", "maximum": 65535}, "register_source": {"oneOf": [{"format": "ipv4"}, {"format": "ipv6"}], "type": "string", "example": "192.168.1.1"}, "shortest_path_tree_switchover_enabled": {"default": true, "type": "boolean", "description": "Enable the PIM config Shortest Path Tree Switchover.", "example": true}, "rendezvous_point_address": {"oneOf": [{"format": "ipv4"}, {"format": "ipv6"}], "type": "string", "example": "192.168.1.1"}, "name": {"type": "string", "example": "My PIM global config"}, "enabled": {"default": false, "type": "boolean", "description": "Enable the PIM config on the switch.", "example": false}, "anycast_set": {"items": {"oneOf": [{"example": "192.168.1.1", "format": "ipv4"}, {"example": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", "format": "ipv6"}], "type": "string"}, "type": "array"}, "mode": {"readOnly": true, "enum": ["sparse"], "type": "string", "description": "PIM mode of operation", "example": "sparse"}, "register_suppression": {"example": 60, "minimum": 0, "type": "integer", "description": "Register suppression timer, default value 60 seconds.", "maximum": 65535}, "join_prune_timer": {"example": 60, "minimum": 0, "type": "integer", "description": "Join and Prune timer, default value 105 seconds.", "maximum": 65535}}, "title": "Object: Protocol Independent Multicast Global"}, "pim_interface": {"additionalProperties": false, "items": {"additionalProperties": false, "required": ["interface_uuids", "switch_uuid"], "type": "object", "properties": {"switch_uuid": {"readOnly": false, "description": "The UUID of the switch to which PIM is associated.", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "interface_uuids": {"items": {"readOnly": false, "description": "The UUID of the IP interface to which PIM is associated.", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array"}}}, "required": [], "type": "array", "title": "Object: PIM Interface Configuration"}, "pod": {"additionalProperties": false, "required": ["cluster_uuid", "name", "namespace", "uuid"], "type": "object", "properties": {"uuid": {"minLength": 36, "readOnly": true, "type": "string", "example": "423a1d57-83e6-583f-98ba-984317ef8c9d", "maxLength": 36}, "node_uuid": {"minLength": 32, "readOnly": true, "type": "string", "example": "423a1d57-83e6-583f-98ba-984317ef8c9d", "maxLength": 36}, "vendor": {"readOnly": true, "enum": ["kubernetes"], "type": "string"}, "description": {"readOnly": true, "type": "string", "example": ""}, "nics": {"items": {"$ref": "#/definitions/pod_kubernetes_nic"}, "type": "array"}, "app": {"readOnly": true, "type": "string", "example": "postgres"}, "labels": {"readOnly": true, "type": "object", "example": {"proximity": "local"}}, "namespace": {"readOnly": true, "type": "string", "example": "demo1"}, "host_ip": {"readOnly": true, "type": "string", "example": "10.2.3.4"}, "node_name": {"readOnly": true, "type": "string", "example": "demo1"}, "phase": {"readOnly": true, "type": "string", "example": "running"}, "version": {"readOnly": true, "type": "string", "example": "2356780"}, "mode": {"readOnly": true, "type": "string", "example": "adjacent"}, "scheduler": {"readOnly": true, "type": "string", "example": "default"}, "pod_ip": {"readOnly": true, "type": "string", "example": "10.2.3.4"}, "cluster_uuid": {"minLength": 32, "readOnly": true, "type": "string", "example": "423a1d57-83e6-583f-98ba-984317ef8c9d", "maxLength": 36}, "annotations": {"readOnly": true, "type": "object"}, "name": {"readOnly": true, "type": "string", "example": "demo-pod"}}, "title": "Object: Pod"}, "pod_generic": {"additionalProperties": false, "required": ["description", "hostname", "name", "uuid"], "type": "object", "properties": {"uuid": {"type": "string", "example": "00044518-b776-2051-0001-000000000001-pod-01"}, "vendor": {"enum": ["nutanix", "vmware", "simplivity"], "type": "string"}, "description": {"type": "string", "example": ""}, "nics": {"items": {"type": "object"}, "type": "array"}, "hypervisor_type": {"enum": ["esxi", "kvm", "k8s"], "type": "string"}, "hostname": {"type": "string", "example": "test.ilab.hpe.com", "description": "Host name of the pod"}, "host_uuid": {"type": "string", "example": "00054518-c886-3a51-0002-000000000022", "description": "Syntax varies depending on the value of `vendor`\n* `kubernetes` Pods will have a standard UUID syntax\n"}, "name": {"type": "string", "example": "CentOS7_Pod1"}}, "title": "Object: Pod (Generic)"}, "pod_kubernetes_nic": {"additionalProperties": false, "required": ["description", "name", "portgroup_uuid"], "type": "object", "properties": {"portgroup_uuid": {"type": "string", "example": "00054518-c886-3a51-0007-000000000001"}, "description": {"type": "string", "example": ""}, "name": {"type": "string", "example": "eth0"}}, "title": "Object: Pod Network Interface (Kubernetes)"}, "port": {"additionalProperties": false, "required": ["admin_state", "bridge_loop_detection", "description", "fec", "is_uplink", "link_state", "name", "native_vlan", "permitted_qsfp_modes", "port_label", "qsfp_mode", "read_only", "silkscreen", "speed", "speed_group", "switch_uuid", "type", "uuid", "vlan_group_uuids", "vlans"], "type": "object", "properties": {"native_vlan": {"example": 99, "minimum": 0, "type": "number", "maximum": 4000, "description": "This VLAN is:\n* Applied to all untagged traffic coming in to this Port (ingress)\n* Removed from all traffic tagged with this VLAN which is leaving this Port (egress)\n* NOTE: a native_vlan value of 0 means that any untagged traffic will be dropped on either ingress or egress"}, "neighbors": {"items": {"$ref": "#/definitions/neighbor_discovery_advertisement"}, "readOnly": true, "type": "array", "description": "Neighbors (LLDP/CDP/user) associated with this port."}, "lag": {"readOnly": true, "$ref": "#/definitions/lag_flat"}, "description": {"type": "string", "example": ""}, "port_security_enabled": {"readOnly": true, "type": "boolean", "example": false, "description": "Indicates that port security is:\n* `true` - enabled\n* `false` - disabled"}, "tags": {"$ref": "#/definitions/tags_on_object"}, "holddown": {"items": {"enum": ["not_applicable", "admin", "lacp", "loop_detected", "mlag", "peering_loss", "penalty_box", "port_security", "usat"], "type": "string"}, "readOnly": true, "type": "array", "description": "Reasons for port conditional holddown.", "example": ["not_applicable"]}, "speed_group": {"items": {"min_length": "32", "max_length": "32", "type": "string", "description": "UUIDs of ports that wil be affected by changing the speed of this port (speed will be changed on all ports)."}, "readOnly": true, "type": "array", "example": ["42de42fa30877ada9b6c567d89587fea", "4e2f16c3979f494dbf0393d8a01e8fd5", "c27ea048bab64b4a9db9e25d2ba511f4", "92de42fa30874f8a5b6c567d8958ae86"]}, "ungrouped_vlans": {"example": "5, 10-20, 30, 40, 50-60", "type": "string", "description": "VLANs directly assigned to this port, not assigned through a VLAN group; presented as a sorted set of ranges.", "format": "vlan-range"}, "link_state": {"readOnly": true, "enum": ["down", "up"], "type": "string", "description": "The link state of this port.", "example": "up"}, "switch_uuid": {"readOnly": true, "description": "UUID of the switch on which this port resides.", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "admin_state": {"enum": ["disabled", "enabled"], "type": "string", "description": "Administratively controlled state", "example": "enabled"}, "qsfp_mode": {"enum": ["not_applicable", "qsfp_1x40_gbps", "qsfp_1x100_gbps", "qsfp_2x50_gbps", "qsfp_4x10_gbps", "qsfp_4x25_gbps"], "type": "string", "description": "QSFP mode of this port.", "example": "qsfp_1x40_gbps"}, "form_factor": {"readOnly": true, "enum": ["unknown", "sfp", "qsfp", "rj45", "lightrail"], "type": "string", "description": "Port type.", "example": "qsfp"}, "port_label": {"readOnly": true, "type": "string", "description": "Port Label (for display purposes). Syntax varies based on hardware configuration (usually QSFP mode).", "example": "1.1"}, "vlans": {"readOnly": true, "format": "vlan-range", "type": "string", "description": "The effective VLANs assigned to this port, including VLAN groups and directly assigned VLANs, presented as a sorted set of ranges.", "example": "5, 10-20, 30, 40, 50-60"}, "l2vpn_information": {"items": {"$ref": "#/definitions/l2vpn_information_for_ports_lags"}, "type": "array", "description": "If the `l2vpn` query parameter is `true`, this list will contain any associated L2VPN UUIDs and their names."}, "switch_name": {"type": "string", "example": "host.hpe.com", "maxLength": 255}, "name": {"type": "string", "description": "The user-defined port name (if any)", "example": "Port for Host X NIC Y"}, "read_only": {"default": false, "readOnly": true, "type": "boolean", "description": "Indicates that this port is:\n* `true` - __NOT__ configurable\n* `false` - Configurable", "example": false}, "default_state": {"readOnly": true, "type": "boolean", "description": "Indicates that a port:\n* When in default state is configurable for changing the type property\n* When not in the default state it is NOT configurable for changing the type property", "example": false}, "fec": {"enum": ["not_applicable", "enabled", "disabled"], "type": "string", "description": "Forward Error Correction setting", "example": "disabled"}, "fec_mode": {"enum": ["CL74", "CL91"], "type": "string", "description": "Forward Error Correction mode", "example": "CL74"}, "is_uplink": {"type": "boolean", "description": "Denotes whether this port is an \"uplink\" port", "example": false}, "uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "vlan_group_uuids": {"items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array", "description": "UUIDs of the VLAN groups associated with this port."}, "downlink_switch_uuid": {"oneOf": [{"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, {"type": "null"}], "readOnly": false, "description": "UUID of the downlink switch connected to this port.", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "vlan_groups": {"items": {"$ref": "#/definitions/vlan_group_embedded"}, "readOnly": true, "type": "array", "description": "VLAN groups associated with this port."}, "permitted_qsfp_modes": {"items": {"enum": ["not_applicable", "qsfp_1x40_gbps", "qsfp_1x100_gbps", "qsfp_2x50_gbps", "qsfp_4x10_gbps", "qsfp_4x25_gbps"], "type": "string", "description": "Permitted QSFP mode(s)"}, "readOnly": true, "type": "array", "example": ["qsfp_1x40_gbps", "qsfp_1x100_gbps", "qsfp_4x10_gbps"]}, "silkscreen": {"readOnly": true, "description": "String printed on the physical switch for the port slot associated with this port; can be the same for more than one port depending on switch model and configuration", "example": "1"}, "type": {"enum": ["access", "fabric"], "type": "string", "example": "access"}, "bridge_loop_detection": {"additionalProperties": false, "required": ["interval", "mode"], "type": "object", "description": "Bridge loop detection setting for this port.", "properties": {"interval": {"description": "Bridge loop detection interval in milliseconds.", "default": 1000, "maximum": 65000, "minimum": 1000, "type": "number", "example": 1000}, "mode": {"default": "disabled", "enum": ["disabled", "native_vlan", "all_configured_vlans"], "type": "string", "description": "The operational mode for bridge loop detection on this port.", "example": "disabled"}}}, "speed": {"$ref": "#/definitions/port_speed"}}, "title": "Object: Port"}, "port_flat": {"additionalProperties": false, "required": ["admin_state", "bridge_loop_detection", "description", "fec", "is_uplink", "link_state", "name", "native_vlan", "permitted_qsfp_modes", "port_label", "qsfp_mode", "read_only", "silkscreen", "speed", "speed_group", "switch_uuid", "type", "uuid", "vlan_group_uuids", "vlans"], "type": "object", "properties": {"native_vlan": {"description": "This VLAN is:\n* Applied to all untagged traffic coming in to this Port (ingress)\n* Removed from all traffic tagged with this VLAN which is leaving this Port (egress)\n* NOTE: a native_vlan value of 0 means that any untagged traffic will be dropped on either ingress or egress", "minimum": 0, "type": "number", "example": 99, "maximum": 4000}, "speed_group": {"items": {"min_length": "32", "max_length": "32", "type": "string", "description": "UUIDs of ports that wil be affected by changing the speed of this port (speed will be changed on all ports)."}, "readOnly": true, "type": "array", "example": ["42de42fa30877ada9b6c567d89587fea", "4e2f16c3979f494dbf0393d8a01e8fd5", "c27ea048bab64b4a9db9e25d2ba511f4", "92de42fa30874f8a5b6c567d8958ae86"]}, "link_state": {"readOnly": true, "enum": ["down", "up"], "type": "string", "description": "The link state of this port.", "example": "up"}, "form_factor": {"readOnly": true, "enum": ["unknown", "sfp", "qsfp", "rj45", "lightrail"], "type": "string", "description": "Port type.", "example": "qsfp"}, "port_security_enabled": {"readOnly": true, "type": "boolean", "example": false, "description": "Indicates that port security is:\n* `true` - enabled\n* `false` - disabled"}, "l2vpn_information": {"items": {"$ref": "#/definitions/l2vpn_information_for_ports_lags"}, "type": "array", "description": "If the `l2vpn` query parameter is `true`, this list will contain any associated L2VPN UUIDs and their names."}, "switch_name": {"type": "string", "example": "host.hpe.com", "maxLength": 255}, "read_only": {"default": false, "readOnly": true, "type": "boolean", "description": "Indicates that this port is:\n* `true` - __NOT__ configurable\n* `false` - Configurable", "example": false}, "default_state": {"readOnly": true, "type": "boolean", "description": "Indicates that a port:\n* When in default state is configurable for changing the type property\n* When not in the default state it is NOT configurable for changing the type property", "example": false}, "fec": {"enum": ["not_applicable", "enabled", "disabled"], "type": "string", "description": "Forward Error Correction setting", "example": "disabled"}, "speed": {"$ref": "#/definitions/port_speed"}, "vlan_group_uuids": {"items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array", "description": "UUIDs of the VLAN groups associated with this port."}, "downlink_switch_uuid": {"oneOf": [{"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, {"type": "null"}], "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e", "readOnly": false, "description": "UUID of the downlink switch connected to this port."}, "silkscreen": {"readOnly": true, "description": "String printed on the physical switch for the port slot associated with this port; can be the same for more than one port depending on switch model and configuration", "example": "1"}, "type": {"enum": ["access", "fabric"], "type": "string", "example": "access"}, "description": {"type": "string", "example": ""}, "tags": {"$ref": "#/definitions/tags_on_object"}, "switch_uuid": {"description": "UUID of the switch on which this port resides.", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "admin_state": {"enum": ["disabled", "enabled"], "type": "string", "description": "Administratively controlled state", "example": "enabled"}, "qsfp_mode": {"enum": ["not_applicable", "qsfp_1x40_gbps", "qsfp_1x100_gbps", "qsfp_2x50_gbps", "qsfp_4x10_gbps", "qsfp_4x25_gbps"], "type": "string", "description": "QSFP mode of this port.", "example": "qsfp_1x40_gbps"}, "holddown": {"items": {"enum": ["not_applicable", "admin", "lacp", "loop_detected", "mlag", "peering_loss", "penalty_box", "port_security", "usat"], "type": "string"}, "readOnly": true, "type": "array", "description": "Reasons for port conditional holddown.", "example": ["not_applicable"]}, "vlans": {"readOnly": true, "example": "5, 10-20, 30, 40, 50-60", "type": "string", "description": "The effective VLANs assigned to this port, including VLAN groups and directly assigned VLANs, presented as a sorted set of ranges.", "format": "vlan-range"}, "uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "port_label": {"readOnly": true, "type": "string", "description": "Port Label (for display purposes). Syntax varies based on hardware configuration (usually QSFP mode).", "example": "1.1"}, "name": {"type": "string", "description": "The user-defined port name (if any)", "example": "Port for Host X NIC Y"}, "fec_mode": {"enum": ["CL74", "CL91"], "type": "string", "description": "Forward Error Correction mode", "example": "CL74"}, "is_uplink": {"type": "boolean", "description": "Denotes whether this port is an \"uplink\" port", "example": false}, "bridge_loop_detection": {"additionalProperties": false, "required": ["interval", "mode"], "type": "object", "description": "Bridge loop detection setting for this port.", "properties": {"interval": {"description": "Bridge loop detection interval in milliseconds.", "default": 1000, "maximum": 65000, "minimum": 1000, "type": "number", "example": 1000}, "mode": {"default": "disabled", "enum": ["disabled", "native_vlan", "all_configured_vlans"], "type": "string", "description": "The operational mode for bridge loop detection on this port.", "example": "disabled"}}}, "permitted_qsfp_modes": {"items": {"enum": ["not_applicable", "qsfp_1x40_gbps", "qsfp_1x100_gbps", "qsfp_2x50_gbps", "qsfp_4x10_gbps", "qsfp_4x25_gbps"], "type": "string", "description": "Permitted QSFP mode(s)"}, "readOnly": true, "type": "array", "example": ["qsfp_1x40_gbps", "qsfp_1x100_gbps", "qsfp_4x10_gbps"]}, "ungrouped_vlans": {"format": "vlan-range", "type": "string", "example": "5, 10-20, 30, 40, 50-60", "description": "VLANs directly assigned to this port, not assigned through a VLAN group; presented as a sorted set of ranges."}}, "title": "Object: Port (flat)"}, "port_mirror": {"required": ["source_ports", "destination_ports", "mode", "description", "name", "switch_uuid"], "type": "object", "properties": {"switch_uuid": {"readOnly": false, "description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "destination_port_objects": {"items": {"$ref": "#/definitions/port_flat"}, "readOnly": true, "type": "array", "description": "Destination port objects associated with this port mirrorGroup."}, "mode": {"enum": ["egress", "ingress", "both"], "type": "string", "description": "Can be \"ingress\", \"egress\", or \"both\". To set incoming, outgoing or all traffic to mirror to the destination ports."}, "source_ports": {"items": {"readOnly": false, "description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array"}, "source_port_objects": {"items": {"$ref": "#/definitions/port_flat"}, "readOnly": true, "type": "array", "description": "Source port objects associated with this port mirrorGroup."}, "name": {"type": "string", "example": "Mirror 1", "format": "non_empty_or_whitespace_string"}, "destination_ports": {"items": {"readOnly": false, "description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array"}, "uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "description": {"type": "string", "example": ""}}, "title": "Object: Port Mirroring"}, "port_mirror_update": {"required": ["source_ports", "destination_ports", "mode", "description", "name", "switch_uuid"], "type": "object", "properties": {"destination_port_objects": {"items": {"$ref": "#/definitions/port_flat"}, "readOnly": true, "type": "array", "description": "Destination port objects associated with this port mirrorGroup."}, "name": {"type": "string", "example": "Mirror 1", "format": "non_empty_or_whitespace_string"}, "source_ports": {"items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": false, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array"}, "description": {"type": "string", "example": ""}, "switch_uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": false, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "mode": {"enum": ["egress", "ingress", "both"], "type": "string", "description": "Can be \"ingress\", \"egress\", or \"both\". To set incoming, outgoing or all traffic to mirror to the destination ports."}, "source_port_objects": {"items": {"$ref": "#/definitions/port_flat"}, "readOnly": true, "type": "array", "description": "Source port objects associated with this port mirrorGroup."}, "destination_ports": {"items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": false, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array"}}, "title": "Object: Port Mirror (update)"}, "port_patch_document": {"additionalProperties": false, "required": ["op", "path", "value"], "type": "object", "properties": {"path": {"type": "string", "description": "A JSON pointer."}, "from": {"type": "string", "description": "A string containing a JSON Pointer value."}, "value": {"anyOf": [{"type": "string"}, {"type": "integer"}, {"type": "array"}, {"type": "boolean"}], "description": "The value to be used within the operations. The value is of type integer, string, or boolean.", "example": "value"}, "op": {"enum": ["replace"], "type": "string", "description": "The operation to be performed."}}}, "port_patch_request": {"additionalProperties": false, "required": ["uuids", "patch"], "type": "object", "properties": {"uuids": {"items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array", "example": ["03734100040c000009b8ddaf67cf1ed5", "03734100040c00003bf5b6a5eeac65b9"]}, "patch": {"items": {"$ref": "#/definitions/port_patch_document"}, "type": "array", "example": [{"path": "/admin_state", "value": "enabled", "op": "replace"}, {"path": "/speed/current", "value": 10000, "op": "replace"}, {"path": "/description", "value": "SwitchPort1", "op": "replace"}, {"path": "/name", "value": "Port1", "op": "replace"}, {"path": "/native_vlan", "value": 4, "op": "replace"}, {"path": "/type", "value": "fabric", "op": "replace"}, {"path": "/fec", "value": "enabled", "op": "replace"}, {"path": "/qsfp_mode", "value": "qsfp_1x100_gbps", "op": "replace"}, {"path": "/is_uplink", "value": true, "op": "replace"}, {"path": "/bridge_loop_detection/mode", "value": "disabled", "op": "replace"}, {"path": "/bridge_loop_detection/interval", "value": 1000, "op": "replace"}]}}}, "port_speed": {"additionalProperties": false, "required": ["current"], "type": "object", "properties": {"current": {"enum": [1000, 10000, 25000, 40000, 50000, 100000], "type": "number", "description": "Currently configured line speed (Mbps).", "example": 50000}, "permitted": {"items": {"enum": [1000, 10000, 25000, 40000, 50000, 100000], "type": "number", "description": "Permitted line speeds (Mbps).", "example": [1000, 10000, 25000, 40000, 50000, 100000]}, "readOnly": true, "type": "array"}}, "title": "Object: Switch port line speed"}, "port_statistic": {"additionalProperties": false, "required": ["timestamp", "last_modified", "port_uuid", "switch_uuid", "uuid", "in_octets", "in_unicast_packets", "in_nunicast_packets", "in_ipv4_packets", "in_discards", "in_errors", "out_octets", "out_unicast_packets", "out_nunicast_packets", "out_ipv4_packets", "out_discards", "out_errors"], "type": "object", "properties": {"in_ipv4_packets": {"readOnly": true, "type": "integer", "example": 12973, "format": "int64"}, "in_octets": {"readOnly": true, "type": "integer", "example": 104124, "format": "int64"}, "in_discards": {"readOnly": true, "type": "integer", "example": 10, "format": "int64"}, "port_uuid": {"readOnly": true, "description": "UUID of the port.", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "in_unicast_packets": {"readOnly": true, "type": "integer", "example": 894203, "format": "int64"}, "in_nunicast_packets": {"readOnly": true, "type": "integer", "example": 1243, "format": "int64"}, "timestamp": {"readOnly": true, "type": "integer", "example": 104124, "format": "int64"}, "out_ipv4_packets": {"readOnly": true, "type": "integer", "example": 32829, "format": "int64"}, "in_errors": {"readOnly": true, "type": "integer", "example": 23, "format": "int64"}, "switch_uuid": {"readOnly": true, "description": "UUID of the switch on which this port resides.", "format": "uuid_opt_hyphenated", "minLength": 32, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "last_modified": {"readOnly": true, "type": "string", "example": "2018-11-07 20:07:16+00:00"}, "out_unicast_packets": {"readOnly": true, "type": "integer", "example": 9372943, "format": "int64"}, "out_nunicast_packets": {"readOnly": true, "type": "integer", "example": 239, "format": "int64"}, "out_discards": {"readOnly": true, "type": "integer", "example": 0, "format": "int64"}, "out_errors": {"readOnly": true, "type": "integer", "example": 3, "format": "int64"}, "out_octets": {"readOnly": true, "type": "integer", "example": 1234567890, "format": "int64"}}, "title": "Object: Port Statistic"}, "port_update": {"additionalProperties": false, "required": ["admin_state", "bridge_loop_detection", "description", "fec", "is_uplink", "name", "native_vlan", "qsfp_mode", "speed", "type", "vlan_group_uuids"], "type": "object", "properties": {"native_vlan": {"minimum": 0, "type": "number", "description": "This VLAN is:\n* Applied to all untagged traffic coming in to this Port (ingress)\n* Removed from all traffic tagged with this VLAN which is leaving this Port (egress)\n* NOTE: a native_vlan value of 0 means that any untagged traffic will be dropped on either ingress or egress", "maximum": 4000, "example": 99}, "speed_group": {"items": {"min_length": "32", "max_length": "32", "type": "string", "description": "UUIDs of ports that wil be affected by changing the speed of this port (speed will be changed on all ports)."}, "readOnly": true, "type": "array", "example": ["42de42fa30877ada9b6c567d89587fea", "4e2f16c3979f494dbf0393d8a01e8fd5", "c27ea048bab64b4a9db9e25d2ba511f4", "92de42fa30874f8a5b6c567d8958ae86"]}, "link_state": {"readOnly": true, "enum": ["down", "up"], "type": "string", "description": "The link state of this port.", "example": "up"}, "form_factor": {"readOnly": true, "enum": ["unknown", "sfp", "qsfp", "rj45", "lightrail"], "type": "string", "description": "Port type.", "example": "qsfp"}, "port_security_enabled": {"readOnly": true, "type": "boolean", "example": false, "description": "Indicates that port security is:\n* `true` - enabled\n* `false` - disabled"}, "speed": {"$ref": "#/definitions/port_speed"}, "switch_name": {"type": "string", "example": "host.hpe.com", "maxLength": 255}, "read_only": {"default": false, "readOnly": true, "type": "boolean", "description": "Indicates that this port is:\n* `true` - __NOT__ configurable\n* `false` - Configurable", "example": false}, "default_state": {"readOnly": true, "type": "boolean", "description": "Indicates that a port:\n* When in default state is configurable for changing the type property\n* When not in the default state it is NOT configurable for changing the type property", "example": false}, "fec": {"enum": ["not_applicable", "enabled", "disabled"], "type": "string", "description": "Forward Error Correction setting", "example": "disabled"}, "vlan_group_uuids": {"items": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "type": "array", "description": "UUIDs of the VLAN groups associated with this port."}, "downlink_switch_uuid": {"oneOf": [{"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, {"type": "null"}], "readOnly": false, "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e", "description": "UUID of the downlink switch connected to this port."}, "silkscreen": {"readOnly": true, "description": "String printed on the physical switch for the port slot associated with this port; can be the same for more than one port depending on switch model and configuration", "example": "1"}, "type": {"enum": ["access", "fabric"], "type": "string", "example": "access"}, "description": {"type": "string", "example": ""}, "tags": {"$ref": "#/definitions/tags_on_object"}, "switch_uuid": {"description": "UUID of the switch on which this port resides.", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "admin_state": {"enum": ["disabled", "enabled"], "type": "string", "description": "Administratively controlled state", "example": "enabled"}, "qsfp_mode": {"enum": ["not_applicable", "qsfp_1x40_gbps", "qsfp_1x100_gbps", "qsfp_2x50_gbps", "qsfp_4x10_gbps", "qsfp_4x25_gbps"], "type": "string", "description": "QSFP mode of this port.", "example": "qsfp_1x40_gbps"}, "holddown": {"items": {"enum": ["not_applicable", "admin", "lacp", "loop_detected", "mlag", "peering_loss", "penalty_box", "port_security", "usat"], "type": "string"}, "readOnly": true, "type": "array", "description": "Reasons for port conditional holddown.", "example": ["not_applicable"]}, "vlans": {"readOnly": true, "format": "vlan-range", "type": "string", "example": "5, 10-20, 30, 40, 50-60", "description": "The effective VLANs assigned to this port, including VLAN groups and directly assigned VLANs, presented as a sorted set of ranges."}, "uuid": {"description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": true, "maxLength": 36, "type": "string", "example": "1c35f445-0e2c-4d0a-b8fd-dae75924567e"}, "port_label": {"readOnly": true, "type": "string", "description": "Port Label (for display purposes). Syntax varies based on hardware configuration (usually QSFP mode).", "example": "1.1"}, "name": {"type": "string", "description": "The user-defined port name (if any)", "example": "Port for Host X NIC Y"}, "fec_mode": {"enum": ["CL74", "CL91"], "type": "string", "description": "Forward Error Correction mode", "example": "CL74"}, "is_uplink": {"type": "boolean", "description": "Denotes whether this port is an \"uplink\" port", "example": false}, "ungrouped_vlans": {"description": "VLANs directly assigned to this port, not assigned through a VLAN group; presented as a sorted set of ranges.", "type": "string", "example": "5, 10-20, 30, 40, 50-60", "format": "vlan-range"}, "permitted_qsfp_modes": {"items": {"enum": ["not_applicable", "qsfp_1x40_gbps", "qsfp_1x100_gbps", "qsfp_2x50_gbps", "qsfp_4x10_gbps", "qsfp_4x25_gbps"], "type": "string", "description": "Permitted QSFP mode(s)"}, "readOnly": true, "type": "array", "example": ["qsfp_1x40_gbps", "qsfp_1x100_gbps", "qsfp_4x10_gbps"]}, "bridge_loop_detection": {"additionalProperties": false, "required": ["interval", "mode"], "type": "object", "description": "Bridge loop detection setting for this port.", "properties": {"interval": {"description": "Bridge loop detection interval in milliseconds.", "default": 1000, "maximum": 65000, "minimum": 1000, "type": "number", "example": 1000}, "mode": {"default": "disabled", "enum": ["disabled", "native_vlan", "all_configured_vlans"], "type": "string", "description": "The operational mode for bridge loop detection on this port.", "example": "disabled"}}}}, "title": "Object: Port (Update)"}, "qualifier": {"additionalProperties": false, "required": ["uuid", "name"], "type": "object", "properties": {"destination_mac_addresses": {"items": {"type": "object", "properties": {"mac_mask": {"example": "FF:FF:FF:00:00:00"}, "mac_address": {"format": "mac_address", "description": "MAC Address", "example": "00:50:56:aa:bb:dd"}}, "description": "Destination MAC address with mask"}, "type": "array"}, "tcp_flags": {"type": "string", "description": "TCP flags presented as a set of ranges (0-63)", "example": "1-10"}, "source_mac_addresses": {"items": {"type": "object", "properties": {"mac_mask": {"example": "FF:FF:FF:00:00:00", "format": "mac_address"}, "mac_address": {"format": "mac_address", "description": "MAC Address", "example": "00:50:56:aa:bb:dd"}}, "description": "Source MAC address with mask"}, "type": "array"}, "uuid": {"min_length": 32, "description": "UUID", "format": "uuid_opt_hyphenated", "minLength": 32, "readOnly": false, "max_length": 36, "maxLength": 36, "type": "string", "example": "783eff3f768f434399d7379ad93a8393"}, "vni": {"type": "string", "example": "1-10,20", "descriptions": "VNI values presented as a set of ranges (0-16777215)"}, "description": {"type": "string", "example": "qualifier description"}, "dscp": {"type": "string", "example": "1-10,20", "description": "DSCP values presented as a set of ranges (0-63)"}, "source_ip_addresses": {"items": {"required": ["address", "prefix_length"], "type": "object", "properties": {"prefix_length": {"minimum": 0, "type": "integer", "maximum": 32, "example": 24}, "address": {"type": "string", "example": "172.10.10.10", "format": "ipv4"}}}, "type": "array", "description": "Source IP addresses with prefix lengths"}, "destination_tcp_ports": {"type": "string", "example": "5, 10-20, 30, 40, 50-60", "description": "TCP ports presented as a set of ranges (0-65535)"}, "priority_levels": {"type": "string", "description": "801.2p priority bits presented as a set of ranges (0-7)", "example": "1-3"}, "source_udp_ports": {"type": "string", "example": "5, 10-20, 30, 40, 50-60", "description": "UDP ports presented as a set of ranges (0-65535)"}, "ip_protocol": {"type": "string", "example": "1-10,20", "description": "IP protocol values presented as a set of ranges (0-255)"}, "destination_ip_addresses": {"items": {"required": ["address", "prefix_length"], "type": "object", "properties": {"prefix_length": {"minimum": 0, "type": "integer", "maximum": 32, "example": 24}, "address": {"type": "string", "example": "172.10.10.10", "format": "ipv4"}}}, "type": "array", "description": "Destination IP addresses with prefix lengths"}, "source_tcp_ports": {"type": "string", "example": "5, 10-20, 30, 40, 50-60", "description": "TCP ports presented as a set of ranges (0-65535)"}, "vlans": {"type": "string", "example": "5, 10-20, 30, 40, 50-60", "description": "VLANs presented as a set of ranges (0-4000)"}, "destination_udp_ports": {"type": "string", "example": "5, 10-20, 30, 40, 50-60", "description": "UDP ports presented as a set of ranges (0-65535)"}, "name": {"type": "string", "example": "qualifier"}}, "title": "Object: Qualifier"}, "qualifier_create": {"additionalProperties": false, "required": ["name"], "type": "object", "properties": {"destination_mac_addresses": {"items": {"type": "object", "properties": {"mac_mask": {"example": "FF:FF:FF:00:00:00"}, "mac_address": {"example": "00:50:56:aa:bb:dd", "description": "MAC Address", "format": "mac_address"}}, "description": "Destination MAC address with mask"}, "type": "array"}, "tcp_flags": {"type": "string", "description": "TCP flags presented as a set of ranges (0-63)", "example": "1-10"}, "source_mac_addresses": {"items": {"type": "object", "properties": {"mac_mask": {"example": "FF:FF:FF:00:00:00", "format": "mac_address"}, "mac_address": {"example": "00:50:56:aa:bb:dd", "description": "MAC Address", "format": "mac_address"}}, "description": "Source MAC address with mask"}, "type": "array"}, "destination_ip_addresses": {"items": {"required": ["address", "prefix_length"], "type": "object", "properties": {"prefix_length": {"minimum": 0, "type": "integer", "maximum": 32, "example": 24}, "address": {"type": "string", "example": "172.10.10.10", "format": "ipv4"}}}, "type": "array", "description": "Destination IP addresses with prefix lengths"}, "name": {"type": "string", "example": "qualifier"}, "vni": {"type": "string", "example": "1-10,20", "descriptions": "VNI values presented as a set of ranges (0-16777215)"}, "source_ip_addresses": {"items": {"required": ["address", "prefix_length"], "type": "object", "properties": {"prefix_length": {"minimum": 0, "type": "integer", "maximum": 32, "example": 24}, "address": {"type": "string", "example": "172.10.10.10", "format": "ipv4"}}}, "type": "array", "description": "Source IP addresses with prefix lengths"}, "destination_tcp_ports": {"type": "string", "example": "5, 10-20, 30, 40, 50-60", "description": "TCP ports presented as a set of ranges (0-65535)"}, "priority_levels": {"type": "string", "description": "801.2p priority bits presented as a set of ranges (0-7)", "example": "1-3"}, "source_udp_ports": {"type": "string", "example": "5, 10-20, 30, 40, 50-60", "description": "UDP ports presented as a set of ranges (0-65535)"}, "ip_protocol": {"type": "string", "example": "1-10,20", "description": "IP protocol values presented as a set of ranges (0-255)"}, "dscp": {"type": "string", "example": "1-10,20", "description": "DSCP values presented as a set of ranges (0-63)"}, "source_tcp_ports": {"type": "string", "example": "5, 10-20, 30, 40, 50-60", "description": "TCP ports presented as a set of ranges (0-65535)"}, "vlans": {"type": "string", "example": "5, 10-20, 30, 40, 50-60", "description": "VLANs presented as a set of ranges (0-4000)"}, "destination_udp_ports": {"type": "string", "example": "5, 10-20, 30, 40, 50-60", "description": "UDP ports presented as a set of ranges (0-65535)"}, "description": {"type": "string", "example": "qualifier description"}}, "title": "Object: Qualifier (create)"}, "qualifier_update": {"additionalProperties": false, "required": ["name"], "type": "object", "properties": {"destination_mac_addresses": {"items": {"type": "object", "properties": {"mac_mask": {"example": "FF:FF:FF:00:00:00"}, "mac_address": {"example": "00:50:56:aa:bb:dd", "description": "MAC Address", "format": "mac_address"}}, "description": "Destination MAC address with mask"}, "type": "array"}, "tcp_flags": {"type": "string", "description": "TCP flags presented as a set of ranges (0-63)", "example": "1-10"}, "source_mac_addresses": {"items": {"type": "object", "properties": {"mac_mask": {"example": "FF:FF:FF:00:00:00", "format": "mac_address"}, "mac_address": {"example": "00:50:56:aa:bb:dd", "description": "MAC Address", "format": "mac_address"}}, "description": "Source MAC address with mask"}, "type": "array"}, "destination_ip_addresses": {"items": {"required": ["address", "prefix_length"], "type": "object", "properties": {"prefix_length": {"minimum": 0, "type": "integer", "maximum": 32, "example": 24}, "address": {"type": "string", "example": "172.10.10.10", "format": "ipv4"}}}, "type": "array", "description": "Destination IP addresses with prefix lengths"}, "name": {"type": "string", "example": "qualifier"}, "vni": {"type": "string", "example": "1-10,20", "descriptions": "VNI values presented as a set of ranges (0-16777215)"}, "source_ip_addresses": {"items": {"required": ["address", "prefix_length"], "type": "object", "properties": {"prefix_length": {"minimum": 0, "type": "integer", "maximum": 32, "example": 24}, "address": {"type": "string", "example": "172.10.10.10", "format": "ipv4"}}}, "type": "array", "description": "Source IP addresses with prefix lengths"}, "destination_tcp_ports": {"type": "string", "example": "5, 10-20, 30, 40, 50-60", "description": "TCP ports presented as a set of ranges (0-65535)"}, "priority_levels": {"type": "string", "description": "801.2p priority bits presented as a set of ranges (0-7)", "example": "1-3"}, "source_udp_ports": {"type": "string", "example": "5, 10-20, 30, 40, 50-60", "description": "UDP ports presented as a set of ranges (0-65535)"}, "ip_protocol": {"type": "string", "example": "1-10,20", "description": "IP protocol values presented as a set of ranges (0-255)"}, "dscp": {"type": "string", "example": "1-10,20", "description": "DSCP values presented as a set of ranges (0-63)"}, "source_tcp_ports": {"type": "string", "example": "5, 10-20, 30, 40, 50-60", "description": "TCP ports presented as a set of ranges (0-65535)"}, "vlans": {"type": "string", "example": "5, 10-20, 30, 40, 50-60", "description": "VLANs presented as a set of ranges (0-4000)"}, "destination_udp_ports": {"type": "string", "example": "5, 10-20, 30, 40, 50-60", "description": "UDP ports presented as a set of ranges (0-65535)"}, "description": {"type": "string", "example": "qualifier description"}}, "title": "Object: Qualifier |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment